/[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 1006 by schoenebeck, Fri Dec 29 20:27:15 2006 UTC revision 1162 by iliev, Mon Apr 16 16:02:19 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: July 2, 2007                                  December 29, 2006  Expires: October 18, 2007                                 April 16, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 33  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 July 2, 2007.     This Internet-Draft will expire on October 18, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2007).
41    
42    
43    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck               Expires July 2, 2007                  [Page 1]  Schoenebeck             Expires October 18, 2007                [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
58    
59    
60  Abstract  Abstract
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72     2.  Versioning of this specification  . . . . . . . . . . . . . .   6     2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76       5.1.  Request/response communication method . . . . . . . . . .   9       5.1.  Request/response communication method . . . . . . . . . .  10
77         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78       5.2.  Subscribe/notify communication method . . . . . . . . . .  12       5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79     6.  Description for control commands  . . . . . . . . . . . . . .  14     6.  Description for control commands  . . . . . . . . . . . . . .  15
80       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82         6.2.1.  Getting amount of available audio output drivers  . .  15         6.2.1.  Getting amount of available audio output drivers  . .  16
83         6.2.2.  Getting all available audio output drivers  . . . . .  15         6.2.2.  Getting all available audio output drivers  . . . . .  16
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  . . . . . . . . . . . . . . . . . . . . . . .  16
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter  . . . . . . . . . . . . . . . . . .  16                 driver parameter  . . . . . . . . . . . . . . . . . .  17
88         6.2.5.  Creating an audio output device . . . . . . . . . . .  20         6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89         6.2.6.  Destroying an audio output device . . . . . . . . . .  21         6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90         6.2.7.  Getting all created audio output device count . . . .  22         6.2.7.  Getting all created audio output device count . . . .  23
91         6.2.8.  Getting all created audio output device list  . . . .  22         6.2.8.  Getting all created audio output device list  . . . .  23
92         6.2.9.  Getting current settings of an audio output device  .  22         6.2.9.  Getting current settings of an audio output device  .  23
93         6.2.10. Changing settings of audio output devices . . . . . .  24         6.2.10. Changing settings of audio output devices . . . . . .  25
94         6.2.11. Getting information about an audio channel  . . . . .  25         6.2.11. Getting information about an audio channel  . . . . .  26
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter . . . . . . . . . . . . . . . . . . . . . .  26                 parameter . . . . . . . . . . . . . . . . . . . . . .  27
97         6.2.13. Changing settings of audio output channels  . . . . .  28         6.2.13. Changing settings of audio output channels  . . . . .  29
98       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99         6.3.1.  Getting amount of available MIDI input drivers  . . .  30         6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver  . . . . . . . . . . . . . . . . . . . . . . .  31                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter  . . . . . . . . . . . . . . . . . .  32                 driver parameter  . . . . . . . . . . . . . . . . . .  33
105         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107         6.3.7.  Getting all created MIDI input device count . . . . .  36         6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111  Schoenebeck               Expires July 2, 2007                  [Page 2]  Schoenebeck             Expires October 18, 2007                [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  36         6.3.8.  Getting all created MIDI input device list  . . . . .  37
117         6.3.9.  Getting current settings of a MIDI input device . . .  37         6.3.9.  Getting current settings of a MIDI input device . . .  38
118         6.3.10. Changing settings of MIDI input devices . . . . . . .  38         6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119         6.3.11. Getting information about a MIDI port . . . . . . . .  38         6.3.11. Getting information about a MIDI port . . . . . . . .  39
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
121                 parameter . . . . . . . . . . . . . . . . . . . . . .  39                 parameter . . . . . . . . . . . . . . . . . . . . . .  40
122         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  44         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  44         6.4.4.  Getting all created sampler channel list  . . . . . .  45
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  45
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46
130         6.4.7.  Getting amount of available engines . . . . . . . . .  46         6.4.7.  Getting amount of available engines . . . . . . . . .  47
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  46         6.4.8.  Getting all available engines . . . . . . . . . . . .  47
132         6.4.9.  Getting information about an engine . . . . . . . . .  47         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  48         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  51         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  51         6.4.12. Current number of active disk streams . . . . . . . .  52
136         6.4.13. Current fill state of disk stream buffers . . . . . .  52         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  53         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53         6.4.15. Setting audio output type . . . . . . . . . . . . . .  54
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  60                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  61         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  62         6.4.26. Removing an effect send from a sampler channel  . . .  63
151         6.4.27. Getting amount of effect sends on a sampler channel .  63         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  63         6.4.28. Listing all effect sends on a sampler channel . . . .  64
153         6.4.29. Getting effect send information . . . . . . . . . . .  64         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Altering effect send's audio routing  . . . . . . . .  65         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155         6.4.31. Resetting a sampler channel . . . . . . . . . . . . .  66         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  66         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.5.1.  Register front-end for receiving event messages . . .  66         6.4.33. Altering effect send's send level . . . . . . . . . .  68
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69
159         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160           6.5.1.  Register front-end for receiving event messages . . .  70
161         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
162                 messages  . . . . . . . . . . . . . . . . . . . . . .  67                 messages  . . . . . . . . . . . . . . . . . . . . . .  71
163         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  68         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  68  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  69  
        6.6.1.  Current number of active voices . . . . . . . . . . .  69  
164    
165    
166    
167  Schoenebeck               Expires July 2, 2007                  [Page 3]  Schoenebeck             Expires October 18, 2007                [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
170    
171    
172         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  69         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  69       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72
174         6.6.4.  General sampler informations  . . . . . . . . . . . .  70         6.6.1.  Current number of active voices . . . . . . . . . . .  72
175         6.6.5.  Getting global volume attenuation . . . . . . . . . .  70         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176         6.6.6.  Setting global volume attenuation . . . . . . . . . .  71         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  71         6.6.4.  General sampler informations  . . . . . . . . . . . .  73
178         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  72         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179         6.7.2.  Delete one particular or all MIDI instrument maps . .  73         6.6.6.  Setting global volume attenuation . . . . . . . . . .  74
180         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  73       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  74         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182         6.7.5.  Getting MIDI instrument map information . . . . . . .  74         6.7.2.  Delete one particular or all MIDI instrument maps . .  76
183         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  75         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184         6.7.7.  Create or replace a MIDI instrument map entry . . . .  75         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77
185         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  78         6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187           6.7.7.  Create or replace a MIDI instrument map entry . . . .  79
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
190                 instrument map  . . . . . . . . . . . . . . . . . . .  79                 instrument map  . . . . . . . . . . . . . . . . . . .  83
191         6.7.10. Remove an entry from the MIDI instrument map  . . . .  79         6.7.10. Remove an entry from the MIDI instrument map  . . . .  83
192         6.7.11. Get current settings of MIDI instrument map entry . .  80         6.7.11. Get current settings of MIDI instrument map entry . .  84
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  82         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  83       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86
195     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  94         6.8.1.  Creating a new instrument directory . . . . . . . . .  86
196       8.1.  Number of audio output devices changed  . . . . . . . . .  94         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87
197       8.2.  Audio output device's settings changed  . . . . . . . . .  94         6.8.3.  Getting amount of instrument directories  . . . . . .  88
198       8.3.  Number of MIDI input devices changed  . . . . . . . . . .  94         6.8.4.  Listing all directories in specific directory . . . .  88
199       8.4.  MIDI input device's settings changed  . . . . . . . . . .  95         6.8.5.  Getting instrument directory information  . . . . . .  89
200       8.5.  Number of sampler channels changed  . . . . . . . . . . .  95         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201       8.6.  Number of active voices changed . . . . . . . . . . . . .  95         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90
202       8.7.  Number of active disk streams changed . . . . . . . . . .  96         6.8.8.  Changing the description of directory . . . . . . . .  91
203       8.8.  Disk stream buffer fill state changed . . . . . . . . . .  96         6.8.9.  Adding instruments to the instruments database  . . .  92
204       8.9.  Channel information changed . . . . . . . . . . . . . . .  96         6.8.10. Removing an instrument  . . . . . . . . . . . . . . .  93
205       8.10. Total number of active voices changed . . . . . . . . . .  97         6.8.11. Getting amount of instruments . . . . . . . . . . . .  93
206       8.11. Number of MIDI instrument maps changed  . . . . . . . . .  97         6.8.12. Listing all instruments in specific directory . . . .  94
207       8.12. MIDI instrument map information changed . . . . . . . . .  97         6.8.13. Getting instrument information  . . . . . . . . . . .  94
208       8.13. Number of MIDI instruments changed  . . . . . . . . . . .  98         6.8.14. Renaming an instrument  . . . . . . . . . . . . . . .  97
209       8.14. MIDI instrument information changed . . . . . . . . . . .  98         6.8.15. Moving an instrument  . . . . . . . . . . . . . . . .  97
210       8.15. Miscellaneous and debugging events  . . . . . . . . . . .  99         6.8.16. Changing the description of instrument  . . . . . . .  98
211     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 100     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  99
212     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 101     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
213     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 102       8.1.  Number of audio output devices changed  . . . . . . . . . 112
214     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 103       8.2.  Audio output device's settings changed  . . . . . . . . . 112
215     Intellectual Property and Copyright Statements  . . . . . . . . . 104       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 112
216         8.4.  MIDI input device's settings changed  . . . . . . . . . . 113
217         8.5.  Number of sampler channels changed  . . . . . . . . . . . 113
218         8.6.  Number of active voices changed . . . . . . . . . . . . . 113
219         8.7.  Number of active disk streams changed . . . . . . . . . . 114
220    
221    
222    
223    Schoenebeck             Expires October 18, 2007                [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol           April 2007
226    
227    
228         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 114
229         8.9.  Channel information changed . . . . . . . . . . . . . . . 114
230         8.10. Number of effect sends changed  . . . . . . . . . . . . . 115
231         8.11. Effect send information changed . . . . . . . . . . . . . 115
232         8.12. Total number of active voices changed . . . . . . . . . . 115
233         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 116
234         8.14. MIDI instrument map information changed . . . . . . . . . 116
235         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 116
236         8.16. MIDI instrument information changed . . . . . . . . . . . 117
237         8.17. Global settings changed . . . . . . . . . . . . . . . . . 117
238         8.18. Number of database instrument directories changed . . . . 118
239         8.19. Database instrument directory information changed . . . . 118
240         8.20. Number of database instruments changed  . . . . . . . . . 119
241         8.21. Database instrument information changed . . . . . . . . . 119
242         8.22. Miscellaneous and debugging events  . . . . . . . . . . . 120
243       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 121
244       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 122
245       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 123
246       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 124
247       Intellectual Property and Copyright Statements  . . . . . . . . . 125
248    
249    
250    
251    
252    
253    
254    
255    
256    
257    
258    
259    
260    
261    
262    
263    
264    
265    
266    
267    
268    
269    
270    
271    
# Line 220  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires July 2, 2007                  [Page 4]  Schoenebeck             Expires October 18, 2007                [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires July 2, 2007                  [Page 5]  Schoenebeck             Expires October 18, 2007                [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires July 2, 2007                  [Page 6]  Schoenebeck             Expires October 18, 2007                [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires July 2, 2007                  [Page 7]  Schoenebeck             Expires October 18, 2007                [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires July 2, 2007                  [Page 8]  Schoenebeck             Expires October 18, 2007                [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires July 2, 2007                  [Page 9]  Schoenebeck             Expires October 18, 2007               [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires July 2, 2007                 [Page 10]  Schoenebeck             Expires October 18, 2007               [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires July 2, 2007                 [Page 11]  Schoenebeck             Expires October 18, 2007               [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires July 2, 2007                 [Page 12]  Schoenebeck             Expires October 18, 2007               [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires July 2, 2007                 [Page 13]  Schoenebeck             Expires October 18, 2007               [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires July 2, 2007                 [Page 14]  Schoenebeck             Expires October 18, 2007               [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires July 2, 2007                 [Page 15]  Schoenebeck             Expires October 18, 2007               [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
898    
899    
900        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 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires July 2, 2007                 [Page 16]  Schoenebeck             Expires October 18, 2007               [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
954    
955    
956     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 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires July 2, 2007                 [Page 17]  Schoenebeck             Expires October 18, 2007               [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires July 2, 2007                 [Page 18]  Schoenebeck             Expires October 18, 2007               [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires July 2, 2007                 [Page 19]  Schoenebeck             Expires October 18, 2007               [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires July 2, 2007                 [Page 20]  Schoenebeck             Expires October 18, 2007               [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires July 2, 2007                 [Page 21]  Schoenebeck             Expires October 18, 2007               [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires July 2, 2007                 [Page 22]  Schoenebeck             Expires October 18, 2007               [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires July 2, 2007                 [Page 23]  Schoenebeck             Expires October 18, 2007               [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires July 2, 2007                 [Page 24]  Schoenebeck             Expires October 18, 2007               [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires July 2, 2007                 [Page 25]  Schoenebeck             Expires October 18, 2007               [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires July 2, 2007                 [Page 26]  Schoenebeck             Expires October 18, 2007               [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires July 2, 2007                 [Page 27]  Schoenebeck             Expires October 18, 2007               [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires July 2, 2007                 [Page 28]  Schoenebeck             Expires October 18, 2007               [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires July 2, 2007                 [Page 29]  Schoenebeck             Expires October 18, 2007               [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires July 2, 2007                 [Page 30]  Schoenebeck             Expires October 18, 2007               [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires July 2, 2007                 [Page 31]  Schoenebeck             Expires October 18, 2007               [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires July 2, 2007                 [Page 32]  Schoenebeck             Expires October 18, 2007               [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires July 2, 2007                 [Page 33]  Schoenebeck             Expires October 18, 2007               [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires July 2, 2007                 [Page 34]  Schoenebeck             Expires October 18, 2007               [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires July 2, 2007                 [Page 35]  Schoenebeck             Expires October 18, 2007               [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires July 2, 2007                 [Page 36]  Schoenebeck             Expires October 18, 2007               [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires July 2, 2007                 [Page 37]  Schoenebeck             Expires October 18, 2007               [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires July 2, 2007                 [Page 38]  Schoenebeck             Expires October 18, 2007               [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires July 2, 2007                 [Page 39]  Schoenebeck             Expires October 18, 2007               [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires July 2, 2007                 [Page 40]  Schoenebeck             Expires October 18, 2007               [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck               Expires July 2, 2007                 [Page 41]  Schoenebeck             Expires October 18, 2007               [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2354    
2355    
2356           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck               Expires July 2, 2007                 [Page 42]  Schoenebeck             Expires October 18, 2007               [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2410    
2411    
2412           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck               Expires July 2, 2007                 [Page 43]  Schoenebeck             Expires October 18, 2007               [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2466    
2467    
2468     Example:     Example:
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck               Expires July 2, 2007                 [Page 44]  Schoenebeck             Expires October 18, 2007               [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2522    
2523    
2524        ADD CHANNEL        ADD CHANNEL
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires July 2, 2007                 [Page 45]  Schoenebeck             Expires October 18, 2007               [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2578    
2579    
2580        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires July 2, 2007                 [Page 46]  Schoenebeck             Expires October 18, 2007               [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2634    
2635    
2636        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 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires July 2, 2007                 [Page 47]  Schoenebeck             Expires October 18, 2007               [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2690    
2691    
2692           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires July 2, 2007                 [Page 48]  Schoenebeck             Expires October 18, 2007               [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2746    
2747    
2748              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 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck               Expires July 2, 2007                 [Page 49]  Schoenebeck             Expires October 18, 2007               [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2802    
2803    
2804           MUTE -           MUTE -
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck               Expires July 2, 2007                 [Page 50]  Schoenebeck             Expires October 18, 2007               [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2858    
2859    
2860           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck               Expires July 2, 2007                 [Page 51]  Schoenebeck             Expires October 18, 2007               [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2914    
2915    
2916        return "NA" for not available.        return "NA" for not available.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck               Expires July 2, 2007                 [Page 52]  Schoenebeck             Expires October 18, 2007               [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2970    
2971    
2972        S: ""        S: ""
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck               Expires July 2, 2007                 [Page 53]  Schoenebeck             Expires October 18, 2007               [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3026    
3027    
3028     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck               Expires July 2, 2007                 [Page 54]  Schoenebeck             Expires October 18, 2007               [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3082    
3083    
3084           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck               Expires July 2, 2007                 [Page 55]  Schoenebeck             Expires October 18, 2007               [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3138    
3139    
3140  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck               Expires July 2, 2007                 [Page 56]  Schoenebeck             Expires October 18, 2007               [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3194    
3195    
3196           on success           on success
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck               Expires July 2, 2007                 [Page 57]  Schoenebeck             Expires October 18, 2007               [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3250    
3251    
3252    
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck               Expires July 2, 2007                 [Page 58]  Schoenebeck             Expires October 18, 2007               [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3306    
3307    
3308        "OK" -        "OK" -
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck               Expires July 2, 2007                 [Page 59]  Schoenebeck             Expires October 18, 2007               [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3362    
3363    
3364     Examples:     Examples:
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck               Expires July 2, 2007                 [Page 60]  Schoenebeck             Expires October 18, 2007               [Page 61]
3416    
3417  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3418    
3419    
3420     Examples:     Examples:
# Line 3387  Internet-Draft        LinuxSampler Contr Line 3443  Internet-Draft        LinuxSampler Contr
3443     having dedicated effect send output channels and when "CREATE     having dedicated effect send output channels and when "CREATE
3444     FX_SEND" is called, those channels will automatically be picked.  You     FX_SEND" is called, those channels will automatically be picked.  You
3445     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3446     AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3447    
3448     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3449     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3468  Internet-Draft        LinuxSampler Contr
3468    
3469    
3470    
3471  Schoenebeck               Expires July 2, 2007                 [Page 61]  Schoenebeck             Expires October 18, 2007               [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3474    
3475    
3476        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3524  Internet-Draft        LinuxSampler Contr
3524    
3525    
3526    
3527  Schoenebeck               Expires July 2, 2007                 [Page 62]  Schoenebeck             Expires October 18, 2007               [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3530    
3531    
3532  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3580  Internet-Draft        LinuxSampler Contr
3580    
3581    
3582    
3583  Schoenebeck               Expires July 2, 2007                 [Page 63]  Schoenebeck             Expires October 18, 2007               [Page 64]
3584    
3585  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3586    
3587    
3588  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
# Line 3556  Internet-Draft        LinuxSampler Contr Line 3612  Internet-Draft        LinuxSampler Contr
3612    
3613              name of the effect send entity              name of the effect send entity
3614    
3615             MIDI_CONTROLLER -
3616    
3617                a value between 0 and 127 reflecting the MIDI controller
3618                which is able to modify the effect send's send level
3619    
3620             LEVEL -
3621    
3622                optionally dotted number reflecting the effect send's
3623                current send level (where a value < 1.0 means attenuation
3624                and a value > 1.0 means amplification)
3625    
3626           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3627    
3628              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
# Line 3564  Internet-Draft        LinuxSampler Contr Line 3631  Internet-Draft        LinuxSampler Contr
3631              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3632              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3633              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3634              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires October 18, 2007               [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol           April 2007
3642    
3643    
3644     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3645    
# Line 3574  Internet-Draft        LinuxSampler Contr Line 3649  Internet-Draft        LinuxSampler Contr
3649    
3650        S: "NAME: Reverb Send"        S: "NAME: Reverb Send"
3651    
3652             "MIDI_CONTROLLER: 91"
3653    
3654             "LEVEL: 0.3"
3655    
3656           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3657    
3658             "."
3659    
3660    6.4.30.  Changing effect send's name
3661    
3662       The front-end can alter the current name of an effect send entity by
3663       sending the following command:
3664    
3665          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3666    
3667  Schoenebeck               Expires July 2, 2007                 [Page 64]     Where <sampler-chan> is the sampler channel number as returned by the
3668       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3669  Internet-Draft        LinuxSampler Control Protocol        December 2006     command, <fx-send-id> reflects the numerical ID of the effect send
3670       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3671       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3672       effect send entity, which does not have to be unique.
3673    
3674       Possible Answers:
3675    
3676           "."        "OK" -
3677    
3678             on success
3679    
3680          "ERR:<error-code>:<error-message>" -
3681    
3682             in case it failed, providing an appropriate error code and
3683             error message
3684    
3685       Example:
3686    
3687          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3688    
3689          S: "OK"
3690    
3691  6.4.30.  Altering effect send's audio routing  
3692    
3693    
3694    
3695    Schoenebeck             Expires October 18, 2007               [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol           April 2007
3698    
3699    
3700    6.4.31.  Altering effect send's audio routing
3701    
3702     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
3703     channel on a specific sampler channel by sending the following     channel on a specific sampler channel by sending the following
# Line 3634  Internet-Draft        LinuxSampler Contr Line 3744  Internet-Draft        LinuxSampler Contr
3744           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3745           error message           error message
3746    
3747       Example:
3748    
3749    
3750  Schoenebeck               Expires July 2, 2007                 [Page 65]  
3751    Schoenebeck             Expires October 18, 2007               [Page 67]
3752    
3753  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3754    
3755    
3756          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3757    
3758          S: "OK"
3759    
3760    6.4.32.  Altering effect send's MIDI controller
3761    
3762       The front-end can alter the MIDI controller of an effect send entity
3763       by sending the following command:
3764    
3765          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3766          ctrl>
3767    
3768       Where <sampler-chan> is the sampler channel number as returned by the
3769       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3770       command, <fx-send-id> reflects the numerical ID of the effect send
3771       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3772       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3773       controller which shall be able to modify the effect send's send
3774       level.
3775    
3776       Possible Answers:
3777    
3778          "OK" -
3779    
3780             on success
3781    
3782          "WRN:<warning-code>:<warning-message>" -
3783    
3784             if MIDI controller was set, but there are noteworthy issue(s)
3785             related, providing an appropriate warning code and warning
3786             message
3787    
3788          "ERR:<error-code>:<error-message>" -
3789    
3790             in case it failed, providing an appropriate error code and
3791             error message
3792    
3793     Example:     Example:
3794    
3795        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3796    
3797          S: "OK"
3798    
3799    6.4.33.  Altering effect send's send level
3800    
3801       The front-end can alter the current send level of an effect send
3802       entity by sending the following command:
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires October 18, 2007               [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol           April 2007
3810    
3811    
3812          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3813    
3814       Where <sampler-chan> is the sampler channel number as returned by the
3815       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3816       command, <fx-send-id> reflects the numerical ID of the effect send
3817       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3818       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3819       dotted positive number (a value smaller than 1.0 means attenuation,
3820       whereas a value greater than 1.0 means amplification) reflecting the
3821       new send level.
3822    
3823       Possible Answers:
3824    
3825          "OK" -
3826    
3827             on success
3828    
3829          "WRN:<warning-code>:<warning-message>" -
3830    
3831             if new send level was set, but there are noteworthy issue(s)
3832             related, providing an appropriate warning code and warning
3833             message
3834    
3835          "ERR:<error-code>:<error-message>" -
3836    
3837             in case it failed, providing an appropriate error code and
3838             error message
3839    
3840       Example:
3841    
3842          C: "SET FX_SEND LEVEL 0 0 0.15"
3843    
3844        S: "OK"        S: "OK"
3845    
3846  6.4.31.  Resetting a sampler channel  6.4.34.  Resetting a sampler channel
3847    
3848     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3849     following command:     following command:
# Line 3661  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires October 18, 2007               [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol           April 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3690  Internet-Draft        LinuxSampler Contr Line 3894  Internet-Draft        LinuxSampler Contr
3894     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3895     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3896    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3897        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3898    
3899     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3714  Internet-Draft        LinuxSampler Contr Line 3911  Internet-Draft        LinuxSampler Contr
3911           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3912           message           message
3913    
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck             Expires October 18, 2007               [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol           April 2007
3922    
3923    
3924        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3925    
3926           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3745  Internet-Draft        LinuxSampler Contr Line 3952  Internet-Draft        LinuxSampler Contr
3952           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3953           message           message
3954    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3955        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3956    
3957           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3770  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969        SET ECHO <value>        SET ECHO <value>
3970    
3971     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
3972    
3973    
3974    
3975    Schoenebeck             Expires October 18, 2007               [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol           April 2007
3978    
3979    
3980     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3981     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3982     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 3800  Internet-Draft        LinuxSampler Contr Line 4007  Internet-Draft        LinuxSampler Contr
4007     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4008     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4009    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4010  6.6.  Global commands  6.6.  Global commands
4011    
4012     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 3825  Internet-Draft        LinuxSampler Contr Line 4023  Internet-Draft        LinuxSampler Contr
4023        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4024        voices on the sampler.        voices on the sampler.
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck             Expires October 18, 2007               [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol           April 2007
4034    
4035    
4036  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4037    
4038     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 3854  Internet-Draft        LinuxSampler Contr Line 4062  Internet-Draft        LinuxSampler Contr
4062    
4063    
4064    
   
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4065  6.6.4.  General sampler informations  6.6.4.  General sampler informations
4066    
4067     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3884  Internet-Draft        LinuxSampler Contr Line 4081  Internet-Draft        LinuxSampler Contr
4081    
4082           DESCRIPTION -           DESCRIPTION -
4083    
4084    
4085    
4086    
4087    Schoenebeck             Expires October 18, 2007               [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol           April 2007
4090    
4091    
4092              arbitrary textual description about the sampler              arbitrary textual description about the sampler
4093    
4094           VERSION -           VERSION -
# Line 3895  Internet-Draft        LinuxSampler Contr Line 4100  Internet-Draft        LinuxSampler Contr
4100              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4101              (see Section 2 for details)              (see Section 2 for details)
4102    
4103             INSTRUMENTS_DB_SUPPORT -
4104    
4105                either yes or no, specifies whether the sampler is build
4106                with instruments database support.
4107    
4108     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4109     Other fields might be added in future.     Other fields might be added in future.
4110    
# Line 3913  Internet-Draft        LinuxSampler Contr Line 4123  Internet-Draft        LinuxSampler Contr
4123    
4124     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4125     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4126     this parameter.     this parameter.
4127    
4128  6.6.6.  Setting global volume attenuation  6.6.6.  Setting global volume attenuation
# Line 3935  Internet-Draft        LinuxSampler Contr Line 4137  Internet-Draft        LinuxSampler Contr
4137     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4138     attenuating the overall volume.     attenuating the overall volume.
4139    
4140    
4141    
4142    
4143    Schoenebeck             Expires October 18, 2007               [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol           April 2007
4146    
4147    
4148     Possible Answers:     Possible Answers:
4149    
4150        "OK" -        "OK" -
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4179  Internet-Draft        LinuxSampler Contr
4179     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
4180     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4181     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4182     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4183     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4184     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
# Line 3990  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4193     current MIDI instrument map.     current MIDI instrument map.
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck             Expires October 18, 2007               [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol           April 2007
4202    
4203    
4204  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4205    
4206     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 4024  Internet-Draft        LinuxSampler Contr Line 4235  Internet-Draft        LinuxSampler Contr
4235    
4236        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4237    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4238        S: "OK[5]"        S: "OK[5]"
4239    
4240  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
# Line 4048  Internet-Draft        LinuxSampler Contr Line 4250  Internet-Draft        LinuxSampler Contr
4250     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4251     following command:     following command:
4252    
4253    
4254    
4255    Schoenebeck             Expires October 18, 2007               [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol           April 2007
4258    
4259    
4260        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4261    
4262     Possible Answers:     Possible Answers:
# Line 4079  Internet-Draft        LinuxSampler Contr Line 4288  Internet-Draft        LinuxSampler Contr
4288    
4289     Possible Answers:     Possible Answers:
4290    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4291        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4292        instrument maps.        instrument maps.
4293    
# Line 4104  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4304     following command:     following command:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck             Expires October 18, 2007               [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol           April 2007
4314    
4315    
4316        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4317    
4318     Possible Answers:     Possible Answers:
# Line 4138  Internet-Draft        LinuxSampler Contr Line 4347  Internet-Draft        LinuxSampler Contr
4347    
4348    
4349    
4350             NAME -
4351    
4352                custom name of the given map, which does not have to be
4353                unique
4354    
4355  Schoenebeck               Expires July 2, 2007                 [Page 74]           DEFAULT -
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4356    
4357                either true or false, defines whether this map is the
4358                default map
4359    
4360       The mentioned fields above don't have to be in particular order.
4361    
4362       Example:
4363    
          NAME -  
4364    
             custom name of the given map, which does not have to be  
             unique  
4365    
    The mentioned fields above don't have to be in particular order.  
4366    
4367     Example:  Schoenebeck             Expires October 18, 2007               [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol           April 2007
4370    
4371    
4372        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4373    
4374        S: "NAME: Standard Map"        S: "NAME: Standard Map"
4375    
4376             "DEFAULT: true"
4377    
4378           "."           "."
4379    
4380  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
# Line 4193  Internet-Draft        LinuxSampler Contr Line 4408  Internet-Draft        LinuxSampler Contr
4408     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
4409     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
4410    
4411          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4412          <engine_name> <filename> <instrument_index> <volume_value>
4413          [<instr_load_mode>] [<name>]
 Schoenebeck               Expires July 2, 2007                 [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>  
       <filename> <instrument_index> <volume_value> [<instr_load_mode>]  
       [<name>]  
4414    
4415     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4416     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
4417     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4418     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4419     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4420    
4421    
4422    
4423    Schoenebeck             Expires October 18, 2007               [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol           April 2007
4426    
4427    
4428     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4429     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
4430     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 4241  Internet-Draft        LinuxSampler Contr Line 4456  Internet-Draft        LinuxSampler Contr
4456    
4457        "PERSISTENT" -        "PERSISTENT" -
4458    
4459           The instrument will immediately be loaded into memory in the           The instrument will immediately be loaded into memory when this
4460           background when this mapping command is sent and the instrument           mapping command is sent and the instrument is kept all the
4461           is kept all the time.  Instruments with this mode are only           time.  Instruments with this mode are only freed when the
4462           freed when the sampler is reset or all mapping entries with           sampler is reset or all mapping entries with this mode (and
4463           this mode (and respective instrument) are explicitly changed to           respective instrument) are explicitly changed to "ON_DEMAND"
4464           "ON_DEMAND" and no sampler channel is using the instrument           and no sampler channel is using the instrument anymore.
          anymore.  
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
4465    
4466        not supplied -        not supplied -
4467    
# Line 4267  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4474           that is it will not change the mode.           that is it will not change the mode.
4475    
4476    
4477    
4478    
4479    Schoenebeck             Expires October 18, 2007               [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol           April 2007
4482    
4483    
4484     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4485     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4486     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 4286  Internet-Draft        LinuxSampler Contr Line 4500  Internet-Draft        LinuxSampler Contr
4500     displaying an appropriate name for mapped instruments (using "GET     displaying an appropriate name for mapped instruments (using "GET
4501     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4502    
4503     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4504     will not block when an instrument is to be loaded due to a     completely established in the sampler.  The OPTIONAL "NON_MODAL"
4505     "PERSISTENT" type entry as instruments are loaded in the background.     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4506     As a consequence this command may not necessarily return an error     to return immediately, that is to let the sampler establish the
4507     i.e. when the given instrument file does not exist or may turn out to     mapping in the background.  So this argument might be especially
4508     be corrupt.     useful for mappings with a "PERSISTENT" type, because these have to
4509       load the respective instruments immediately and might thus block for
4510       a very long time.  It is recommended however to use the OPTIONAL
4511       "NON_MODAL" argument only if really necessary, because it has the
4512       following drawbacks: as "NON_MODAL" instructions return immediately,
4513       they may not necessarily return an error i.e. when the given
4514       instrument file turns out to be corrupt, beside that subsequent
4515       commands in a LSCP instruction sequence might fail, because mandatory
4516       mappings are not yet completed.
4517    
4518     Possible Answers:     Possible Answers:
4519    
# Line 4308  Internet-Draft        LinuxSampler Contr Line 4530  Internet-Draft        LinuxSampler Contr
4530    
4531    
4532    
4533  Schoenebeck               Expires July 2, 2007                 [Page 77]  
4534    
4535    Schoenebeck             Expires October 18, 2007               [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4538    
4539    
4540        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 4333  Internet-Draft        LinuxSampler Contr Line 4557  Internet-Draft        LinuxSampler Contr
4557    
4558        S: "OK"        S: "OK"
4559    
4560        C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4561        PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4562    
4563        S: "OK"        S: "OK"
4564    
# Line 4364  Internet-Draft        LinuxSampler Contr Line 4588  Internet-Draft        LinuxSampler Contr
4588    
4589    
4590    
4591  Schoenebeck               Expires July 2, 2007                 [Page 78]  Schoenebeck             Expires October 18, 2007               [Page 82]
4592    
4593  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4594    
4595    
4596        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 4420  Internet-Draft        LinuxSampler Contr Line 4644  Internet-Draft        LinuxSampler Contr
4644    
4645    
4646    
4647  Schoenebeck               Expires July 2, 2007                 [Page 79]  Schoenebeck             Expires October 18, 2007               [Page 83]
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4650    
4651    
4652        "OK" -        "OK" -
# Line 4476  Internet-Draft        LinuxSampler Contr Line 4700  Internet-Draft        LinuxSampler Contr
4700    
4701    
4702    
4703  Schoenebeck               Expires July 2, 2007                 [Page 80]  Schoenebeck             Expires October 18, 2007               [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4706    
4707    
4708        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
# Line 4532  Internet-Draft        LinuxSampler Contr Line 4756  Internet-Draft        LinuxSampler Contr
4756    
4757    
4758    
4759  Schoenebeck               Expires July 2, 2007                 [Page 81]  Schoenebeck             Expires October 18, 2007               [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4762    
4763    
4764  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
# Line 4571  Internet-Draft        LinuxSampler Contr Line 4795  Internet-Draft        LinuxSampler Contr
4795    
4796        S: "OK"        S: "OK"
4797    
4798    6.8.  Managing Instruments Database
4799    
4800       The following commands describe how to use and manage the instruments
4801       database.
4802    
4803    6.8.1.  Creating a new instrument directory
4804    
4805       The front-end can add a new instrument directory to the instruments
4806       database by sending the following command:
4807    
4808          ADD DB_INSTRUMENT_DIRECTORY <dir>
4809    
4810       Where <dir> is the absolute path name of the directory to be created
4811       (encapsulated into apostrophes).
4812    
4813    
4814    
4815    Schoenebeck             Expires October 18, 2007               [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol           April 2007
4818    
4819    
4820       Possible Answers:
4821    
4822          "OK" -
4823    
4824             on success
4825    
4826          "ERR:<error-code>:<error-message>" -
4827    
4828             when the directory could not be created, which can happen if
4829             the directory already exists or the name contains not allowed
4830             symbols
4831    
4832       Examples:
4833    
4834          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4835    
4836          S: "OK"
4837    
4838    6.8.2.  Deleting an instrument directory
4839    
4840       The front-end can delete a particular instrument directory from the
4841       instruments database by sending the following command:
4842    
4843          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4844    
4845       Where <dir> is the absolute path name of the directory to delete.
4846       The optional FORCE argument can be used to force the deletion of a
4847       non-empty directory and all its content.
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             if the directory is deleted successfully
4854    
4855          "ERR:<error-code>:<error-message>" -
4856    
4857             if the given directory does not exist, or if trying to delete a
4858             non-empty directory, without using the FORCE argument.
4859    
4860       Examples:
4861    
4862          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4863    
4864          S: "OK"
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck             Expires October 18, 2007               [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol           April 2007
4874    
4875    
4876    6.8.3.  Getting amount of instrument directories
4877    
4878       The front-end can retrieve the current amount of directories in a
4879       specific directory by sending the following command:
4880    
4881          GET DB_INSTRUMENT_DIRECTORIES <dir>
4882    
4883       Where <dir> should be replaced by the absolute path name of the
4884       directory.
4885    
4886       Possible Answers:
4887    
4888          The current number of instrument directories in the specified
4889          directory.
4890    
4891          "ERR:<error-code>:<error-message>" -
4892    
4893             if the given directory does not exist.
4894    
4895       Example:
4896    
4897          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4898    
4899          S: "2"
4900    
4901    6.8.4.  Listing all directories in specific directory
4902    
4903       The front-end can retrieve the current list of directories in
4904       specific directory by sending the following command:
4905    
4906          LIST DB_INSTRUMENT_DIRECTORIES <dir>
4907    
4908       Where <dir> should be replaced by the absolute path name of the
4909       directory.
4910    
4911       Possible Answers:
4912    
4913          A comma separated list of all instrument directories (encapsulated
4914          into apostrophes) in the specified directory.
4915    
4916          "ERR:<error-code>:<error-message>" -
4917    
4918             if the given directory does not exist.
4919    
4920       Example:
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck             Expires October 18, 2007               [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol           April 2007
4930    
4931    
4932          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4933    
4934          S: "'Piano Collection','Percussion Collection'"
4935    
4936    6.8.5.  Getting instrument directory information
4937    
4938       The front-end can ask for the current settings of an instrument
4939       directory by sending the following command:
4940    
4941          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4942    
4943       Where <dir> should be replaced by the absolute path name of the
4944       directory the front-end is interested in.
4945    
4946       Possible Answers:
4947    
4948          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4949          answer line begins with the settings category name followed by a
4950          colon and then a space character <SP> and finally the info
4951          character string to that setting category.  At the moment the
4952          following categories are defined:
4953    
4954    
4955    
4956             DESCRIPTION -
4957    
4958                A brief description of the directory content
4959    
4960             CREATED -
4961    
4962                The creation date and time of the directory, represented in
4963                "YYYY-MM-DD HH:MM:SS" format
4964    
4965             MODIFIED -
4966    
4967                The date and time of the last modification of the directory,
4968                represented in "YYYY-MM-DD HH:MM:SS" format
4969    
4970       The mentioned fields above don't have to be in particular order.
4971    
4972       Example:
4973    
4974          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
4975    
4976          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
4977          format."
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck             Expires October 18, 2007               [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol           April 2007
4986    
4987    
4988             "CREATED: 2007-02-05 10:23:12"
4989    
4990             "MODIFIED: 2007-04-07 12:50:21"
4991    
4992             "."
4993    
4994    6.8.6.  Renaming an instrument directory
4995    
4996       The front-end can alter the name of a specific instrument directory
4997       by sending the following command:
4998    
4999          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5000    
5001       Where <dir> is the absolute path name of the directory and <name> is
5002       the new name for that directory.
5003    
5004       Possible Answers:
5005    
5006          "OK" -
5007    
5008             on success
5009    
5010          "ERR:<error-code>:<error-message>" -
5011    
5012             in case the given directory does not exists, or if a directory
5013             with name equal to the new name already exists.
5014    
5015       Example:
5016    
5017          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5018          'Acoustic'"
5019    
5020          S: "OK"
5021    
5022    6.8.7.  Moving an instrument directory
5023    
5024       The front-end can move a specific instrument directory by sending the
5025       following command:
5026    
5027          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5028    
5029       Where <dir> is the absolute path name of the directory to move and
5030       <dst> is the location where the directory will be moved to.
5031    
5032       Possible Answers:
5033    
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck             Expires October 18, 2007               [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol           April 2007
5042    
5043    
5044          "OK" -
5045    
5046             on success
5047    
5048          "ERR:<error-code>:<error-message>" -
5049    
5050             in case a given directory does not exists, or if a directory
5051             with name equal to the name of the specified directory already
5052             exists in the destination directory.  Error is also thrown when
5053             trying to move a directory to a subdirectory of itself.
5054    
5055       Example:
5056    
5057          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5058          Acoustic'"
5059    
5060          S: "OK"
5061    
5062    6.8.8.  Changing the description of directory
5063    
5064       The front-end can alter the description of a specific instrument
5065       directory by sending the following command:
5066    
5067          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5068    
5069       Where <dir> is the absolute path name of the directory and <desc> is
5070       the new description for the directory.
5071    
5072       Possible Answers:
5073    
5074          "OK" -
5075    
5076             on success
5077    
5078          "ERR:<error-code>:<error-message>" -
5079    
5080             in case the given directory does not exists.
5081    
5082       Example:
5083    
5084          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5085          collection of piano instruments in various format.'"
5086    
5087          S: "OK"
5088    
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck             Expires October 18, 2007               [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol           April 2007
5098    
5099    
5100    6.8.9.  Adding instruments to the instruments database
5101    
5102       The front-end can add one or more instruments to the instruments
5103       database by sending the following command:
5104    
5105          ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]
5106    
5107       Where <db_dir> is the absolute path name of a directory (encapsulated
5108       into apostrophes) in the instruments database in which only the new
5109       instruments (that are not already in the database) will be added,
5110       <file_path> is the absolute path name of a file or directory in the
5111       file system (encapsulated into apostrophes).  In case an instrument
5112       file is supplied, only the instruments in the specified file will be
5113       added to the instruments database.  If the optional <instr_index>
5114       (the index of the instrument within the given file) is supplied too,
5115       then only the specified instrument will be added.  In case a
5116       directory is supplied, the instruments in that directory will be
5117       added.  The OPTIONAL <mode> argument is only applied when a directory
5118       is provided as <file_path> and specifies how the scanning will be
5119       done and has exactly the following possibilities:
5120    
5121          "NON_RECURSIVE" -
5122    
5123             Only the instruments in the specified directory will be added,
5124             the instruments in the subdirectories will not be processed.
5125    
5126          "FLAT" -
5127    
5128             All instruments will be processed, including those in the
5129             subdirectories, but the respective subdirectory structure will
5130             not be recreated in the instruments database.  All instruments
5131             will be added directly in the specified database directory.
5132    
5133          not supplied -
5134    
5135             The subdirectory tree structure will be recreated in the
5136             instruments database and all instruments will be processed and
5137             added to the respective subdirectory in the instruments
5138             database.
5139    
5140       Possible Answers:
5141    
5142          "OK" -
5143    
5144             on success
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck             Expires October 18, 2007               [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol           April 2007
5154    
5155    
5156          "ERR:<error-code>:<error-message>" -
5157    
5158             if an invalid path is specified.
5159    
5160       Examples:
5161    
5162          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5163          Bosendorfer 290.gig' 0"
5164    
5165          S: "OK"
5166    
5167    6.8.10.  Removing an instrument
5168    
5169       The front-end can remove a particular instrument from the instruments
5170       database by sending the following command:
5171    
5172          REMOVE DB_INSTRUMENT <instr_path>
5173    
5174       Where <instr_path> is the absolute path name (in the instruments
5175       database) of the instrument to remove.
5176    
5177       Possible Answers:
5178    
5179          "OK" -
5180    
5181             if the instrument is removed successfully
5182    
5183          "ERR:<error-code>:<error-message>" -
5184    
5185             if the given path does not exist or is a directory.
5186    
5187       Examples:
5188    
5189          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5190    
5191          S: "OK"
5192    
5193    6.8.11.  Getting amount of instruments
5194    
5195       The front-end can retrieve the current amount of instruments in a
5196       specific directory by sending the following command:
5197    
5198          GET DB_INSTRUMENTS <dir>
5199    
5200       Where <dir> should be replaced by the absolute path name of the
5201       directory.
5202    
5203       Possible Answers:
5204    
5205    
5206    
5207    Schoenebeck             Expires October 18, 2007               [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol           April 2007
5210    
5211    
5212          The current number of instruments in the specified directory.
5213    
5214          "ERR:<error-code>:<error-message>" -
5215    
5216             if the given directory does not exist.
5217    
5218       Example:
5219    
5220          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5221    
5222          S: "2"
5223    
5224    6.8.12.  Listing all instruments in specific directory
5225    
5226       The front-end can retrieve the current list of instruments in
5227       specific directory by sending the following command:
5228    
5229          LIST DB_INSTRUMENTS <dir>
5230    
5231       Where <dir> should be replaced by the absolute path name of the
5232       directory.
5233    
5234       Possible Answers:
5235    
5236          A comma separated list of all instruments (encapsulated into
5237          apostrophes) in the specified directory.
5238    
5239          "ERR:<error-code>:<error-message>" -
5240    
5241             if the given directory does not exist.
5242    
5243       Example:
5244    
5245          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5246    
5247          S: "'Bosendorfer 290','Steinway D'"
5248    
5249    6.8.13.  Getting instrument information
5250    
5251       The front-end can ask for the current settings of an instrument by
5252       sending the following command:
5253    
5254          GET DB_INSTRUMENT INFO <instr_path>
5255    
5256       Where <instr_path> should be replaced by the absolute path name of
5257       the instrument the front-end is interested in.
5258    
5259       Possible Answers:
5260    
5261    
5262    
5263    Schoenebeck             Expires October 18, 2007               [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol           April 2007
5266    
5267    
5268          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5269          answer line begins with the settings category name followed by a
5270          colon and then a space character <SP> and finally the info
5271          character string to that setting category.  At the moment the
5272          following categories are defined:
5273    
5274    
5275    
5276             INSTRUMENT_FILE -
5277    
5278                File name of the instrument.
5279    
5280             INSTRUMENT_NR -
5281    
5282                Index of the instrument within the file.
5283    
5284             FORMAT_FAMILY -
5285    
5286                The format family of the instrument.
5287    
5288             FORMAT_VERSION -
5289    
5290                The format version of the instrument.
5291    
5292             SIZE -
5293    
5294                The size of the instrument in bytes.
5295    
5296             CREATED -
5297    
5298                The date and time when the instrument is added in the
5299                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5300                format
5301    
5302             MODIFIED -
5303    
5304                The date and time of the last modification of the
5305                instrument's database settings, represented in "YYYY-MM-DD
5306                HH:MM:SS" format
5307    
5308             DESCRIPTION -
5309    
5310                A brief description of the instrument
5311    
5312             IS_DRUM -
5313    
5314                either true or false, determines whether the instrument is a
5315                drumkit or a chromatic instrument
5316    
5317    
5318    
5319    Schoenebeck             Expires October 18, 2007               [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol           April 2007
5322    
5323    
5324             PRODUCT -
5325    
5326                The product title of the instrument
5327    
5328             ARTISTS -
5329    
5330                Lists the artist names
5331    
5332             KEYWORDS -
5333    
5334                Provides a list of keywords that refer to the instrument.
5335                Keywords are separated with semicolon and blank.
5336    
5337       The mentioned fields above don't have to be in particular order.
5338    
5339       Example:
5340    
5341          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5342    
5343          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5344    
5345             "INSTRUMENT_NR: 0"
5346    
5347             "FORMAT_FAMILY: GIG"
5348    
5349             "FORMAT_VERSION: 2"
5350    
5351             "SIZE: 2050871870"
5352    
5353             "CREATED: 2007-02-05 10:23:12"
5354    
5355             "MODIFIED: 2007-04-07 12:50:21"
5356    
5357             "DESCRIPTION: "
5358    
5359             "IS_DRUM: false"
5360    
5361             "PRODUCT: GRANDIOSO Bosendorfer 290"
5362    
5363             "ARTISTS: Post Musical Instruments"
5364    
5365             "KEYWORDS: Bosendorfer"
5366    
5367             "."
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck             Expires October 18, 2007               [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol           April 2007
5378    
5379    
5380    6.8.14.  Renaming an instrument
5381    
5382       The front-end can alter the name of a specific instrument by sending
5383       the following command:
5384    
5385          SET DB_INSTRUMENT NAME <instr> <name>
5386    
5387       Where <instr> is the absolute path name of the instrument and <name>
5388       is the new name for that instrument.
5389    
5390       Possible Answers:
5391    
5392          "OK" -
5393    
5394             on success
5395    
5396          "ERR:<error-code>:<error-message>" -
5397    
5398             in case the given instrument does not exists, or if an
5399             instrument with name equal to the new name already exists.
5400    
5401       Example:
5402    
5403          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5404          'Bosendorfer 290'"
5405    
5406          S: "OK"
5407    
5408    6.8.15.  Moving an instrument
5409    
5410       The front-end can move a specific instrument to another directory by
5411       sending the following command:
5412    
5413          MOVE DB_INSTRUMENT <instr> <dst>
5414    
5415       Where <instr> is the absolute path name of the instrument to move and
5416       <dst> is the directory where the instrument will be moved to.
5417    
5418       Possible Answers:
5419    
5420          "OK" -
5421    
5422             on success
5423    
5424          "ERR:<error-code>:<error-message>" -
5425    
5426             in case the given instrument does not exists, or if an
5427             instrument with name equal to the name of the specified
5428    
5429    
5430    
5431  Schoenebeck               Expires July 2, 2007                 [Page 82]  Schoenebeck             Expires October 18, 2007               [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5434    
5435    
5436             instrument already exists in the destination directory.
5437    
5438       Example:
5439    
5440          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5441          Collection/Acoustic'"
5442    
5443          S: "OK"
5444    
5445    6.8.16.  Changing the description of instrument
5446    
5447       The front-end can alter the description of a specific instrument by
5448       sending the following command:
5449    
5450          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5451    
5452       Where <instr> is the absolute path name of the instrument and <desc>
5453       is the new description for the instrument.
5454    
5455       Possible Answers:
5456    
5457          "OK" -
5458    
5459             on success
5460    
5461          "ERR:<error-code>:<error-message>" -
5462    
5463             in case the given instrument does not exists.
5464    
5465       Example:
5466    
5467          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5468          Bosendorfer 290' 'No comment :)'"
5469    
5470          S: "OK"
5471    
5472    
5473    
5474    
5475    
5476    
5477    
5478    
5479    
5480    
5481    
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires October 18, 2007               [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol           April 2007
5490    
5491    
5492  7.  Command Syntax  7.  Command Syntax
# Line 4644  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck               Expires July 2, 2007                 [Page 83]  Schoenebeck             Expires October 18, 2007               [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5546    
5547    
5548        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4661  Internet-Draft        LinuxSampler Contr Line 5557  Internet-Draft        LinuxSampler Contr
5557    
5558        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
5559    
       / SELECT SP text  
   
5560        / RESET SP reset_instruction        / RESET SP reset_instruction
5561    
5562        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
5563    
5564          / MOVE SP move_instruction
5565    
5566        / RESET        / RESET
5567    
5568        / QUIT        / QUIT
# Line 4675  Internet-Draft        LinuxSampler Contr Line 5571  Internet-Draft        LinuxSampler Contr
5571    
5572        CHANNEL        CHANNEL
5573    
5574          / DB_INSTRUMENT_DIRECTORY SP pathname
5575    
5576          / DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5577    
5578          / DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5579    
5580          / DB_INSTRUMENTS SP pathname SP pathname
5581    
5582          / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5583    
5584        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
5585    
5586        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 4687  Internet-Draft        LinuxSampler Contr Line 5593  Internet-Draft        LinuxSampler Contr
5593    
5594        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
5595    
5596    
5597    
5598    
5599    Schoenebeck             Expires October 18, 2007              [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol           April 2007
5602    
5603    
5604        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
5605    
5606        / CHANNEL_COUNT        / CHANNEL_COUNT
# Line 4697  Internet-Draft        LinuxSampler Contr Line 5611  Internet-Draft        LinuxSampler Contr
5611    
5612        / BUFFER_FILL        / BUFFER_FILL
5613    
5614          / CHANNEL_INFO
5615    
5616          / FX_SEND_COUNT
5617    
5618          / FX_SEND_INFO
 Schoenebeck               Expires July 2, 2007                 [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       / CHANNEL_INFO  
5619    
5620        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
5621    
# Line 4715  Internet-Draft        LinuxSampler Contr Line 5625  Internet-Draft        LinuxSampler Contr
5625    
5626        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
5627    
5628          / DB_INSTRUMENT_DIRECTORY_COUNT
5629    
5630          / DB_INSTRUMENT_DIRECTORY_INFO
5631    
5632          / DB_INSTRUMENT_COUNT
5633    
5634          / DB_INSTRUMENT_INFO
5635    
5636        / MISCELLANEOUS        / MISCELLANEOUS
5637    
5638        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
5639    
5640          / GLOBAL_INFO
5641    
5642     unsubscribe_event =     unsubscribe_event =
5643    
5644        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 4729  Internet-Draft        LinuxSampler Contr Line 5649  Internet-Draft        LinuxSampler Contr
5649    
5650        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
5651    
5652    
5653    
5654    
5655    Schoenebeck             Expires October 18, 2007              [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol           April 2007
5658    
5659    
5660        / CHANNEL_COUNT        / CHANNEL_COUNT
5661    
5662        / VOICE_COUNT        / VOICE_COUNT
# Line 4739  Internet-Draft        LinuxSampler Contr Line 5667  Internet-Draft        LinuxSampler Contr
5667    
5668        / CHANNEL_INFO        / CHANNEL_INFO
5669    
5670          / FX_SEND_COUNT
5671    
5672          / FX_SEND_INFO
5673    
5674        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
5675    
5676        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 4747  Internet-Draft        LinuxSampler Contr Line 5679  Internet-Draft        LinuxSampler Contr
5679    
5680        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
5681    
5682        / MISCELLANEOUS        / DB_INSTRUMENT_DIRECTORY_COUNT
5683    
5684        / TOTAL_VOICE_COUNT        / DB_INSTRUMENT_DIRECTORY_INFO
5685    
5686     map_instruction =        / DB_INSTRUMENT_COUNT
5687    
5688          / DB_INSTRUMENT_INFO
5689    
5690          / MISCELLANEOUS
5691    
5692          / TOTAL_VOICE_COUNT
5693    
5694  Schoenebeck               Expires July 2, 2007                 [Page 85]        / GLOBAL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
5695    
5696       map_instruction =
5697    
5698        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
5699        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
5700    
5701        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5702        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5703        instr_load_mode        instr_load_mode
5704    
5705        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5706        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5707        entry_name        entry_name
5708    
5709        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP  
5710        engine_name SP filename SP instrument_index SP volume_value SP  
5711    Schoenebeck             Expires October 18, 2007              [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol           April 2007
5714    
5715    
5716          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5717          SP engine_name SP filename SP instrument_index SP volume_value SP
5718        instr_load_mode SP entry_name        instr_load_mode SP entry_name
5719    
5720     unmap_instruction =     unmap_instruction =
# Line 4788  Internet-Draft        LinuxSampler Contr Line 5729  Internet-Draft        LinuxSampler Contr
5729    
5730        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
5731    
5732          / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
5733    
5734          / DB_INSTRUMENT_DIRECTORY SP pathname
5735    
5736          / DB_INSTRUMENT SP pathname
5737    
5738     get_instruction =     get_instruction =
5739    
5740        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4810  Internet-Draft        LinuxSampler Contr Line 5757  Internet-Draft        LinuxSampler Contr
5757        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
5758        key_val_list        key_val_list
5759    
5760          / AUDIO_OUTPUT_DEVICES
5761    
5762          / MIDI_INPUT_DEVICES
5763    
 Schoenebeck               Expires July 2, 2007                 [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
5764    
5765    
       / AUDIO_OUTPUT_DEVICES  
5766    
5767        / MIDI_INPUT_DEVICES  Schoenebeck             Expires October 18, 2007              [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol           April 2007
5770    
5771    
5772        / AUDIO_OUTPUT_DEVICE SP INFO SP number        / AUDIO_OUTPUT_DEVICE SP INFO SP number
5773    
# Line 4864  Internet-Draft        LinuxSampler Contr Line 5812  Internet-Draft        LinuxSampler Contr
5812    
5813        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
5814    
5815          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
5816    
5817          / DB_INSTRUMENT_DIRECTORIES SP pathname
5818    
5819    
5820    
5821  Schoenebeck               Expires July 2, 2007                 [Page 87]  
5822    
5823    Schoenebeck             Expires October 18, 2007              [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5826    
5827    
5828        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
5829    
5830          / DB_INSTRUMENTS SP pathname
5831    
5832          / DB_INSTRUMENT SP INFO SP pathname
5833    
5834        / VOLUME        / VOLUME
5835    
# Line 4895  Internet-Draft        LinuxSampler Contr Line 5851  Internet-Draft        LinuxSampler Contr
5851    
5852        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5853    
5854          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5855    
5856        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5857        SP audio_channel_index SP audio_channel_index        SP audio_channel_index SP audio_channel_index
5858    
5859          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5860          midi_ctrl
5861    
5862          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5863          volume_value
5864    
5865          / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
5866    
5867          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
5868    
5869          / DB_INSTRUMENT SP NAME SP pathname SP dirname
5870    
5871          / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
5872    
5873        / ECHO SP boolean        / ECHO SP boolean
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires October 18, 2007              [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol           April 2007
5882    
5883    
5884        / VOLUME SP volume_value        / VOLUME SP volume_value
5885    
5886     create_instruction =     create_instruction =
# Line 4922  Internet-Draft        LinuxSampler Contr Line 5903  Internet-Draft        LinuxSampler Contr
5903    
5904     clear_instruction =     clear_instruction =
5905    
5906          MIDI_INSTRUMENTS SP midi_map
5907    
5908          / MIDI_INSTRUMENTS SP ALL
5909    
5910  Schoenebeck               Expires July 2, 2007                 [Page 88]     move_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
5911    
5912        MIDI_INSTRUMENTS SP midi_map        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
5913    
5914        / MIDI_INSTRUMENTS SP ALL        / DB_INSTRUMENT SP pathname SP pathname
5915    
5916     destroy_instruction =     destroy_instruction =
5917    
# Line 4949  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929    
5930     set_chan_instruction =     set_chan_instruction =
5931    
5932    
5933    
5934    
5935    Schoenebeck             Expires October 18, 2007              [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol           April 2007
5938    
5939    
5940        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
5941    
5942        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
# Line 4976  Internet-Draft        LinuxSampler Contr Line 5964  Internet-Draft        LinuxSampler Contr
5964    
5965        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5966    
5967          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5968    
5969          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5970    
5971       modal_arg =
5972    
5973          /* epsilon (empty argument) */
5974    
5975  Schoenebeck               Expires July 2, 2007                 [Page 89]        / NON_MODAL SP
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE  
   
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT  
5976    
5977     key_val_list =     key_val_list =
5978    
# Line 4999  Internet-Draft        LinuxSampler Contr Line 5984  Internet-Draft        LinuxSampler Contr
5984    
5985        BYTES        BYTES
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck             Expires October 18, 2007              [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol           April 2007
5994    
5995    
5996        / PERCENTAGE        / PERCENTAGE
5997    
5998     list_instruction =     list_instruction =
# Line 5023  Internet-Draft        LinuxSampler Contr Line 6017  Internet-Draft        LinuxSampler Contr
6017    
6018        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6019    
6020          / DB_INSTRUMENT_DIRECTORIES SP pathname
6021    
6022          / DB_INSTRUMENTS SP pathname
6023    
6024     load_instr_args =     load_instr_args =
6025    
6026        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 5033  Internet-Draft        LinuxSampler Contr Line 6031  Internet-Draft        LinuxSampler Contr
6031    
6032        engine_name SP sampler_channel        engine_name SP sampler_channel
6033    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6034     instr_load_mode =     instr_load_mode =
6035    
6036        ON_DEMAND        ON_DEMAND
# Line 5051  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041    
6042     device_index =     device_index =
6043    
6044    
6045    
6046    
6047    Schoenebeck             Expires October 18, 2007              [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol           April 2007
6050    
6051    
6052        number        number
6053    
6054     audio_channel_index =     audio_channel_index =
# Line 5089  Internet-Draft        LinuxSampler Contr Line 6087  Internet-Draft        LinuxSampler Contr
6087    
6088     midi_ctrl =     midi_ctrl =
6089    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6090        number        number
6091    
6092     volume_value =     volume_value =
# Line 5107  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097    
6098     sampler_channel =     sampler_channel =
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires October 18, 2007              [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol           April 2007
6106    
6107    
6108        number        number
6109    
6110     instrument_index =     instrument_index =
# Line 5121  Internet-Draft        LinuxSampler Contr Line 6119  Internet-Draft        LinuxSampler Contr
6119    
6120        string        string
6121    
6122       pathname =
6123    
6124          stringval
6125    
6126       dirname =
6127    
6128          stringval
6129    
6130     filename =     filename =
6131    
6132        stringval        stringval
# Line 5145  Internet-Draft        LinuxSampler Contr Line 6151  Internet-Draft        LinuxSampler Contr
6151    
6152     param_val =     param_val =
6153    
6154          string
6155    
6156    
6157    
 Schoenebeck               Expires July 2, 2007                 [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6158    
6159    Schoenebeck             Expires October 18, 2007              [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol           April 2007
6162    
       string  
6163    
6164        / stringval        / stringval
6165    
# Line 5204  Internet-Draft        LinuxSampler Contr Line 6210  Internet-Draft        LinuxSampler Contr
6210    
6211    
6212    
6213  Schoenebeck               Expires July 2, 2007                 [Page 93]  
6214    
6215    Schoenebeck             Expires October 18, 2007              [Page 111]
6216    
6217  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6218    
6219    
6220  8.  Events  8.  Events
# Line 5260  Internet-Draft        LinuxSampler Contr Line 6268  Internet-Draft        LinuxSampler Contr
6268    
6269    
6270    
6271  Schoenebeck               Expires July 2, 2007                 [Page 94]  Schoenebeck             Expires October 18, 2007              [Page 112]
6272    
6273  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6274    
6275    
6276        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 5316  Internet-Draft        LinuxSampler Contr Line 6324  Internet-Draft        LinuxSampler Contr
6324    
6325    
6326    
6327  Schoenebeck               Expires July 2, 2007                 [Page 95]  Schoenebeck             Expires October 18, 2007              [Page 113]
6328    
6329  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6330    
6331    
6332        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
6333    
6334     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6335     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
# Line 5372  Internet-Draft        LinuxSampler Contr Line 6380  Internet-Draft        LinuxSampler Contr
6380    
6381    
6382    
6383  Schoenebeck               Expires July 2, 2007                 [Page 96]  Schoenebeck             Expires October 18, 2007              [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6386    
6387    
6388        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 5386  Internet-Draft        LinuxSampler Contr Line 6394  Internet-Draft        LinuxSampler Contr
6394     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
6395     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
6396    
6397  8.10.  Total number of active voices changed  8.10.  Number of effect sends changed
6398    
6399       Client may want to be notified when the number of effect sends on a
6400       particular sampler channel is changed by issuing the following
6401       command:
6402    
6403          SUBSCRIBE FX_SEND_COUNT
6404    
6405       Server will start sending the following notification messages:
6406    
6407          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
6408    
6409       where <channel-id> will be replaced by the numerical ID of the
6410       sampler channel, on which the effect sends number is changed and <fx-
6411       sends> will be replaced by the new number of effect sends on that
6412       channel.
6413    
6414    8.11.  Effect send information changed
6415    
6416       Client may want to be notified when changes were made to effect sends
6417       on a a particular sampler channel by issuing the following command:
6418    
6419          SUBSCRIBE FX_SEND_INFO
6420    
6421       Server will start sending the following notification messages:
6422    
6423          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
6424    
6425       where <channel-id> will be replaced by the numerical ID of the
6426       sampler channel, on which an effect send entity is changed and <fx-
6427       send-id> will be replaced by the numerical ID of the changed effect
6428       send.
6429    
6430    8.12.  Total number of active voices changed
6431    
6432     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
6433     back-end changes by issuing the following command:     back-end changes by issuing the following command:
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires October 18, 2007              [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol           April 2007
6442    
6443    
6444        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
6445    
6446     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6447    
6448        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
6449    
6450     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
6451     active voices.     active voices.
6452    
6453  8.11.  Number of MIDI instrument maps changed  8.13.  Number of MIDI instrument maps changed
6454    
6455     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
6456     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 5414  Internet-Draft        LinuxSampler Contr Line 6464  Internet-Draft        LinuxSampler Contr
6464     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
6465     maps.     maps.
6466    
6467  8.12.  MIDI instrument map information changed  8.14.  MIDI instrument map information changed
6468    
6469     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
6470     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
# Line 5423  Internet-Draft        LinuxSampler Contr Line 6473  Internet-Draft        LinuxSampler Contr
6473    
6474     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6475    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6476        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
6477    
6478     where <map-id> will be replaced by the numerical ID of the MIDI     where <map-id> will be replaced by the numerical ID of the MIDI
# Line 5443  Internet-Draft        LinuxSampler Contr Line 6483  Internet-Draft        LinuxSampler Contr
6483     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
6484     message is sufficient here.     message is sufficient here.
6485    
6486  8.13.  Number of MIDI instruments changed  8.15.  Number of MIDI instruments changed
6487    
6488     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
6489     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires October 18, 2007              [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol           April 2007
6498    
6499    
6500        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
6501    
6502     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 5458  Internet-Draft        LinuxSampler Contr Line 6507  Internet-Draft        LinuxSampler Contr
6507     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
6508     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
6509    
6510  8.14.  MIDI instrument information changed  8.16.  MIDI instrument information changed
6511    
6512     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
6513     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 5478  Internet-Draft        LinuxSampler Contr Line 6527  Internet-Draft        LinuxSampler Contr
6527     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
6528     empty notification message is sufficient here.     empty notification message is sufficient here.
6529    
6530    8.17.  Global settings changed
6531    
6532       Client may want to be notified when changes to the global settings of
6533       the sampler were made by issuing the following command:
6534    
6535          SUBSCRIBE GLOBAL_INFO
6536    
6537       Server will start sending the following types of notification
6538       messages:
6539    
6540          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
6541          volume of the sampler is changed, where <volume> will be replaced
6542          by the optional dotted floating point value, reflecting the new
6543          global volume parameter.
6544    
6545    
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck             Expires October 18, 2007              [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol           April 2007
6554    
6555    
6556    8.18.  Number of database instrument directories changed
6557    
6558       Client may want to be notified when the number of instrument
6559       directories in a particular directory in the instruments database is
6560       changed by issuing the following command:
6561    
6562          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
6563    
6564       Server will start sending the following notification messages:
6565    
6566          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
6567    
6568       where <dir-path> will be replaced by the absolute path name of the
6569       directory in the instruments database, in which the number of
6570       directories is changed.
6571    
6572       Note that when a non-empty directory is removed, this event is not
6573       sent for the subdirectories in that directory.
6574    
6575    8.19.  Database instrument directory information changed
6576    
6577       Client may want to be notified when changes were made to directories
6578       in the instruments database by issuing the following command:
6579    
6580          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
6581    
6582       Server will start sending the following notification messages:
6583    
6584          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
6585    
6586       where <dir-path> will be replaced by the absolute path name of the
6587       directory, for which information changes occurred.  The front-end
6588       will have to send the respective command to actually get the updated
6589       directory info.  Because these messages will be triggered by LSCP
6590       commands issued by other clients rather than real time events
6591       happening on the server, it is believed that an empty notification
6592       message is sufficient here.
6593    
6594          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
6595          name>"
6596    
6597       where <old-dir-path> is the old absolute path name of the directory
6598       (encapsulated into apostrophes), which name is changes and <new-name>
6599       is the new name of the directory, encapsulated into apostrophes.
6600    
6601    
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck             Expires October 18, 2007              [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol           April 2007
6610    
6611    
6612    8.20.  Number of database instruments changed
6613    
6614       Client may want to be notified when the number of instruments in a
6615       particular directory in the instruments database is changed by
6616       issuing the following command:
6617    
6618          SUBSCRIBE DB_INSTRUMENT_COUNT
6619    
6620       Server will start sending the following notification messages:
6621    
6622          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
6623    
6624       where <dir-path> will be replaced by the absolute path name of the
6625       directory in the instruments database, in which the number of
6626       instruments is changed.
6627    
6628       Note that when a non-empty directory is removed, this event is not
6629       sent for the instruments in that directory.
6630    
6631    8.21.  Database instrument information changed
6632    
6633       Client may want to be notified when changes were made to instruments
6634       in the instruments database by issuing the following command:
6635    
6636          SUBSCRIBE DB_INSTRUMENT_INFO
6637    
6638       Server will start sending the following notification messages:
6639    
6640          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
6641    
6642       where <instr-path> will be replaced by the absolute path name of the
6643       instrument, which settings are changed.  The front-end will have to
6644       send the respective command to actually get the updated directory
6645       info.  Because these messages will be triggered by LSCP commands
6646       issued by other clients rather than real time events happening on the
6647       server, it is believed that an empty notification message is
6648       sufficient here.
6649    
6650          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
6651    
6652       where <old-instr-path> is the old absolute path name of the
6653       instrument (encapsulated into apostrophes), which name is changes and
6654       <new-name> is the new name of the instrument, encapsulated into
6655       apostrophes.
6656    
6657    
6658    
6659    
6660    
6661    
6662    
6663  Schoenebeck               Expires July 2, 2007                 [Page 98]  Schoenebeck             Expires October 18, 2007              [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6666    
6667    
6668  8.15.  Miscellaneous and debugging events  8.22.  Miscellaneous and debugging events
6669    
6670     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
6671     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 5540  Internet-Draft        LinuxSampler Contr Line 6716  Internet-Draft        LinuxSampler Contr
6716    
6717    
6718    
6719  Schoenebeck               Expires July 2, 2007                 [Page 99]  Schoenebeck             Expires October 18, 2007              [Page 120]
6720    
6721  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6722    
6723    
6724  9.  Security Considerations  9.  Security Considerations
# Line 5596  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775  Schoenebeck               Expires July 2, 2007                [Page 100]  Schoenebeck             Expires October 18, 2007              [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6778    
6779    
6780  10.  Acknowledgments  10.  Acknowledgments
# Line 5652  Internet-Draft        LinuxSampler Contr Line 6828  Internet-Draft        LinuxSampler Contr
6828    
6829    
6830    
6831  Schoenebeck               Expires July 2, 2007                [Page 101]  Schoenebeck             Expires October 18, 2007              [Page 122]
6832    
6833  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6834    
6835    
6836  11.  References  11.  References
# Line 5708  Internet-Draft        LinuxSampler Contr Line 6884  Internet-Draft        LinuxSampler Contr
6884    
6885    
6886    
6887  Schoenebeck               Expires July 2, 2007                [Page 102]  Schoenebeck             Expires October 18, 2007              [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6890    
6891    
6892  Author's Address  Author's Address
# Line 5764  Author's Address Line 6940  Author's Address
6940    
6941    
6942    
6943  Schoenebeck               Expires July 2, 2007                [Page 103]  Schoenebeck             Expires October 18, 2007              [Page 124]
6944    
6945  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6946    
6947    
6948  Full Copyright Statement  Full Copyright Statement
6949    
6950     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2007).
6951    
6952     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
6953     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 5779  Full Copyright Statement Line 6955  Full Copyright Statement
6955    
6956     This document and the information contained herein are provided on an     This document and the information contained herein are provided on an
6957     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
6958     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
6959     ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,     THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
6960     INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE     OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
6961     INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED     THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
6962     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
6963    
6964    
# Line 5820  Acknowledgment Line 6996  Acknowledgment
6996    
6997    
6998    
6999  Schoenebeck               Expires July 2, 2007                [Page 104]  Schoenebeck             Expires October 18, 2007              [Page 125]
7000    
Legend:
Removed from v.1006  
changed lines
  Added in v.1162
  ViewVC Help
Powered by ViewVC