/[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 561 by schoenebeck, Sat May 21 20:01:32 2005 UTC revision 1251 by schoenebeck, Fri Jun 22 14:24:57 2007 UTC
# Line 1  Line 1 
1    
2    
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: November 19, 2005                             Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                              May 21, 2005  Expires: December 24, 2007                                 June 22, 2007
8    
9    
10                       LinuxSampler Control Protocol                   LinuxSampler Control Protocol (draft)
11                                  lscp.txt                                LSCP 1.2cvs
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
22     other groups may also distribute working documents as     other groups may also distribute working documents as Internet-
23     Internet-Drafts.     Drafts.
24    
25     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
26     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
# Line 30  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 November 19, 2005.     This Internet-Draft will expire on December 24, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2005).  All Rights Reserved.     Copyright (C) The IETF Trust (2007).
41    
42    
43    
44    
45    
46    
47    
48    
49    
50    
51    
52    
53    
54    
55    Schoenebeck             Expires December 24, 2007               [Page 1]
56    
57    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
58    
59    
60  Abstract  Abstract
61    
62     The LinuxSampler Control Protocol (LSCP) is an application-level     The LinuxSampler Control Protocol (LSCP) is an application-level
63     protocol primarily intended for local and remote controlling the     protocol primarily intended for local and remote controlling the
64     LinuxSampler main application, which is a sophisticated console     LinuxSampler backend application, which is a sophisticated server-
65     application essentially playing back audio samples and manipulating     like console application essentially playing back audio samples and
66     the samples in real time to certain extent.     manipulating the samples in real time to certain extent.
67    
68    
69    Table of Contents
70    
71       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72       2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76         5.1.  Request/response communication method . . . . . . . . . .  10
77           5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78         5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79       6.  Description for control commands  . . . . . . . . . . . . . .  15
80         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82           6.2.1.  Getting amount of available audio output drivers  . .  16
83           6.2.2.  Getting all available audio output drivers  . . . . .  16
84           6.2.3.  Getting information about a specific audio output
85                   driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86           6.2.4.  Getting information about specific audio output
87                   driver parameter  . . . . . . . . . . . . . . . . . .  17
88           6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89           6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90           6.2.7.  Getting all created audio output device count . . . .  23
91           6.2.8.  Getting all created audio output device list  . . . .  23
92           6.2.9.  Getting current settings of an audio output device  .  23
93           6.2.10. Changing settings of audio output devices . . . . . .  25
94           6.2.11. Getting information about an audio channel  . . . . .  26
95           6.2.12. Getting information about specific audio channel
96                   parameter . . . . . . . . . . . . . . . . . . . . . .  27
97           6.2.13. Changing settings of audio output channels  . . . . .  29
98         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99           6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100           6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101           6.3.3.  Getting information about a specific MIDI input
102                   driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103           6.3.4.  Getting information about specific MIDI input
104                   driver parameter  . . . . . . . . . . . . . . . . . .  33
105           6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106           6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107           6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111    Schoenebeck             Expires December 24, 2007               [Page 2]
112    
113    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
114    
115    
116           6.3.8.  Getting all created MIDI input device list  . . . . .  37
117           6.3.9.  Getting current settings of a MIDI input device . . .  38
118           6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119           6.3.11. Getting information about a MIDI port . . . . . . . .  39
120           6.3.12. Getting information about specific MIDI port
121                   parameter . . . . . . . . . . . . . . . . . . . . . .  40
122           6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124           6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125           6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126           6.4.3.  Getting all created sampler channel count . . . . . .  45
127           6.4.4.  Getting all created sampler channel list  . . . . . .  45
128           6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129           6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46
130           6.4.7.  Getting amount of available engines . . . . . . . . .  47
131           6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132           6.4.9.  Getting information about an engine . . . . . . . . .  48
133           6.4.10. Getting sampler channel information . . . . . . . . .  49
134           6.4.11. Current number of active voices . . . . . . . . . . .  52
135           6.4.12. Current number of active disk streams . . . . . . . .  52
136           6.4.13. Current fill state of disk stream buffers . . . . . .  53
137           6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138           6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139           6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140           6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141           6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142           6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57
143           6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144           6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145           6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59
146           6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel . . . . . . . . . . . . . . . . . . . . . . .  61
149           6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150           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 .  64
152           6.4.28. Listing all effect sends on a sampler channel . . . .  64
153           6.4.29. Getting effect send information . . . . . . . . . . .  65
154           6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155           6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156           6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157           6.4.33. Altering effect send's send level . . . . . . . . . .  69
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70
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
162                   messages  . . . . . . . . . . . . . . . . . . . . . .  71
163           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72
164    
165    
166    
167    Schoenebeck             Expires December 24, 2007               [Page 3]
168    
169    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
170    
171    
172           6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72
174           6.6.1.  Current number of active voices . . . . . . . . . . .  73
175           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176           6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177           6.6.4.  General sampler informations  . . . . . . . . . . . .  73
178           6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179           6.6.6.  Setting global volume attenuation . . . . . . . . . .  75
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182           6.7.2.  Delete one particular or all MIDI instrument maps . .  77
183           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
185           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 . . . .  80
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189           6.7.9.  Getting indeces of all entries of a MIDI
190                   instrument map  . . . . . . . . . . . . . . . . . . .  83
191           6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
192           6.7.11. Get current settings of MIDI instrument map entry . .  84
193           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195           6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196           6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87
197           6.8.3.  Getting amount of instrument directories  . . . . . .  88
198           6.8.4.  Listing all directories in specific directory . . . .  89
199           6.8.5.  Getting instrument directory information  . . . . . .  89
200           6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201           6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91
202           6.8.8.  Copying instrument directories  . . . . . . . . . . .  92
203           6.8.9.  Changing the description of directory . . . . . . . .  92
204           6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93
205           6.8.11. Adding instruments to the instruments database  . . .  94
206           6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207           6.8.13. Getting amount of instruments . . . . . . . . . . . .  96
208           6.8.14. Listing all instruments in specific directory . . . .  97
209           6.8.15. Getting instrument information  . . . . . . . . . . .  97
210           6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100
211           6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 100
212           6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101
213           6.8.19. Changing the description of instrument  . . . . . . . 102
214           6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102
215           6.8.21. Getting job status information  . . . . . . . . . . . 104
216       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 106
217         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 119
218       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
219         8.1.  Number of audio output devices changed  . . . . . . . . . 121
220    
221    
222    
223    Schoenebeck             Expires December 24, 2007               [Page 4]
224    
225    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
226    
227    
228         8.2.  Audio output device's settings changed  . . . . . . . . . 121
229         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 121
230         8.4.  MIDI input device's settings changed  . . . . . . . . . . 122
231         8.5.  Number of sampler channels changed  . . . . . . . . . . . 122
232         8.6.  Number of active voices changed . . . . . . . . . . . . . 122
233         8.7.  Number of active disk streams changed . . . . . . . . . . 123
234         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 123
235         8.9.  Channel information changed . . . . . . . . . . . . . . . 123
236         8.10. Number of effect sends changed  . . . . . . . . . . . . . 124
237         8.11. Effect send information changed . . . . . . . . . . . . . 124
238         8.12. Total number of active voices changed . . . . . . . . . . 124
239         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 125
240         8.14. MIDI instrument map information changed . . . . . . . . . 125
241         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 125
242         8.16. MIDI instrument information changed . . . . . . . . . . . 126
243         8.17. Global settings changed . . . . . . . . . . . . . . . . . 126
244         8.18. Number of database instrument directories changed . . . . 127
245         8.19. Database instrument directory information changed . . . . 127
246         8.20. Number of database instruments changed  . . . . . . . . . 128
247         8.21. Database instrument information changed . . . . . . . . . 128
248         8.22. Database job status information changed . . . . . . . . . 129
249         8.23. Miscellaneous and debugging events  . . . . . . . . . . . 129
250       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 130
251       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 131
252       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 132
253       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 133
254       Intellectual Property and Copyright Statements  . . . . . . . . . 134
255    
256    
257    
258    
# Line 52  Abstract Line 262  Abstract
262    
263    
264    
 Schoenebeck            Expires November 19, 2005                [Page 1]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
265    
266    
 Table of Contents  
267    
    1.   Requirements notation  . . . . . . . . . . . . . . . . . . .   4  
    2.   Introduction . . . . . . . . . . . . . . . . . . . . . . . .   5  
    3.   Focus of this protocol . . . . . . . . . . . . . . . . . . .   6  
    4.   Communication Overview . . . . . . . . . . . . . . . . . . .   7  
      4.1  Request/response communication method  . . . . . . . . . .   7  
        4.1.1  Result format  . . . . . . . . . . . . . . . . . . . .   8  
      4.2  Subscribe/notify communication method  . . . . . . . . . .   9  
    5.   Description for control commands . . . . . . . . . . . . . .  12  
      5.1  Ignored lines and comments . . . . . . . . . . . . . . . .  12  
      5.2  Configuring audio drivers  . . . . . . . . . . . . . . . .  12  
        5.2.1  Getting amount of available audio output drivers . . .  12  
        5.2.2  Getting all available audio output drivers . . . . . .  13  
        5.2.3  Getting information about a specific audio output  
               driver . . . . . . . . . . . . . . . . . . . . . . . .  13  
        5.2.4  Getting information about specific audio output  
               driver parameter . . . . . . . . . . . . . . . . . . .  14  
        5.2.5  Creating an audio output device  . . . . . . . . . . .  17  
        5.2.6  Destroying an audio output device  . . . . . . . . . .  17  
        5.2.7  Getting all created audio output device count  . . . .  18  
        5.2.8  Getting all created audio output device list . . . . .  18  
        5.2.9  Getting current settings of an audio output device . .  19  
        5.2.10   Changing settings of audio output devices  . . . . .  20  
        5.2.11   Getting information about an audio channel . . . . .  20  
        5.2.12   Getting information about specific audio channel  
                 parameter  . . . . . . . . . . . . . . . . . . . . .  22  
        5.2.13   Changing settings of audio output channels . . . . .  23  
      5.3  Configuring MIDI input drivers . . . . . . . . . . . . . .  24  
        5.3.1  Getting amount of available MIDI input drivers . . . .  24  
        5.3.2  Getting all available MIDI input drivers . . . . . . .  25  
        5.3.3  Getting information about a specific MIDI input  
               driver . . . . . . . . . . . . . . . . . . . . . . . .  25  
        5.3.4  Getting information about specific MIDI input  
               driver parameter . . . . . . . . . . . . . . . . . . .  26  
        5.3.5  Creating a MIDI input device . . . . . . . . . . . . .  28  
        5.3.6  Destroying a MIDI input device . . . . . . . . . . . .  29  
        5.3.7  Getting all created MIDI input device count  . . . . .  29  
        5.3.8  Getting all created MIDI input device list . . . . . .  29  
        5.3.9  Getting current settings of a MIDI input device  . . .  30  
        5.3.10   Changing settings of MIDI input devices  . . . . . .  31  
        5.3.11   Getting information about a MIDI port  . . . . . . .  31  
        5.3.12   Getting information about specific MIDI port  
                 parameter  . . . . . . . . . . . . . . . . . . . . .  32  
        5.3.13   Changing settings of MIDI input ports  . . . . . . .  33  
      5.4  Configuring sampler channels . . . . . . . . . . . . . . .  34  
        5.4.1  Loading an instrument  . . . . . . . . . . . . . . . .  34  
        5.4.2  Loading a sampler engine . . . . . . . . . . . . . . .  35  
   
   
   
 Schoenebeck            Expires November 19, 2005                [Page 2]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
        5.4.3  Getting all created sampler channel count  . . . . . .  36  
        5.4.4  Getting all created sampler channel list . . . . . . .  36  
        5.4.5  Adding a new sampler channel . . . . . . . . . . . . .  36  
        5.4.6  Removing a sampler channel . . . . . . . . . . . . . .  37  
        5.4.7  Getting amount of available engines  . . . . . . . . .  38  
        5.4.8  Getting all available engines  . . . . . . . . . . . .  38  
        5.4.9  Getting information about an engine  . . . . . . . . .  38  
        5.4.10   Getting sampler channel information  . . . . . . . .  39  
        5.4.11   Current number of active voices  . . . . . . . . . .  41  
        5.4.12   Current number of active disk streams  . . . . . . .  41  
        5.4.13   Current fill state of disk stream buffers  . . . . .  42  
        5.4.14   Setting audio output device  . . . . . . . . . . . .  42  
        5.4.15   Setting audio output type  . . . . . . . . . . . . .  43  
        5.4.16   Setting audio output channel . . . . . . . . . . . .  44  
        5.4.17   Setting MIDI input device  . . . . . . . . . . . . .  44  
        5.4.18   Setting MIDI input type  . . . . . . . . . . . . . .  45  
        5.4.19   Setting MIDI input port  . . . . . . . . . . . . . .  45  
        5.4.20   Setting MIDI input channel . . . . . . . . . . . . .  46  
        5.4.21   Setting channel volume . . . . . . . . . . . . . . .  46  
        5.4.22   Resetting a sampler channel  . . . . . . . . . . . .  47  
      5.5  Controlling connection . . . . . . . . . . . . . . . . . .  48  
        5.5.1  Register front-end for receiving event messages  . . .  48  
        5.5.2  Unregister front-end for not receiving event  
               messages . . . . . . . . . . . . . . . . . . . . . . .  48  
        5.5.3  Enable or disable echo of commands . . . . . . . . . .  49  
        5.5.4  Close client connection  . . . . . . . . . . . . . . .  49  
      5.6  Global commands  . . . . . . . . . . . . . . . . . . . . .  50  
        5.6.1  Reset sampler  . . . . . . . . . . . . . . . . . . . .  50  
    6.   Command Syntax . . . . . . . . . . . . . . . . . . . . . . .  51  
    7.   Events . . . . . . . . . . . . . . . . . . . . . . . . . . .  52  
      7.1  Number of sampler channels changed . . . . . . . . . . . .  52  
      7.2  Number of active voices changed  . . . . . . . . . . . . .  52  
      7.3  Number of active disk streams changed  . . . . . . . . . .  52  
      7.4  Disk stream buffer fill state changed  . . . . . . . . . .  53  
      7.5  Channel information changed  . . . . . . . . . . . . . . .  53  
      7.6  Miscellaneous and debugging events . . . . . . . . . . . .  53  
    8.   Security Considerations  . . . . . . . . . . . . . . . . . .  55  
    9.   Acknowledgments  . . . . . . . . . . . . . . . . . . . . . .  56  
    10.  References . . . . . . . . . . . . . . . . . . . . . . . . .  56  
         Author's Address . . . . . . . . . . . . . . . . . . . . . .  56  
         Intellectual Property and Copyright Statements . . . . . . .  57  
268    
269    
270    
# Line 164  Internet-Draft       LinuxSampler Contro Line 275  Internet-Draft       LinuxSampler Contro
275    
276    
277    
278  Schoenebeck            Expires November 19, 2005                [Page 3]  
279    Schoenebeck             Expires December 24, 2007               [Page 5]
280    
281  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 178  Internet-Draft       LinuxSampler Contro Line 290  Internet-Draft       LinuxSampler Contro
290     This protocol is always case-sensitive if not explicitly claimed the     This protocol is always case-sensitive if not explicitly claimed the
291     opposite.     opposite.
292    
293     In examples, "C:" and "S:" indicate lines sent by the client     In examples, "C:" and "S:" indicate lines sent by the client (front-
294     (front-end) and server (LinuxSampler) respectively.  Lines in     end) and server (LinuxSampler) respectively.  Lines in examples must
295     examples must be interpreted as every line being CRLF terminated     be interpreted as every line being CRLF terminated (carriage return
296     (carriage return character followed by line feed character as defined     character followed by line feed character as defined in the ASCII
297     in the ASCII standard), thus the following example:     standard [RFC20]), thus the following example:
298    
299        C: "some line"        C: "some line"
300    
301           "another line"           "another line"
302    
303     must actually be interpreted as client sending the following message:     must actually be interpreted as client sending the following message:
# Line 203  Internet-Draft       LinuxSampler Contro Line 316  Internet-Draft       LinuxSampler Contro
316     sequence scenario:     sequence scenario:
317    
318     o  server sending message "a"     o  server sending message "a"
319    
320     o  followed by a delay (pause) with arbitrary duration     o  followed by a delay (pause) with arbitrary duration
321    
322     o  followed by server sending message "bcd<CR>"     o  followed by server sending message "bcd<CR>"
323    
324     o  again followed by a delay (pause) with arbitrary duration     o  again followed by a delay (pause) with arbitrary duration
325    
326     o  followed by server sending the message "<LF>"     o  followed by server sending the message "<LF>"
327    
328     where again <CR> and <LF> symbolize the carriage return and line feed     where again <CR> and <LF> symbolize the carriage return and line feed
# Line 215  Internet-Draft       LinuxSampler Contro Line 332  Internet-Draft       LinuxSampler Contro
332    
333    
334    
335    Schoenebeck             Expires December 24, 2007               [Page 6]
336    
337    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
338    
339    
340    2.  Versioning of this specification
341    
342       LSCP will certainly be extended and enhanced by-and-by.  Each
343       official release of the LSCP specification will be tagged with a
344       unique version tuple.  The version tuple consists at least of a major
345       and minor version number like:
346    
347          "1.2"
348    
349       In this example the major version number would be "1" and the minor
350       version number would be "2".  Note that the version tuple might also
351       have more than two elements.  The major version number defines a
352       group of backward compatible versions.  That means a frontend is
353       compatible to the connected sampler if and only if the LSCP versions
354       to which each of the two parties complies to, match both of the
355       following rules:
356    
357       Compatibility:
358    
359       1.  The frontend's LSCP major version and the sampler's LSCP major
360           version are exactly equal.
361    
362       2.  The frontend's LSCP minor version is less or equal than the
363           sampler's LSCP minor version.
364    
365       Compatibility can only be claimed if both rules are true.  The
366       frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
367       the version of the LSCP specification the sampler complies with.
368    
369    
370    
371    
372    
373    
374    
375    
376    
377    
378    
379    
380  Schoenebeck            Expires November 19, 2005                [Page 4]  
381    
382    
383    
384    
385    
386    
387    
388    
389    
390    
391    Schoenebeck             Expires December 24, 2007               [Page 7]
392    
393  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
394    
395    
396  2.  Introduction  3.  Introduction
397    
398     LinuxSampler is a so called software sampler application capable to     LinuxSampler is a so called software sampler application capable to
399     playback audio samples from a computer's Random Access Memory (RAM)     playback audio samples from a computer's Random Access Memory (RAM)
# Line 235  Internet-Draft       LinuxSampler Contro Line 403  Internet-Draft       LinuxSampler Contro
403     virtual channels which will be referred in this document as "sampler     virtual channels which will be referred in this document as "sampler
404     channels".  The channels are in such way virtual as they can be     channels".  The channels are in such way virtual as they can be
405     connected to an arbitrary MIDI input method and arbitrary MIDI     connected to an arbitrary MIDI input method and arbitrary MIDI
406     channel (e.g.  sampler channel 17 could be connected to an ALSA     channel (e.g. sampler channel 17 could be connected to an ALSA
407     sequencer device 64:0 and listening to MIDI channel 1 there).  Each     sequencer device 64:0 and listening to MIDI channel 1 there).  Each
408     sampler engine will be assigned an own instance of one of the     sampler channel will be associated with an instance of one of the
409     available sampler engines (e.g.  GigEngine, DLSEngine).  The audio     available sampler engines (e.g.  GigEngine, DLSEngine).  The audio
410     output of each sampler channel can be routed to an arbitrary audio     output of each sampler channel can be routed to an arbitrary audio
411     output method (ALSA / JACK) and an arbitrary audio output channel     output method (ALSA / JACK) and an arbitrary audio output channel
# Line 276  Internet-Draft       LinuxSampler Contro Line 444  Internet-Draft       LinuxSampler Contro
444    
445    
446    
447  Schoenebeck            Expires November 19, 2005                [Page 5]  Schoenebeck             Expires December 24, 2007               [Page 8]
448    
449  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
450    
451    
452  3.  Focus of this protocol  4.  Focus of this protocol
453    
454     Main focus of this protocol is to provide a way to configure a     Main focus of this protocol is to provide a way to configure a
455     running LinuxSampler instance and to retrieve information about it.     running LinuxSampler instance and to retrieve information about it.
# Line 332  Internet-Draft       LinuxSampler Contro Line 500  Internet-Draft       LinuxSampler Contro
500    
501    
502    
503  Schoenebeck            Expires November 19, 2005                [Page 6]  Schoenebeck             Expires December 24, 2007               [Page 9]
504    
505  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
506    
507    
508  4.  Communication Overview  5.  Communication Overview
509    
510     There are two distinct methods of communication between a running     There are two distinct methods of communication between a running
511     instance of LinuxSampler and one or more control applications, so     instance of LinuxSampler and one or more control applications, so
# Line 349  Internet-Draft       LinuxSampler Contro Line 517  Internet-Draft       LinuxSampler Contro
517     more effort to be implemented in the front-end application.  The two     more effort to be implemented in the front-end application.  The two
518     communication methods will be described next.     communication methods will be described next.
519    
520  4.1  Request/response communication method  5.1.  Request/response communication method
521    
522     This simple communication method is based on TCP.  The front-end     This simple communication method is based on TCP [RFC793].  The
523     application establishes a TCP connection to the LinuxSampler instance     front-end application establishes a TCP connection to the
524     on a certain host system.  Then the front-end application will send     LinuxSampler instance on a certain host system.  Then the front-end
525     certain ASCII based commands as defined in this document (every     application will send certain ASCII based commands as defined in this
526     command line must be CRLF terminated - see "Conventions used in this     document (every command line must be CRLF terminated - see
527     document" at the beginning of this document) and the LinuxSampler     "Conventions used in this document" at the beginning of this
528     application will response after a certain process time with an     document) and the LinuxSampler application will response after a
529     appropriate ASCII based answer, also as defined in this document.  So     certain process time with an appropriate ASCII based answer, also as
530     this TCP communication is simply based on query and answer paradigm.     defined in this document.  So this TCP communication is simply based
531     That way LinuxSampler is only able to answer on queries from     on query and answer paradigm.  That way LinuxSampler is only able to
532     front-ends, but not able to automatically send messages to the client     answer on queries from front-ends, but not able to automatically send
533     if it's not asked to.  The fronted should not reconnect to     messages to the client if it's not asked to.  The fronted should not
534     LinuxSampler for every single command, instead it should keep the     reconnect to LinuxSampler for every single command, instead it should
535     connection established and simply resend message(s) for subsequent     keep the connection established and simply resend message(s) for
536     commands.  To keep information in the front-end up-to-date the     subsequent commands.  To keep information in the front-end up-to-date
537     front-end has to periodically send new requests to get the current     the front-end has to periodically send new requests to get the
538     information from the LinuxSampler instance.  This is often referred     current information from the LinuxSampler instance.  This is often
539     to as "polling".  While polling is simple to implement and may be OK     referred to as "polling".  While polling is simple to implement and
540     to use in some cases, there may be disadvantages to polling such as     may be OK to use in some cases, there may be disadvantages to polling
541     network traffic overhead and information being out of date.  It is     such as network traffic overhead and information being out of date.
542     possible for a client or several clients to open more than one     It is possible for a client or several clients to open more than one
543     connection to the server at the same time.  It is also possible to     connection to the server at the same time.  It is also possible to
544     send more than one request to the server at the same time but if     send more than one request to the server at the same time but if
545     those requests are sent over the same connection server MUST execute     those requests are sent over the same connection server MUST execute
# Line 388  Internet-Draft       LinuxSampler Contro Line 556  Internet-Draft       LinuxSampler Contro
556    
557    
558    
559  Schoenebeck            Expires November 19, 2005                [Page 7]  Schoenebeck             Expires December 24, 2007              [Page 10]
560    
561  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
562    
563    
564  4.1.1  Result format  5.1.1.  Result format
565    
566     Result set could be one of the following types:     Result set could be one of the following types:
567    
568     1.  Normal     1.  Normal
569    
570     2.  Warning     2.  Warning
571    
572     3.  Error     3.  Error
573    
574     Warning and Error result sets MUST be single line and have the     Warning and Error result sets MUST be single line and have the
575     following format:     following format:
576    
577     o  "WRN:<warning-code>:<warning-message>"     o  "WRN:<warning-code>:<warning-message>"
578    
579     o  "ERR:<error-code>:<error-message>"     o  "ERR:<error-code>:<error-message>"
580    
581     Where <warning-code> and <error-code> are numeric unique identifiers     Where <warning-code> and <error-code> are numeric unique identifiers
# Line 414  Internet-Draft       LinuxSampler Contro Line 585  Internet-Draft       LinuxSampler Contro
585     Examples:     Examples:
586    
587        C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0        C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
588    
589        S: "WRN:32:This is a 24 bit patch which is not supported natively        S: "WRN:32:This is a 24 bit patch which is not supported natively
590        yet."        yet."
591    
592        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
593    
594        S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter        S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter
595        'EAR'."        'EAR'."
596    
597        C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"        C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
598    
599        S: "ERR:9:There is no audio output device with index 123456."        S: "ERR:9:There is no audio output device with index 123456."
600    
601     Normal result sets could be:     Normal result sets could be:
602    
603     1.  Empty     1.  Empty
604    
605     2.  Single line     2.  Single line
606    
607     3.  Multi-line     3.  Multi-line
608    
609     Empty result set is issued when the server only needed to acknowledge     Empty result set is issued when the server only needed to acknowledge
610     the fact that the request was received and it was processed     the fact that the request was received and it was processed
611     successfully and no additional information is available.  This result     successfully and no additional information is available.  This result
    set has the following format:  
612    
       "OK"  
613    
    Example:  
614    
615        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"  Schoenebeck             Expires December 24, 2007              [Page 11]
616    
617    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
618    
619    
620       set has the following format:
621    
622          "OK"
623    
624  Schoenebeck            Expires November 19, 2005                [Page 8]     Example:
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
625    
626          C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
627    
628        S: "OK"        S: "OK"
629    
# Line 461  Internet-Draft       LinuxSampler Contro Line 637  Internet-Draft       LinuxSampler Contro
637     Example:     Example:
638    
639        C: "GET AUDIO_OUTPUT_DEVICE INFO 0"        C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
640    
641        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
642    
643           "CHANNELS: 2"           "CHANNELS: 2"
644    
645           "SAMPLERATE: 44100"           "SAMPLERATE: 44100"
646    
647           "ACTIVE: true"           "ACTIVE: true"
648    
649           "FRAGMENTS: 2"           "FRAGMENTS: 2"
650    
651           "FRAGMENTSIZE: 128"           "FRAGMENTSIZE: 128"
652    
653           "CARD: '0,0'"           "CARD: '0,0'"
654    
655           "."           "."
656    
657     In addition to above mentioned formats, warnings and empty result     In addition to above mentioned formats, warnings and empty result
# Line 475  Internet-Draft       LinuxSampler Contro Line 659  Internet-Draft       LinuxSampler Contro
659     respectively:     respectively:
660    
661     o  "WRN[<index>]:<warning-code>:<warning-message>"     o  "WRN[<index>]:<warning-code>:<warning-message>"
662    
663     o  "OK[<index>]"     o  "OK[<index>]"
664    
665     where <index> is command specific and is used to indicate channel     where <index> is command specific and is used to indicate channel
666     number that the result set was related to or other integer value.     number that the result set was related to or other integer value.
667    
668    
669    
670    
671    Schoenebeck             Expires December 24, 2007              [Page 12]
672    
673    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
677    
678     Examples:     Examples:
679    
680        C: "ADD CHANNEL"        C: "ADD CHANNEL"
681    
682        S: "OK[12]"        S: "OK[12]"
683    
684        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
685    
686        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
687    
688  4.2  Subscribe/notify communication method  5.2.  Subscribe/notify communication method
689    
690     This more sophisticated communication method is actually only an     This more sophisticated communication method is actually only an
691     extension of the simple request/response communication method.  The     extension of the simple request/response communication method.  The
692     front-end still uses a TCP connection and sends the same commands on     front-end still uses a TCP connection and sends the same commands on
693     the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE     the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE
694     commands that allow a client to tell the server that it is interested     commands that allow a client to tell the server that it is interested
   
   
   
 Schoenebeck            Expires November 19, 2005                [Page 9]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
695     in receiving notifications about certain events as they happen on the     in receiving notifications about certain events as they happen on the
696     server.  The SUBSCRIBE command has the following syntax:     server.  The SUBSCRIBE command has the following syntax:
697    
# Line 527  Internet-Draft       LinuxSampler Contro Line 714  Internet-Draft       LinuxSampler Contro
714    
715     1.  Events MUST NOT be sent to any client who has not issued an     1.  Events MUST NOT be sent to any client who has not issued an
716         appropriate SUBSCRIBE command.         appropriate SUBSCRIBE command.
717    
718     2.  Events MUST only be sent using the same connection that was used     2.  Events MUST only be sent using the same connection that was used
719         to subscribe to them.         to subscribe to them.
720    
721     3.  When response is being sent to the client, event MUST be inserted     3.  When response is being sent to the client, event MUST be inserted
722         in the stream before or after the response, but NOT in the         in the stream before or after the response, but NOT in the
723         middle.  Same is true about the response.  It should never be         middle.  Same is true about the response.  It should never be
724    
725    
726    
727    Schoenebeck             Expires December 24, 2007              [Page 13]
728    
729    Internet-Draft    LinuxSampler Control Protocol (draft)        June 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
733         response.         response.
734    
# Line 542  Internet-Draft       LinuxSampler Contro Line 739  Internet-Draft       LinuxSampler Contro
739    
740     where <event-id> will be replace by the respective event that client     where <event-id> will be replace by the respective event that client
741     is no longer interested in receiving.  For a list of supported events     is no longer interested in receiving.  For a list of supported events
742     see Section 7.     see Section 8.
743    
744     Example: the fill states of disk stream buffers have changed on     Example: the fill states of disk stream buffers have changed on
745     sampler channel 4 and the LinuxSampler instance will react by sending     sampler channel 4 and the LinuxSampler instance will react by sending
# Line 554  Internet-Draft       LinuxSampler Contro Line 751  Internet-Draft       LinuxSampler Contro
751     channel 4, where the stream with ID "35" is filled by 62%, stream     channel 4, where the stream with ID "35" is filled by 62%, stream
752     with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.     with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.
753    
   
   
 Schoenebeck            Expires November 19, 2005               [Page 10]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
754     Clients may choose to open more than one connection to the server and     Clients may choose to open more than one connection to the server and
755     use some connections to receive notifications while using other     use some connections to receive notifications while using other
756     connections to issue commands to the back-end.  This is entirely     connections to issue commands to the back-end.  This is entirely
# Line 590  Internet-Draft       LinuxSampler Contro Line 780  Internet-Draft       LinuxSampler Contro
780    
781    
782    
783    Schoenebeck             Expires December 24, 2007              [Page 14]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 11]  
784    
785  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
786    
787    
788  5.  Description for control commands  6.  Description for control commands
789    
790     This chapter will describe the available control commands that can be     This chapter will describe the available control commands that can be
791     sent on the TCP connection in detail.  Some certain commands (e.g.     sent on the TCP connection in detail.  Some certain commands (e.g.
792     "GET CHANNEL INFO" (Section 5.4.10) or "GET ENGINE INFO" (Section     "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO"
793     5.4.9)) lead to multiple-line responses.  In this case LinuxSampler     (Section 6.4.9)) lead to multiple-line responses.  In this case
794     signals the end of the response by a "." (single dot) line.     LinuxSampler signals the end of the response by a "." (single dot)
795       line.
796    
797  5.1  Ignored lines and comments  6.1.  Ignored lines and comments
798    
799     White lines, that is lines which only contain space and tabulator     White lines, that is lines which only contain space and tabulator
800     characters, and lines that start with a "#" character are ignored,     characters, and lines that start with a "#" character are ignored,
801     thus it's possible for example to group commands and to place     thus it's possible for example to group commands and to place
802     comments in a LSCP script file.     comments in a LSCP script file.
803    
804  5.2  Configuring audio drivers  6.2.  Configuring audio drivers
805    
806     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
807     multiple audio devices simultaneously, e.g.  to output the sound of     multiple audio devices simultaneously, e.g. to output the sound of
808     one sampler channel using the ALSA audio output driver, and on     one sampler channel using the ALSA audio output driver, and on
809     another sampler channel you might want to use the JACK audio output     another sampler channel you might want to use the JACK audio output
810     driver.  For particular audio output systems it's also possible to     driver.  For particular audio output systems it's also possible to
811     create several devices of the same audio output driver, e.g.  two     create several devices of the same audio output driver, e.g. two
812     separate ALSA audio output devices for using two different sound     separate ALSA audio output devices for using two different sound
813     cards at the same time.  This chapter describes all commands to     cards at the same time.  This chapter describes all commands to
814     configure LinuxSampler's audio output devices and their parameters.     configure LinuxSampler's audio output devices and their parameters.
# Line 649  Internet-Draft       LinuxSampler Contro Line 818  Internet-Draft       LinuxSampler Contro
818     values have to be obtained at runtime.  This makes the protocol a bit     values have to be obtained at runtime.  This makes the protocol a bit
819     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
820     independently of what drivers are currently implemented and what     independently of what drivers are currently implemented and what
821     parameters these drivers are actually offering.  This means     parameters these drivers are actually offering.  This means front-
822     front-ends can even handle drivers which are implemented somewhere in     ends can even handle drivers which are implemented somewhere in
823     future without modifying the front-end at all.     future without modifying the front-end at all.
824    
825     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 661  Internet-Draft       LinuxSampler Contro Line 830  Internet-Draft       LinuxSampler Contro
830     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
831     possible values, etc.     possible values, etc.
832    
 5.2.1  Getting amount of available audio output drivers  
833    
    Use the following command to get the number of audio output drivers  
    currently available for the LinuxSampler instance:  
834    
835    
836    
837  Schoenebeck            Expires November 19, 2005               [Page 12]  
838    
839    Schoenebeck             Expires December 24, 2007              [Page 15]
840    
841  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
842    
843    
844    6.2.1.  Getting amount of available audio output drivers
845    
846       Use the following command to get the number of audio output drivers
847       currently available for the LinuxSampler instance:
848    
849        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
850    
# Line 683  Internet-Draft       LinuxSampler Contro Line 856  Internet-Draft       LinuxSampler Contro
856     Example:     Example:
857    
858        C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"        C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
859    
860        S: "2"        S: "2"
861    
862  5.2.2  Getting all available audio output drivers  6.2.2.  Getting all available audio output drivers
863    
864     Use the following command to list all audio output drivers currently     Use the following command to list all audio output drivers currently
865     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 700  Internet-Draft       LinuxSampler Contro Line 874  Internet-Draft       LinuxSampler Contro
874     Example:     Example:
875    
876        C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"        C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
877    
878        S: "ALSA,JACK"        S: "ALSA,JACK"
879    
880  5.2.3  Getting information about a specific audio output driver  6.2.3.  Getting information about a specific audio output driver
881    
882     Use the following command to get detailed information about a     Use the following command to get detailed information about a
883     specific audio output driver:     specific audio output driver:
# Line 710  Internet-Draft       LinuxSampler Contro Line 885  Internet-Draft       LinuxSampler Contro
885        GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>        GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>
886    
887     Where <audio-output-driver> is the name of the audio output driver,     Where <audio-output-driver> is the name of the audio output driver,
888     returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)     returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
889     command.     command.
890    
891     Possible Answers:     Possible Answers:
892    
893    
894    
895    Schoenebeck             Expires December 24, 2007              [Page 16]
896    
897    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
901        answer line begins with the information category name followed by        answer line begins with the information category name followed by
902        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 723  Internet-Draft       LinuxSampler Contro Line 905  Internet-Draft       LinuxSampler Contro
905    
906    
907    
   
 Schoenebeck            Expires November 19, 2005               [Page 13]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
908           DESCRIPTION -           DESCRIPTION -
909    
910              character string describing the audio output driver              character string describing the audio output driver
911    
912           VERSION -           VERSION -
913    
914              character string reflecting the driver's version              character string reflecting the driver's version
915    
916           PARAMETERS -           PARAMETERS -
917    
918              comma separated list of all parameters available for the              comma separated list of all parameters available for the
919              given audio output driver, at least parameters 'channels',              given audio output driver, at least parameters 'channels',
920              'samplerate' and 'active' are offered by all audio output              'samplerate' and 'active' are offered by all audio output
921              drivers              drivers
922    
923        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
924    
925     Example:     Example:
926    
927        C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"        C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
928    
929        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
930    
931           "VERSION: 1.0"           "VERSION: 1.0"
932    
933           "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,           "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
934        FRAGMENTSIZE,CARD"        FRAGMENTSIZE,CARD"
935    
936           "."           "."
937    
938  5.2.4  Getting information about specific audio output driver parameter  6.2.4.  Getting information about specific audio output driver parameter
939    
940     Use the following command to get detailed information about a     Use the following command to get detailed information about a
941     specific audio output driver parameter:     specific audio output driver parameter:
# Line 758  Internet-Draft       LinuxSampler Contro Line 943  Internet-Draft       LinuxSampler Contro
943        GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]        GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]
944    
945     Where <audio> is the name of the audio output driver as returned by     Where <audio> is the name of the audio output driver as returned by
946     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2) command,     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
947     <prm> a specific parameter name for which information should be     <prm> a specific parameter name for which information should be
948     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" (Section  
949     5.2.3) command) and <deplist> is an optional list of parameters on  
950     which the sought parameter <prm> depends on, <deplist> is a list of  
951     key-value pairs in form of "key1=val1 key2=val2 ...", where character  Schoenebeck             Expires December 24, 2007              [Page 17]
952     string values are encapsulated into apostrophes (').  Arguments given  
953     with <deplist> which are not dependency parameters of <prm> will be  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
954     ignored, means the front-end application can simply put all  
955     parameters into <deplist> with the values already selected by the  
956       obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
957       (Section 6.2.3) command) and <deplist> is an optional list of
958       parameters on which the sought parameter <prm> depends on, <deplist>
959       is a list of key-value pairs in form of "key1=val1 key2=val2 ...",
960       where character string values are encapsulated into apostrophes (').
961       Arguments given with <deplist> which are not dependency parameters of
962       <prm> will be ignored, means the front-end application can simply put
963       all parameters into <deplist> with the values already selected by the
964     user.     user.
965    
966     Possible Answers:     Possible Answers:
# Line 777  Internet-Draft       LinuxSampler Contro Line 970  Internet-Draft       LinuxSampler Contro
970        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
971        character string to that info category.  There are information        character string to that info category.  There are information
972        which is always returned, independently of the given driver        which is always returned, independently of the given driver
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 14]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
973        parameter and there are optional information which is only shown        parameter and there are optional information which is only shown
974        dependently to given driver parameter.  At the moment the        dependently to given driver parameter.  At the moment the
975        following information categories are defined:        following information categories are defined:
976    
977        TYPE -        TYPE -
978    
979           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
980           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
981           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
982           parameter)           parameter)
983    
984        DESCRIPTION -        DESCRIPTION -
985    
986           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
987           returned, no matter which driver parameter)           returned, no matter which driver parameter)
988    
989        MANDATORY -        MANDATORY -
990    
991           either true or false, defines if this parameter must be given           either true or false, defines if this parameter must be given
992           when the device is to be created with the 'CREATE           when the device is to be created with the 'CREATE
993           AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,           AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
994           no matter which driver parameter)           no matter which driver parameter)
995    
996        FIX -        FIX -
997    
998           either true or false, if false then this parameter can be           either true or false, if false then this parameter can be
999           changed at any time, once the device is created by the 'CREATE           changed at any time, once the device is created by the 'CREATE
1000           AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,           AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
1001           no matter which driver parameter)           no matter which driver parameter)
1002    
1003    
1004    
1005    
1006    
1007    Schoenebeck             Expires December 24, 2007              [Page 18]
1008    
1009    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
1013    
1014           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
1015           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
1016           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
1017           which driver parameter)           which driver parameter)
1018    
1019        DEPENDS -        DEPENDS -
1020    
1021           comma separated list of parameters this parameter depends on,           comma separated list of parameters this parameter depends on,
1022           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1023           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
# Line 822  Internet-Draft       LinuxSampler Contro Line 1027  Internet-Draft       LinuxSampler Contro
1027           possible values for 'samplerate' depends on the sound card           possible values for 'samplerate' depends on the sound card
1028           which can be chosen by the 'card' parameter (optionally           which can be chosen by the 'card' parameter (optionally
1029           returned, dependent to driver parameter)           returned, dependent to driver parameter)
1030    
1031        DEFAULT -        DEFAULT -
1032    
1033           reflects the default value for this parameter which is used           reflects the default value for this parameter which is used
1034           when the device is created and not explicitly given with the           when the device is created and not explicitly given with the
1035           'CREATE AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command, in case           'CREATE AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command, in case
1036           of MULTIPLCITY=true, this is a comma separated list, that's why           of MULTIPLCITY=true, this is a comma separated list, that's why
1037           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
1038           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
1039    
1040        RANGE_MIN -        RANGE_MIN -
1041    
1042           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
1043           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1044           this parameter is often used in conjunction with RANGE_MAX, but           this parameter is often used in conjunction with RANGE_MAX, but
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 15]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1045           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1046           driver parameter)           driver parameter)
1047    
1048        RANGE_MAX -        RANGE_MAX -
1049    
1050           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1051           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1052           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
1053           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1054           driver parameter)           driver parameter)
1055    
1056        POSSIBILITIES -        POSSIBILITIES -
1057    
1058           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
1059           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
1060    
1061    
1062    
1063    Schoenebeck             Expires December 24, 2007              [Page 19]
1064    
1065    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
1069    
1070     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 859  Internet-Draft       LinuxSampler Contro Line 1072  Internet-Draft       LinuxSampler Contro
1072     Examples:     Examples:
1073    
1074        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
1075    
1076        S: "DESCRIPTION: sound card to be used"        S: "DESCRIPTION: sound card to be used"
1077    
1078           "TYPE: STRING"           "TYPE: STRING"
1079    
1080           "MANDATORY: false"           "MANDATORY: false"
1081    
1082           "FIX: true"           "FIX: true"
1083    
1084           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1085    
1086           "DEFAULT: '0,0'"           "DEFAULT: '0,0'"
1087    
1088           "POSSIBILITIES: '0,0','1,0','2,0'"           "POSSIBILITIES: '0,0','1,0','2,0'"
1089    
1090           "."           "."
1091    
1092        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
1093    
1094        S: "DESCRIPTION: output sample rate in Hz"        S: "DESCRIPTION: output sample rate in Hz"
1095    
1096           "TYPE: INT"           "TYPE: INT"
1097    
1098           "MANDATORY: false"           "MANDATORY: false"
1099    
1100           "FIX: false"           "FIX: false"
1101    
1102           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1103    
1104           "DEPENDS: card"           "DEPENDS: card"
1105    
1106           "DEFAULT: 44100"           "DEFAULT: 44100"
1107    
1108           "."           "."
1109    
1110        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE
1111        CARD='0,0'"        CARD='0,0'"
1112    
1113        S: "DESCRIPTION: output sample rate in Hz"        S: "DESCRIPTION: output sample rate in Hz"
1114    
1115    
1116    
1117    
1118    
1119    Schoenebeck             Expires December 24, 2007              [Page 20]
1120    
1121    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
1125    
1126           "MANDATORY: false"           "MANDATORY: false"
          "FIX: false"  
          "MULTIPLICITY: false"  
          "DEPENDS: card"  
          "DEFAULT: 44100"  
          "RANGE_MIN: 22050"  
1127    
1128             "FIX: false"
1129    
1130             "MULTIPLICITY: false"
1131    
1132             "DEPENDS: card"
1133    
1134  Schoenebeck            Expires November 19, 2005               [Page 16]           "DEFAULT: 44100"
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
1135    
1136             "RANGE_MIN: 22050"
1137    
1138           "RANGE_MAX: 96000"           "RANGE_MAX: 96000"
1139    
1140           "."           "."
1141    
1142  5.2.5  Creating an audio output device  6.2.5.  Creating an audio output device
1143    
1144     Use the following command to create a new audio output device for     Use the following command to create a new audio output device for the
1145     the desired audio output system:     desired audio output system:
1146    
1147        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
1148    
1149     Where <audio-output-driver> should be replaced by the desired audio     Where <audio-output-driver> should be replaced by the desired audio
1150     output system and <param-list> by an optional list of driver specific     output system as returned by the "LIST
1151     parameters in form of "key1=val1 key2=val2 ...", where character     AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and <param-
1152     string values should be encapsulated into apostrophes (').  Note that     list> by an optional list of driver specific parameters in form of
1153     there might be drivers which require parameter(s) to be given with     "key1=val1 key2=val2 ...", where character string values should be
1154     this command.  Use the previously described commands in this chapter     encapsulated into apostrophes (').  Note that there might be drivers
1155     to get this information.     which require parameter(s) to be given with this command.  Use the
1156       previously described commands in this chapter to get this
1157       information.
1158    
1159     Possible Answers:     Possible Answers:
1160    
1161        "OK[<device-id>]" -        "OK[<device-id>]" -
1162    
1163           in case the device was successfully created, where <device-id>           in case the device was successfully created, where <device-id>
1164           is the numerical ID of the new device           is the numerical ID of the new device
1165    
1166        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1167    
1168           in case the device was created successfully, where <device-id>           in case the device was created successfully, where <device-id>
1169           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1170           issue(s) related (e.g.  sound card doesn't support given           issue(s) related (e.g. sound card doesn't support given
1171           hardware parameters and the driver is using fall-back values),           hardware parameters and the driver is using fall-back values),
1172    
1173    
1174    
1175    Schoenebeck             Expires December 24, 2007              [Page 21]
1176    
1177    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
1181    
1182        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1183    
1184           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1185           error message           error message
1186    
1187     Examples:     Examples:
1188    
1189        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
1190    
1191        S: "OK[0]"        S: "OK[0]"
1192    
1193        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
1194    
1195        S: "OK[1]"        S: "OK[1]"
1196    
1197  5.2.6  Destroying an audio output device  6.2.6.  Destroying an audio output device
1198    
1199     Use the following command to destroy a created output device:     Use the following command to destroy a created output device:
1200    
1201        DESTROY AUDIO_OUTPUT_DEVICE <device-id>        DESTROY AUDIO_OUTPUT_DEVICE <device-id>
1202    
1203     Where <device-id> should be replaced by the numerical ID of the audio     Where <device-id> should be replaced by the numerical ID of the audio
1204       output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1205       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1206       command.
 Schoenebeck            Expires November 19, 2005               [Page 17]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
    output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section  
    5.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 5.2.8) command.  
1207    
1208     Possible Answers:     Possible Answers:
1209    
1210        "OK" -        "OK" -
1211    
1212           in case the device was successfully destroyed           in case the device was successfully destroyed
1213    
1214        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1215    
1216           in case the device was destroyed successfully, but there are           in case the device was destroyed successfully, but there are
1217           noteworthy issue(s) related (e.g.  an audio over ethernet           noteworthy issue(s) related (e.g. an audio over ethernet driver
1218           driver was unloaded but the other host might not be informed           was unloaded but the other host might not be informed about
1219           about this situation), providing an appropriate warning code           this situation), providing an appropriate warning code and
1220           and warning message           warning message
1221    
1222        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1223    
1224           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1225           error message           error message
1226    
1227     Example:     Example:
1228    
1229    
1230    
1231    Schoenebeck             Expires December 24, 2007              [Page 22]
1232    
1233    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1237    
1238        S: "OK"        S: "OK"
1239    
1240  5.2.7  Getting all created audio output device count  6.2.7.  Getting all created audio output device count
1241    
1242     Use the following command to count all created audio output devices:     Use the following command to count all created audio output devices:
1243    
# Line 989  Internet-Draft       LinuxSampler Contro Line 1251  Internet-Draft       LinuxSampler Contro
1251     Example:     Example:
1252    
1253        C: "GET AUDIO_OUTPUT_DEVICES"        C: "GET AUDIO_OUTPUT_DEVICES"
1254    
1255        S: "4"        S: "4"
1256    
1257  5.2.8  Getting all created audio output device list  6.2.8.  Getting all created audio output device list
1258    
1259     Use the following command to list all created audio output devices:     Use the following command to list all created audio output devices:
1260    
# Line 1002  Internet-Draft       LinuxSampler Contro Line 1265  Internet-Draft       LinuxSampler Contro
1265        LinuxSampler will answer by sending a comma separated list with        LinuxSampler will answer by sending a comma separated list with
1266        the numerical IDs of all audio output devices.        the numerical IDs of all audio output devices.
1267    
   
   
 Schoenebeck            Expires November 19, 2005               [Page 18]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1268     Example:     Example:
1269    
1270        C: "LIST AUDIO_OUTPUT_DEVICES"        C: "LIST AUDIO_OUTPUT_DEVICES"
1271    
1272        S: "0,1,4,5"        S: "0,1,4,5"
1273    
1274  5.2.9  Getting current settings of an audio output device  6.2.9.  Getting current settings of an audio output device
1275    
1276     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
1277     created audio output device:     created audio output device:
# Line 1022  Internet-Draft       LinuxSampler Contro Line 1279  Internet-Draft       LinuxSampler Contro
1279        GET AUDIO_OUTPUT_DEVICE INFO <device-id>        GET AUDIO_OUTPUT_DEVICE INFO <device-id>
1280    
1281     Where <device-id> should be replaced by numerical ID of the audio     Where <device-id> should be replaced by numerical ID of the audio
1282     output device as e.g.  returned by the "LIST AUDIO_OUTPUT_DEVICES"     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
1283     (Section 5.2.8) command.     (Section 6.2.8) command.
1284    
1285    
1286    
1287    Schoenebeck             Expires December 24, 2007              [Page 23]
1288    
1289    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
1293    
# Line 1036  Internet-Draft       LinuxSampler Contro Line 1300  Internet-Draft       LinuxSampler Contro
1300     (independently of device):     (independently of device):
1301    
1302        DRIVER -        DRIVER -
1303    
1304           identifier of the used audio output driver, as also returned by           identifier of the used audio output driver, as also returned by
1305           the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)           the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
1306           command           command
1307    
1308        CHANNELS -        CHANNELS -
1309    
1310           amount of audio output channels this device currently offers           amount of audio output channels this device currently offers
1311    
1312        SAMPLERATE -        SAMPLERATE -
1313    
1314           playback sample rate the device uses           playback sample rate the device uses
1315    
1316        ACTIVE -        ACTIVE -
1317    
1318           either true or false, if false then the audio device is           either true or false, if false then the audio device is
1319           inactive and doesn't output any sound, nor do the sampler           inactive and doesn't output any sound, nor do the sampler
1320           channels connected to this audio device render any audio           channels connected to this audio device render any audio
# Line 1051  Internet-Draft       LinuxSampler Contro Line 1322  Internet-Draft       LinuxSampler Contro
1322     The mentioned fields above don't have to be in particular order.  The     The mentioned fields above don't have to be in particular order.  The
1323     fields above are only those fields which are returned by all audio     fields above are only those fields which are returned by all audio
1324     output devices.  Every audio output driver might have its own,     output devices.  Every audio output driver might have its own,
1325     additional driver specific parameters (see Section 5.2.3) which are     additional driver specific parameters (see Section 6.2.3) which are
1326     also returned by this command.     also returned by this command.
1327    
1328     Example:     Example:
1329    
1330          C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
1331    
1332          S: "DRIVER: ALSA"
1333    
1334             "CHANNELS: 2"
1335    
1336             "SAMPLERATE: 44100"
1337    
1338             "ACTIVE: true"
1339    
1340    
1341    
1342    
1343  Schoenebeck            Expires November 19, 2005               [Page 19]  Schoenebeck             Expires December 24, 2007              [Page 24]
1344    
1345  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1346    
1347    
       C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  
       S: "DRIVER: ALSA"  
          "CHANNELS: 2"  
          "SAMPLERATE: 44100"  
          "ACTIVE: true"  
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
1349    
1350           "FRAGMENTSIZE: 128"           "FRAGMENTSIZE: 128"
1351    
1352           "CARD: '0,0'"           "CARD: '0,0'"
1353    
1354           "."           "."
1355    
1356  5.2.10  Changing settings of audio output devices  6.2.10.  Changing settings of audio output devices
1357    
1358     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
1359     audio output device:     audio output device:
# Line 1083  Internet-Draft       LinuxSampler Contro Line 1361  Internet-Draft       LinuxSampler Contro
1361        SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>        SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>
1362    
1363     Where <device-id> should be replaced by the numerical ID of the audio     Where <device-id> should be replaced by the numerical ID of the audio
1364     output device, <key> by the name of the parameter to change and     output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1365     <value> by the new value for this parameter.     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1366       command, <key> by the name of the parameter to change and <value> by
1367       the new value for this parameter.
1368    
1369     Possible Answers:     Possible Answers:
1370    
1371        "OK" -        "OK" -
1372    
1373           in case setting was successfully changed           in case setting was successfully changed
1374    
1375        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1376    
1377           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
1378           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
1379           code and warning message           code and warning message
1380    
1381        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1382    
1383           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1384           error message           error message
1385    
1386     Example:     Example:
1387    
1388        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1389    
1390        S: "OK"        S: "OK"
1391    
 5.2.11  Getting information about an audio channel  
1392    
    Use the following command to get information about an audio channel:  
1393    
       GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>  
1394    
    Where <device-id> is the numerical ID of the audio output device and  
    <audio-chan> the audio channel number.  
1395    
    Possible Answers:  
1396    
1397    
1398    
1399  Schoenebeck            Expires November 19, 2005               [Page 20]  Schoenebeck             Expires December 24, 2007              [Page 25]
1400    
1401  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1402    
1403    
1404    6.2.11.  Getting information about an audio channel
1405    
1406       Use the following command to get information about an audio channel:
1407    
1408          GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1409    
1410       Where <device-id> is the numerical ID of the audio output device as
1411       given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1412       AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command and <audio-chan> the
1413       audio channel number.
1414    
1415       Possible Answers:
1416    
1417        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
1418        answer line begins with the information category name followed by        answer line begins with the information category name followed by
# Line 1127  Internet-Draft       LinuxSampler Contro Line 1420  Internet-Draft       LinuxSampler Contro
1420        character string to that info category.  At the moment the        character string to that info category.  At the moment the
1421        following information categories are defined:        following information categories are defined:
1422    
1423    
1424    
1425           NAME -           NAME -
1426    
1427              arbitrary character string naming the channel, which doesn't              arbitrary character string naming the channel, which doesn't
1428              have to be unique (always returned by all audio channels)              have to be unique (always returned by all audio channels)
1429    
1430           IS_MIX_CHANNEL -           IS_MIX_CHANNEL -
1431    
1432              either true or false, a mix-channel is not a real,              either true or false, a mix-channel is not a real,
1433              independent audio channel, but a virtual channel which is              independent audio channel, but a virtual channel which is
1434              mixed to another real channel, this mechanism is needed for              mixed to another real channel, this mechanism is needed for
1435              sampler engines which need more audio channels than the used              sampler engines which need more audio channels than the used
1436              audio system might be able to offer (always returned by all              audio system might be able to offer (always returned by all
1437              audio channels)              audio channels)
1438    
1439           MIX_CHANNEL_DESTINATION -           MIX_CHANNEL_DESTINATION -
1440    
1441              numerical ID (positive integer including 0) which reflects              numerical ID (positive integer including 0) which reflects
1442              the real audio channel (of the same audio output device)              the real audio channel (of the same audio output device)
1443              this mix channel refers to, means where the audio signal              this mix channel refers to, means where the audio signal
# Line 1150  Internet-Draft       LinuxSampler Contro Line 1450  Internet-Draft       LinuxSampler Contro
1450     driver.  Every audio channel might have its own, additional driver     driver.  Every audio channel might have its own, additional driver
1451     and channel specific parameters.     and channel specific parameters.
1452    
1453    
1454    
1455    Schoenebeck             Expires December 24, 2007              [Page 26]
1456    
1457    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1458    
1459    
1460     Examples:     Examples:
1461    
1462        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1463    
1464        S: "NAME: studio monitor left"        S: "NAME: studio monitor left"
1465    
1466           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
1467    
1468           "."           "."
1469    
1470        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
1471    
1472        S: "NAME: studio monitor right"        S: "NAME: studio monitor right"
1473    
1474           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
          "."  
1475    
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"  
       S: "NAME: studio monitor left"  
          "IS_MIX_CHANNEL: true"  
          "MIX_CHANNEL_DESTINATION: 1"  
1476           "."           "."
1477    
1478          C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
1479    
1480          S: "NAME: studio monitor left"
1481    
1482             "IS_MIX_CHANNEL: true"
1483    
1484             "MIX_CHANNEL_DESTINATION: 1"
1485    
1486  Schoenebeck            Expires November 19, 2005               [Page 21]           "."
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
1487    
1488        C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
1489    
1490        S: "NAME: 'ardour (left)'"        S: "NAME: 'ardour (left)'"
1491    
1492           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
1493    
1494           "JACK_BINDINGS: 'ardour:0'"           "JACK_BINDINGS: 'ardour:0'"
1495    
1496           "."           "."
1497    
1498  5.2.12  Getting information about specific audio channel parameter  6.2.12.  Getting information about specific audio channel parameter
1499    
1500     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
1501     audio channel parameter:     audio channel parameter:
# Line 1191  Internet-Draft       LinuxSampler Contro Line 1503  Internet-Draft       LinuxSampler Contro
1503        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
1504    
1505     Where <dev-id> is the numerical ID of the audio output device as     Where <dev-id> is the numerical ID of the audio output device as
1506     returned by the "LIST AUDIO_OUTPUT_DEVICES" (Section 5.2.8) command,     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1507     <chan> the audio channel number and <param> a specific channel     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
1508     parameter name for which information should be obtained (as returned  
1509     by the "GET AUDIO_OUTPUT_CHANNEL INFO" (Section 5.2.11) command).  
1510    
1511    Schoenebeck             Expires December 24, 2007              [Page 27]
1512    
1513    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1514    
1515    
1516       channel number and <param> a specific channel parameter name for
1517       which information should be obtained (as returned by the "GET
1518       AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1519    
1520     Possible Answers:     Possible Answers:
1521    
# Line 1207  Internet-Draft       LinuxSampler Contro Line 1528  Internet-Draft       LinuxSampler Contro
1528        dependently to the given audio channel.  At the moment the        dependently to the given audio channel.  At the moment the
1529        following information categories are defined:        following information categories are defined:
1530    
1531    
1532    
1533           TYPE -           TYPE -
1534    
1535              either "BOOL" for boolean value(s) or "INT" for integer              either "BOOL" for boolean value(s) or "INT" for integer
1536              value(s) or "FLOAT" for dotted number(s) or "STRING" for              value(s) or "FLOAT" for dotted number(s) or "STRING" for
1537              character string(s) (always returned)              character string(s) (always returned)
1538    
1539           DESCRIPTION -           DESCRIPTION -
1540    
1541              arbitrary text describing the purpose of the parameter              arbitrary text describing the purpose of the parameter
1542              (always returned)              (always returned)
1543    
1544           FIX -           FIX -
1545    
1546              either true or false, if true then this parameter is read              either true or false, if true then this parameter is read
1547              only, thus cannot be altered (always returned)              only, thus cannot be altered (always returned)
1548    
1549           MULTIPLICITY -           MULTIPLICITY -
1550    
1551              either true or false, defines if this parameter allows only              either true or false, defines if this parameter allows only
1552              one value or a list of values, where true means multiple              one value or a list of values, where true means multiple
1553              values and false only a single value allowed (always              values and false only a single value allowed (always
1554              returned)              returned)
1555    
1556           RANGE_MIN -           RANGE_MIN -
1557    
1558              defines lower limit of the allowed value range for this              defines lower limit of the allowed value range for this
1559              parameter, can be an integer value as well as a dotted              parameter, can be an integer value as well as a dotted
1560                number, usually used in conjunction with 'RANGE_MAX', but
1561                may also appear without (optionally returned, dependent to
1562                driver and channel parameter)
1563    
1564    
1565    
1566    
1567  Schoenebeck            Expires November 19, 2005               [Page 22]  Schoenebeck             Expires December 24, 2007              [Page 28]
1568    
1569  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1570    
1571    
             number, usually used in conjunction with 'RANGE_MAX', but  
             may also appear without (optionally returned, dependent to  
             driver and channel parameter)  
1572           RANGE_MAX -           RANGE_MAX -
1573    
1574              defines upper limit of the allowed value range for this              defines upper limit of the allowed value range for this
1575              parameter, can be an integer value as well as a dotted              parameter, can be an integer value as well as a dotted
1576              number, usually used in conjunction with 'RANGE_MIN', but              number, usually used in conjunction with 'RANGE_MIN', but
1577              may also appear without (optionally returned, dependent to              may also appear without (optionally returned, dependent to
1578              driver and channel parameter)              driver and channel parameter)
1579    
1580           POSSIBILITIES -           POSSIBILITIES -
1581    
1582              comma separated list of possible values for this parameter,              comma separated list of possible values for this parameter,
1583              character strings are encapsulated into apostrophes              character strings are encapsulated into apostrophes
1584              (optionally returned, dependent to driver and channel              (optionally returned, dependent to driver and channel
1585              parameter)              parameter)
1586    
1587        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
1588    
1589     Example:     Example:
1590    
1591        C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"        C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
1592    
1593        S: "DESCRIPTION: bindings to other JACK clients"        S: "DESCRIPTION: bindings to other JACK clients"
1594    
1595           "TYPE: STRING"           "TYPE: STRING"
1596    
1597           "FIX: false"           "FIX: false"
1598    
1599           "MULTIPLICITY: true"           "MULTIPLICITY: true"
1600    
1601           "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"           "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
1602    
1603           "."           "."
1604    
1605  5.2.13  Changing settings of audio output channels  6.2.13.  Changing settings of audio output channels
1606    
1607     Use the following command to alter a specific setting of an audio     Use the following command to alter a specific setting of an audio
1608     output channel:     output channel:
# Line 1267  Internet-Draft       LinuxSampler Contro Line 1610  Internet-Draft       LinuxSampler Contro
1610        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
1611    
1612     Where <dev-id> should be replaced by the numerical ID of the audio     Where <dev-id> should be replaced by the numerical ID of the audio
1613     device, <chn> by the audio channel number, <key> by the name of the     output device as returned by the "CREATE AUDIO_OUTPUT_DEVICE"
1614       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1615       command, <chn> by the audio channel number, <key> by the name of the
1616     parameter to change and <value> by the new value for this parameter.     parameter to change and <value> by the new value for this parameter.
1617    
1618     Possible Answers:     Possible Answers:
1619    
1620    
1621    
1622    
1623    Schoenebeck             Expires December 24, 2007              [Page 29]
1624    
1625    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1626    
1627    
1628        "OK" -        "OK" -
1629    
1630           in case setting was successfully changed           in case setting was successfully changed
1631    
1632        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1633    
1634           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
1635           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
1636           code and warning message           code and warning message
1637    
1638        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1639    
1640           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1641           error message           error message
1642    
   
   
 Schoenebeck            Expires November 19, 2005               [Page 23]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1643     Example:     Example:
1644    
1645        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
1646    
1647        S: "OK"        S: "OK"
1648    
1649        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
1650    
1651        S: "OK"        S: "OK"
1652    
1653  5.3  Configuring MIDI input drivers  6.3.  Configuring MIDI input drivers
1654    
1655     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
1656     multiple MIDI devices simultaneously, e.g.  to use MIDI over ethernet     multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
1657     as MIDI input on one sampler channel and ALSA as MIDI input on     as MIDI input on one sampler channel and ALSA as MIDI input on
1658     another sampler channel.  For particular MIDI input systems it's also     another sampler channel.  For particular MIDI input systems it's also
1659     possible to create several devices of the same MIDI input type.  This     possible to create several devices of the same MIDI input type.  This
# Line 1312  Internet-Draft       LinuxSampler Contro Line 1665  Internet-Draft       LinuxSampler Contro
1665     values have to be obtained at runtime.  This makes the protocol a bit     values have to be obtained at runtime.  This makes the protocol a bit
1666     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
1667     independently of what drivers are currently implemented and what     independently of what drivers are currently implemented and what
1668     parameters these drivers are actually offering.  This means     parameters these drivers are actually offering.  This means front-
1669     front-ends can even handle drivers which are implemented somewhere in     ends can even handle drivers which are implemented somewhere in
1670     future without modifying the front-end at all.     future without modifying the front-end at all.
1671    
1672     Commands for configuring MIDI input devices are pretty much the same     Commands for configuring MIDI input devices are pretty much the same
1673     as the commands for configuring audio output drivers, already     as the commands for configuring audio output drivers, already
1674     described in the last chapter.     described in the last chapter.
1675    
1676    
1677    
1678    
1679    Schoenebeck             Expires December 24, 2007              [Page 30]
1680    
1681    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
1685     drivers are not meant as specification of the drivers' parameters.     drivers are not meant as specification of the drivers' parameters.
1686     Driver implementations in LinuxSampler might have complete different     Driver implementations in LinuxSampler might have complete different
# Line 1328  Internet-Draft       LinuxSampler Contro Line 1689  Internet-Draft       LinuxSampler Contro
1689     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
1690     possible values, etc.     possible values, etc.
1691    
1692  5.3.1  Getting amount of available MIDI input drivers  6.3.1.  Getting amount of available MIDI input drivers
1693    
1694     Use the following command to get the number of MIDI input drivers     Use the following command to get the number of MIDI input drivers
1695     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
# Line 1337  Internet-Draft       LinuxSampler Contro Line 1698  Internet-Draft       LinuxSampler Contro
1698    
1699     Possible Answers:     Possible Answers:
1700    
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 24]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1701        LinuxSampler will answer by sending the number of available MIDI        LinuxSampler will answer by sending the number of available MIDI
1702        input drivers.        input drivers.
1703    
1704     Example:     Example:
1705    
1706        C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"        C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
1707    
1708        S: "2"        S: "2"
1709    
1710  5.3.2  Getting all available MIDI input drivers  6.3.2.  Getting all available MIDI input drivers
1711    
1712     Use the following command to list all MIDI input drivers currently     Use the following command to list all MIDI input drivers currently
1713     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 1368  Internet-Draft       LinuxSampler Contro Line 1722  Internet-Draft       LinuxSampler Contro
1722     Example:     Example:
1723    
1724        C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"        C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1725    
1726        S: "ALSA,JACK"        S: "ALSA,JACK"
1727    
1728  5.3.3  Getting information about a specific MIDI input driver  
1729    
1730    
1731    
1732    
1733    
1734    
1735    Schoenebeck             Expires December 24, 2007              [Page 31]
1736    
1737    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1738    
1739    
1740    6.3.3.  Getting information about a specific MIDI input driver
1741    
1742     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1743     specific MIDI input driver:     specific MIDI input driver:
1744    
1745        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1746    
1747     Where <midi-input-driver> is the name of the MIDI input driver.     Where <midi-input-driver> is the name of the MIDI input driver as
1748       returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
1749       command.
1750    
1751     Possible Answers:     Possible Answers:
1752    
# Line 1387  Internet-Draft       LinuxSampler Contro Line 1756  Internet-Draft       LinuxSampler Contro
1756        character string to that info category.  At the moment the        character string to that info category.  At the moment the
1757        following information categories are defined:        following information categories are defined:
1758    
          DESCRIPTION -  
             arbitrary description text about the MIDI input driver  
          VERSION -  
             arbitrary character string regarding the driver's version  
          PARAMETERS -  
1759    
1760    
1761             DESCRIPTION -
1762    
1763                arbitrary description text about the MIDI input driver
1764    
1765  Schoenebeck            Expires November 19, 2005               [Page 25]           VERSION -
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
1766    
1767                arbitrary character string regarding the driver's version
1768    
1769             PARAMETERS -
1770    
1771              comma separated list of all parameters available for the              comma separated list of all parameters available for the
1772              given MIDI input driver              given MIDI input driver
1773    
1774        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
1775    
1776     Example:     Example:
1777    
1778        C: "GET MIDI_INPUT_DRIVER INFO ALSA"        C: "GET MIDI_INPUT_DRIVER INFO ALSA"
1779    
1780        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
1781    
1782           "VERSION: 1.0"           "VERSION: 1.0"
1783    
1784           "PARAMETERS: DRIVER,ACTIVE"           "PARAMETERS: DRIVER,ACTIVE"
1785    
1786           "."           "."
1787    
1788  5.3.4  Getting information about specific MIDI input driver parameter  
1789    
1790    
1791    Schoenebeck             Expires December 24, 2007              [Page 32]
1792    
1793    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1794    
1795    
1796    6.3.4.  Getting information about specific MIDI input driver parameter
1797    
1798     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1799     specific parameter of a specific MIDI input driver:     specific parameter of a specific MIDI input driver:
# Line 1421  Internet-Draft       LinuxSampler Contro Line 1801  Internet-Draft       LinuxSampler Contro
1801        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1802    
1803     Where <midit> is the name of the MIDI input driver as returned by the     Where <midit> is the name of the MIDI input driver as returned by the
1804     "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2) command, <param>     "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2) command, <param>
1805     a specific parameter name for which information should be obtained     a specific parameter name for which information should be obtained
1806     (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 5.3.3)     (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 6.3.3)
1807     command) and <deplist> is an optional list of parameters on which the     command) and <deplist> is an optional list of parameters on which the
1808     sought parameter <param> depends on, <deplist> is a key-value pair     sought parameter <param> depends on, <deplist> is a key-value pair
1809     list in form of "key1=val1 key2=val2 ...", where character string     list in form of "key1=val1 key2=val2 ...", where character string
# Line 1444  Internet-Draft       LinuxSampler Contro Line 1824  Internet-Draft       LinuxSampler Contro
1824     defined:     defined:
1825    
1826        TYPE -        TYPE -
1827    
1828           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
1829           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
1830           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
1831           parameter)           parameter)
1832    
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 26]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1833        DESCRIPTION -        DESCRIPTION -
1834    
1835           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
1836           returned, no matter which driver parameter)           returned, no matter which driver parameter)
1837    
1838        MANDATORY -        MANDATORY -
1839    
1840           either true or false, defines if this parameter must be given           either true or false, defines if this parameter must be given
1841           when the device is to be created with the 'CREATE           when the device is to be created with the 'CREATE
1842           MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1843           matter which driver parameter)           matter which driver parameter)
1844    
1845    
1846    
1847    Schoenebeck             Expires December 24, 2007              [Page 33]
1848    
1849    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1850    
1851    
1852        FIX -        FIX -
1853    
1854           either true or false, if false then this parameter can be           either true or false, if false then this parameter can be
1855           changed at any time, once the device is created by the 'CREATE           changed at any time, once the device is created by the 'CREATE
1856           MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1857           matter which driver parameter)           matter which driver parameter)
1858    
1859        MULTIPLICITY -        MULTIPLICITY -
1860    
1861           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
1862           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
1863           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
1864           which driver parameter)           which driver parameter)
1865    
1866        DEPENDS -        DEPENDS -
1867    
1868           comma separated list of parameters this parameter depends on,           comma separated list of parameters this parameter depends on,
1869           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1870           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
# Line 1485  Internet-Draft       LinuxSampler Contro Line 1874  Internet-Draft       LinuxSampler Contro
1874           possible values for 'samplerate' depends on the sound card           possible values for 'samplerate' depends on the sound card
1875           which can be chosen by the 'card' parameter (optionally           which can be chosen by the 'card' parameter (optionally
1876           returned, dependent to driver parameter)           returned, dependent to driver parameter)
1877    
1878        DEFAULT -        DEFAULT -
1879    
1880           reflects the default value for this parameter which is used           reflects the default value for this parameter which is used
1881           when the device is created and not explicitly given with the           when the device is created and not explicitly given with the
1882           'CREATE MIDI_INPUT_DEVICE' (Section 5.3.5) command, in case of           'CREATE MIDI_INPUT_DEVICE' (Section 6.3.5) command, in case of
1883           MULTIPLCITY=true, this is a comma separated list, that's why           MULTIPLCITY=true, this is a comma separated list, that's why
1884           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
1885           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
1886    
1887        RANGE_MIN -        RANGE_MIN -
1888    
1889           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
1890           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1891           this parameter is often used in conjunction with RANGE_MAX, but           this parameter is often used in conjunction with RANGE_MAX, but
1892           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1893           driver parameter)           driver parameter)
1894    
1895        RANGE_MAX -        RANGE_MAX -
1896    
1897           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1898           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1899           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to  
          driver parameter)  
1900    
1901    
1902    
1903    Schoenebeck             Expires December 24, 2007              [Page 34]
 Schoenebeck            Expires November 19, 2005               [Page 27]  
1904    
1905  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1906    
1907    
1908             may also appear without (optionally returned, dependent to
1909             driver parameter)
1910    
1911        POSSIBILITIES -        POSSIBILITIES -
1912    
1913           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
1914           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
1915           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1523  Internet-Draft       LinuxSampler Contro Line 1919  Internet-Draft       LinuxSampler Contro
1919     Example:     Example:
1920    
1921        C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"        C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
1922    
1923        S: "DESCRIPTION: Whether device is enabled"        S: "DESCRIPTION: Whether device is enabled"
1924    
1925           "TYPE: BOOL"           "TYPE: BOOL"
1926    
1927           "MANDATORY: false"           "MANDATORY: false"
1928    
1929           "FIX: false"           "FIX: false"
1930    
1931           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1932    
1933           "DEFAULT: true"           "DEFAULT: true"
1934    
1935           "."           "."
1936    
1937  5.3.5  Creating a MIDI input device  6.3.5.  Creating a MIDI input device
1938    
1939     Use the following command to create a new MIDI input device for  the     Use the following command to create a new MIDI input device for the
1940     desired MIDI input system:     desired MIDI input system:
1941    
1942        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
1943    
1944     Where <midi-input-driver> should be replaced by the desired MIDI     Where <midi-input-driver> should be replaced by the desired MIDI
1945     input system and <param-list> by an optional list of driver specific     input system as returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1946     parameters in form of "key1=val1 key2=val2 ...", where character     (Section 6.3.2) command and <param-list> by an optional list of
1947     string values should be encapsulated into apostrophes (').  Note that     driver specific parameters in form of "key1=val1 key2=val2 ...",
1948     there might be drivers which require parameter(s) to be given with     where character string values should be encapsulated into apostrophes
1949     this command.  Use the previously described commands in this chapter     (').  Note that there might be drivers which require parameter(s) to
1950     to get that information.     be given with this command.  Use the previously described commands in
1951       this chapter to get that information.
1952    
1953     Possible Answers:     Possible Answers:
1954    
1955    
1956    
1957    
1958    
1959    Schoenebeck             Expires December 24, 2007              [Page 35]
1960    
1961    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
1965    
1966           in case the device was successfully created, where <device-id>           in case the device was successfully created, where <device-id>
1967           is the numerical ID of the new device           is the numerical ID of the new device
1968    
1969        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1970    
1971           in case the driver was loaded successfully, where <device-id>           in case the driver was loaded successfully, where <device-id>
1972           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1973           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
1974           warning message           warning message
1975    
1976        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1977    
1978           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1979           error message           error message
1980    
1981     Example:     Example:
1982    
   
   
 Schoenebeck            Expires November 19, 2005               [Page 28]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1983        C: "CREATE MIDI_INPUT_DEVICE ALSA"        C: "CREATE MIDI_INPUT_DEVICE ALSA"
1984    
1985        S: "OK[0]"        S: "OK[0]"
1986    
1987  5.3.6  Destroying a MIDI input device  6.3.6.  Destroying a MIDI input device
1988    
1989     Use the following command to destroy a created MIDI input device:     Use the following command to destroy a created MIDI input device:
1990    
1991        DESTROY MIDI_INPUT_DEVICE <device-id>        DESTROY MIDI_INPUT_DEVICE <device-id>
1992    
1993     Where <device-id> should be replaced by the device's numerical ID.     Where <device-id> should be replaced by the device's numerical ID as
1994       returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
1995       MIDI_INPUT_DEVICES" (Section 6.3.8) command.
1996    
1997     Possible Answers:     Possible Answers:
1998    
1999        "OK" -        "OK" -
2000    
2001           in case the device was successfully destroyed           in case the device was successfully destroyed
2002    
2003        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2004    
2005           in case the device was destroyed, but there are noteworthy           in case the device was destroyed, but there are noteworthy
2006           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
2007           warning message           warning message
2008    
2009        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2010    
2011    
2012    
2013    
2014    
2015    Schoenebeck             Expires December 24, 2007              [Page 36]
2016    
2017    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2021           error message           error message
2022    
2023     Example:     Example:
2024    
2025        C: "DESTROY MIDI_INPUT_DEVICE 0"        C: "DESTROY MIDI_INPUT_DEVICE 0"
2026    
2027        S: "OK"        S: "OK"
2028    
2029  5.3.7  Getting all created MIDI input device count  6.3.7.  Getting all created MIDI input device count
2030    
2031     Use the following command to count all created MIDI input devices:     Use the following command to count all created MIDI input devices:
2032    
# Line 1611  Internet-Draft       LinuxSampler Contro Line 2040  Internet-Draft       LinuxSampler Contro
2040     Example:     Example:
2041    
2042        C: "GET MIDI_INPUT_DEVICES"        C: "GET MIDI_INPUT_DEVICES"
2043    
2044        S: "3"        S: "3"
2045    
2046  5.3.8  Getting all created MIDI input device list  6.3.8.  Getting all created MIDI input device list
2047    
2048     Use the following command to list all created MIDI input devices:     Use the following command to list all created MIDI input devices:
2049    
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 29]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
2050        LIST MIDI_INPUT_DEVICES        LIST MIDI_INPUT_DEVICES
2051    
2052     Possible Answers:     Possible Answers:
# Line 1635  Internet-Draft       LinuxSampler Contro Line 2057  Internet-Draft       LinuxSampler Contro
2057     Examples:     Examples:
2058    
2059        C: "LIST MIDI_INPUT_DEVICES"        C: "LIST MIDI_INPUT_DEVICES"
2060    
2061        S: "0,1,2"        S: "0,1,2"
2062    
2063        C: "LIST MIDI_INPUT_DEVICES"        C: "LIST MIDI_INPUT_DEVICES"
2064    
2065        S: "1,3"        S: "1,3"
2066    
2067  5.3.9  Getting current settings of a MIDI input device  
2068    
2069    
2070    
2071    Schoenebeck             Expires December 24, 2007              [Page 37]
2072    
2073    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2074    
2075    
2076    6.3.9.  Getting current settings of a MIDI input device
2077    
2078     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
2079     created MIDI input device:     created MIDI input device:
2080    
2081        GET MIDI_INPUT_DEVICE INFO <device-id>        GET MIDI_INPUT_DEVICE INFO <device-id>
2082    
2083     Where <device-id> is the numerical ID of the MIDI input device.     Where <device-id> is the numerical ID of the MIDI input device as
2084       returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2085       MIDI_INPUT_DEVICES" (Section 6.3.8) command.
2086    
2087     Possible Answers:     Possible Answers:
2088    
# Line 1659  Internet-Draft       LinuxSampler Contro Line 2094  Internet-Draft       LinuxSampler Contro
2094        apostrophes (').  At the moment the following information        apostrophes (').  At the moment the following information
2095        categories are defined (independent of driver):        categories are defined (independent of driver):
2096    
2097    
2098    
2099           DRIVER -           DRIVER -
2100              identifier of the used MIDI input driver, as e.g.  returned  
2101              by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2)              identifier of the used MIDI input driver, as e.g. returned
2102                by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
2103              command              command
2104    
2105           ACTIVE -           ACTIVE -
2106    
2107              either true or false, if false then the MIDI device is              either true or false, if false then the MIDI device is
2108              inactive and doesn't listen to any incoming MIDI events and              inactive and doesn't listen to any incoming MIDI events and
2109              thus doesn't forward them to connected sampler channels              thus doesn't forward them to connected sampler channels
# Line 1672  Internet-Draft       LinuxSampler Contro Line 2112  Internet-Draft       LinuxSampler Contro
2112     fields above are only those fields which are returned by all MIDI     fields above are only those fields which are returned by all MIDI
2113     input devices.  Every MIDI input driver might have its own,     input devices.  Every MIDI input driver might have its own,
2114     additional driver specific parameters (see "GET MIDI_INPUT_DRIVER     additional driver specific parameters (see "GET MIDI_INPUT_DRIVER
2115     INFO" (Section 5.3.3) command) which are also returned by this     INFO" (Section 6.3.3) command) which are also returned by this
2116       command.
2117    
2118       Example:
2119    
2120          C: "GET MIDI_INPUT_DEVICE INFO 0"
2121    
2122          S: "DRIVER: ALSA"
2123    
 Schoenebeck            Expires November 19, 2005               [Page 30]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2124    
2125    
    command.  
2126    
2127     Example:  Schoenebeck             Expires December 24, 2007              [Page 38]
2128    
2129    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2130    
2131    
       C: "GET MIDI_INPUT_DEVICE INFO 0"  
       S: "DRIVER: ALSA"  
2132           "ACTIVE: true"           "ACTIVE: true"
2133    
2134           "."           "."
2135    
2136  5.3.10  Changing settings of MIDI input devices  6.3.10.  Changing settings of MIDI input devices
2137    
2138     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
2139     MIDI input device:     MIDI input device:
# Line 1698  Internet-Draft       LinuxSampler Contro Line 2141  Internet-Draft       LinuxSampler Contro
2141        SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>        SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>
2142    
2143     Where <device-id> should be replaced by the numerical ID of the MIDI     Where <device-id> should be replaced by the numerical ID of the MIDI
2144     input device, <key> by the name of the parameter to change and     input device as returned by the "CREATE MIDI_INPUT_DEVICE"
2145     <value> by the new value for this parameter.     (Section 6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command,
2146       <key> by the name of the parameter to change and <value> by the new
2147       value for this parameter.
2148    
2149     Possible Answers:     Possible Answers:
2150    
2151        "OK" -        "OK" -
2152    
2153           in case setting was successfully changed           in case setting was successfully changed
2154    
2155        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2156    
2157           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
2158           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2159           code and warning message           code and warning message
2160    
2161        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2162    
2163           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2164           error message           error message
2165    
2166     Example:     Example:
2167    
2168        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2169    
2170        S: "OK"        S: "OK"
2171    
2172  5.3.11  Getting information about a MIDI port  6.3.11.  Getting information about a MIDI port
2173    
2174     Use the following command to get information about a MIDI port:     Use the following command to get information about a MIDI port:
2175    
2176        GET MIDI_INPUT_PORT INFO <device-id> <midi-port>        GET MIDI_INPUT_PORT INFO <device-id> <midi-port>
2177    
2178     Where <device-id> is the numerical ID of the MIDI input device and     Where <device-id> is the numerical ID of the MIDI input device as
2179     <midi-port> the MIDI input port number.     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2180    
    Possible Answers:  
2181    
2182    
2183    Schoenebeck             Expires December 24, 2007              [Page 39]
2184    
2185    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2186    
2187    
2188  Schoenebeck            Expires November 19, 2005               [Page 31]     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2189       input port number.
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2190    
2191       Possible Answers:
2192    
2193        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2194        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2195        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2196        character string to that info category.  At the moment the        character string to that info category.  At the moment the
2197        following information categories are defined:        following information categories are defined:
2198    
2199        NAME -        NAME -
2200    
2201           arbitrary character string naming the port           arbitrary character string naming the port
2202    
2203     The field above is only the one which is returned by all MIDI ports     The field above is only the one which is returned by all MIDI ports
# Line 1752  Internet-Draft       LinuxSampler Contro Line 2207  Internet-Draft       LinuxSampler Contro
2207     Example:     Example:
2208    
2209        C: "GET MIDI_INPUT_PORT INFO 0 0"        C: "GET MIDI_INPUT_PORT INFO 0 0"
2210    
2211        S: "NAME: 'Masterkeyboard'"        S: "NAME: 'Masterkeyboard'"
2212    
2213           "ALSA_SEQ_BINDINGS: '64:0'"           "ALSA_SEQ_BINDINGS: '64:0'"
2214    
2215           "."           "."
2216    
2217  5.3.12  Getting information about specific MIDI port parameter  6.3.12.  Getting information about specific MIDI port parameter
2218    
2219     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
2220     MIDI port parameter:     MIDI port parameter:
# Line 1764  Internet-Draft       LinuxSampler Contro Line 2222  Internet-Draft       LinuxSampler Contro
2222        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
2223    
2224     Where <dev-id> is the numerical ID of the MIDI input device as     Where <dev-id> is the numerical ID of the MIDI input device as
2225     returned by the "LIST MIDI_INPUT_DEVICES" (Section 5.3.8) command,     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2226     <port> the MIDI port number and <param> a specific port parameter     MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> the MIDI port
2227     name for which information should be obtained (as returned by the     number and <param> a specific port parameter name for which
2228     "GET MIDI_INPUT_PORT INFO" (Section 5.3.11) command).     information should be obtained (as returned by the "GET
2229       MIDI_INPUT_PORT INFO" (Section 6.3.11) command).
2230    
2231     Possible Answers:     Possible Answers:
2232    
2233        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2234        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2235        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2236    
2237    
2238    
2239    Schoenebeck             Expires December 24, 2007              [Page 40]
2240    
2241    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
2245        which is always returned, independently of the given channel        which is always returned, independently of the given channel
2246        parameter and there is optional information which are only shown        parameter and there is optional information which are only shown
2247        dependently to the given MIDI port.  At the moment the following        dependently to the given MIDI port.  At the moment the following
2248        information categories are defined:        information categories are defined:
2249    
2250        TYPE -        TYPE -
2251    
2252           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
2253           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
2254           character string(s) (always returned)           character string(s) (always returned)
       DESCRIPTION -  
   
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 32]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2255    
2256          DESCRIPTION -
2257    
2258           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
2259           returned)           returned)
2260    
2261        FIX -        FIX -
2262    
2263           either true or false, if true then this parameter is read only,           either true or false, if true then this parameter is read only,
2264           thus cannot be altered (always returned)           thus cannot be altered (always returned)
2265    
2266        MULTIPLICITY -        MULTIPLICITY -
2267    
2268           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
2269           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
2270           false only a single value allowed (always returned)           false only a single value allowed (always returned)
2271    
2272        RANGE_MIN -        RANGE_MIN -
2273    
2274           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
2275           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
2276           this parameter is usually used in conjunction with 'RANGE_MAX'           this parameter is usually used in conjunction with 'RANGE_MAX'
2277           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2278           driver and port parameter)           driver and port parameter)
2279    
2280        RANGE_MAX -        RANGE_MAX -
2281    
2282           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
2283           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
2284           this parameter is usually used in conjunction with 'RANGE_MIN'           this parameter is usually used in conjunction with 'RANGE_MIN'
2285           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2286           driver and port parameter)           driver and port parameter)
2287    
2288        POSSIBILITIES -        POSSIBILITIES -
2289    
2290           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
2291           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
2292    
2293    
2294    
2295    Schoenebeck             Expires December 24, 2007              [Page 41]
2296    
2297    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
2301    
2302     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 1824  Internet-Draft       LinuxSampler Contro Line 2304  Internet-Draft       LinuxSampler Contro
2304     Example:     Example:
2305    
2306        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
2307    
2308        S: "DESCRIPTION: bindings to other ALSA sequencer clients"        S: "DESCRIPTION: bindings to other ALSA sequencer clients"
2309    
2310           "TYPE: STRING"           "TYPE: STRING"
2311    
2312           "FIX: false"           "FIX: false"
2313    
2314           "MULTIPLICITY: true"           "MULTIPLICITY: true"
2315    
2316           "POSSIBILITIES: '64:0','68:0','68:1'"           "POSSIBILITIES: '64:0','68:0','68:1'"
2317    
2318           "."           "."
2319    
2320  5.3.13  Changing settings of MIDI input ports  6.3.13.  Changing settings of MIDI input ports
2321    
2322     Use the following command to alter a specific setting of a MIDI input     Use the following command to alter a specific setting of a MIDI input
2323     port:     port:
# Line 1839  Internet-Draft       LinuxSampler Contro Line 2325  Internet-Draft       LinuxSampler Contro
2325        SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>        SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>
2326    
2327     Where <device-id> should be replaced by the numerical ID of the MIDI     Where <device-id> should be replaced by the numerical ID of the MIDI
2328     device, <port> by the MIDI port number, <key> by the name of the     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     parameter to change and <value> by the new value for this parameter.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330       MIDI port number, <key> by the name of the parameter to change and
2331       <value> by the new value for this parameter.
   
 Schoenebeck            Expires November 19, 2005               [Page 33]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
2332    
2333     Possible Answers:     Possible Answers:
2334    
2335        "OK" -        "OK" -
2336    
2337           in case setting was successfully changed           in case setting was successfully changed
2338    
2339        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2340    
2341           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
2342           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2343           code and warning message           code and warning message
2344    
2345        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2346    
2347    
2348    
2349    
2350    
2351    Schoenebeck             Expires December 24, 2007              [Page 42]
2352    
2353    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2354    
2355    
2356           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2357           error message           error message
2358    
# Line 1865  Internet-Draft       LinuxSampler Contro Line 2360  Internet-Draft       LinuxSampler Contro
2360    
2361    
2362    
2363  5.4  Configuring sampler channels  6.4.  Configuring sampler channels
2364    
2365     The following commands describe how to add and remove sampler     The following commands describe how to add and remove sampler
2366     channels, deploy sampler engines, load instruments and connect     channels, associate a sampler channel with a sampler engine, load
2367     sampler channels to MIDI and audio devices.     instruments and connect sampler channels to MIDI and audio devices.
2368    
2369  5.4.1  Loading an instrument  6.4.1.  Loading an instrument
2370    
2371     An instrument file can be loaded and assigned to a sampler channel by     An instrument file can be loaded and assigned to a sampler channel by
2372     one of the following commands:     one of the following commands:
2373    
2374        LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index>        LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
2375        <sampler-channel>        channel>
2376    
2377     Where <filename> is the name of the instrument file on the     Where <filename> is the name of the instrument file on the
2378     LinuxSampler instance's host system, <instr-index> the index of the     LinuxSampler instance's host system, <instr-index> the index of the
# Line 1885  Internet-Draft       LinuxSampler Contro Line 2380  Internet-Draft       LinuxSampler Contro
2380     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2381     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2382    
2383       Notice: since LSCP 1.2 the <filename> argument supports escape
2384       characters for special characters (see chapter "Character Set and
2385       Escape Sequences (Section 7.1)" for details) and accordingly
2386       backslash characters in the filename MUST now be escaped as well!
2387    
2388     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2389     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2390     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
2391     version returns immediately and a background process is launched to     version returns immediately and a background process is launched to
2392     load the instrument on the channel.  The GET CHANNEL INFO (Section     load the instrument on the channel.  The GET CHANNEL INFO
2393     5.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2394     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2395     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2396     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 1898  Internet-Draft       LinuxSampler Contro Line 2398  Internet-Draft       LinuxSampler Contro
2398    
2399     Possible Answers:     Possible Answers:
2400    
2401          "OK" -
2402    
2403    
2404    
2405    
2406  Schoenebeck            Expires November 19, 2005               [Page 34]  
2407    Schoenebeck             Expires December 24, 2007              [Page 43]
2408    
2409  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2410    
2411    
       "OK" -  
2412           in case the instrument was successfully loaded           in case the instrument was successfully loaded
2413    
2414        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2415    
2416           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2417           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
2418           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2419           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2420           message           message
2421    
2422        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2423    
2424           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2425           error message           error message
2426    
# Line 1921  Internet-Draft       LinuxSampler Contro Line 2428  Internet-Draft       LinuxSampler Contro
2428    
2429    
2430    
2431  5.4.2  Loading a sampler engine  6.4.2.  Loading a sampler engine
2432    
2433     A sample engine can be deployed and assigned to a specific sampler     A sampler engine type can be associated to a specific sampler channel
2434     channel by the following command:     by the following command:
2435    
2436        LOAD ENGINE <engine-name> <sampler-channel>        LOAD ENGINE <engine-name> <sampler-channel>
2437    
2438     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2439     AVAILABLE_ENGINES" (Section 5.4.8) command and <sampler-channel> the     AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
2440     sampler channel the deployed engine should be assigned to.  Even if     sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
2441     the respective sampler channel has already a deployed engine with     "LIST CHANNELS" (Section 6.4.4) command where the engine type should
2442     that engine name, a new engine instance will be assigned to the     be assigned to.  This command should be issued after adding a new
2443     sampler channel.     sampler channel and before any other control commands on the new
2444       sampler channel.  It can also be used to change the engine type of a
2445       sampler channel.  This command has (currently) no way to define or
2446       force if a new engine instance should be created and assigned to the
2447       given sampler channel or if an already existing instance of that
2448       engine type, shared with other sampler channels, should be used.
2449    
2450     Possible Answers:     Possible Answers:
2451    
2452        "OK" -        "OK" -
2453    
2454           in case the engine was successfully deployed           in case the engine was successfully deployed
2455    
2456        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2457    
2458           in case the engine was deployed successfully, but there are           in case the engine was deployed successfully, but there are
2459           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
          code and warning message  
       "ERR:<error-code>:<error-message>" -  
          in case it failed, providing an appropriate error code and  
          error message  
2460    
    Example:  
2461    
2462    
2463    Schoenebeck             Expires December 24, 2007              [Page 44]
2464    
2465    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2466    
2467    
2468             code and warning message
2469    
2470          "ERR:<error-code>:<error-message>" -
2471    
2472             in case it failed, providing an appropriate error code and
2473             error message
2474    
2475       Example:
2476    
 Schoenebeck            Expires November 19, 2005               [Page 35]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2477    
2478    
2479  5.4.3  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
2480    
2481     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2482     current amount of sampler channels, the front-end can send the     current amount of sampler channels, the front-end can send the
# Line 1977  Internet-Draft       LinuxSampler Contro Line 2492  Internet-Draft       LinuxSampler Contro
2492     Example:     Example:
2493    
2494        C: "GET CHANNELS"        C: "GET CHANNELS"
2495    
2496        S: "12"        S: "12"
2497    
2498  5.4.4  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2499    
2500     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2501     current list of sampler channels, the front-end can send the     current list of sampler channels, the front-end can send the
# Line 1995  Internet-Draft       LinuxSampler Contro Line 2511  Internet-Draft       LinuxSampler Contro
2511     Example:     Example:
2512    
2513        C: "LIST CHANNELS"        C: "LIST CHANNELS"
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck             Expires December 24, 2007              [Page 45]
2520    
2521    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2522    
2523    
2524        S: "0,1,2,3,4,5,6,9,10,11,15,20"        S: "0,1,2,3,4,5,6,9,10,11,15,20"
2525    
2526  5.4.5  Adding a new sampler channel  6.4.5.  Adding a new sampler channel
2527    
2528     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2529     list by sending the following command:     list by sending the following command:
# Line 2007  Internet-Draft       LinuxSampler Contro Line 2533  Internet-Draft       LinuxSampler Contro
2533     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
2534     sampler channel will be appended to the end of the sampler channel     sampler channel will be appended to the end of the sampler channel
2535     list.  The front-end should send the respective, related commands     list.  The front-end should send the respective, related commands
2536     right after to e.g.  load an engine, load an instrument and setting     right after to e.g. load an engine, load an instrument and setting
2537     input, output method and eventually other commands to initialize the     input, output method and eventually other commands to initialize the
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 36]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
2538     new channel.  The front-end should use the sampler channel returned     new channel.  The front-end should use the sampler channel returned
2539     by the answer of this command to perform the previously recommended     by the answer of this command to perform the previously recommended
2540     commands, to avoid race conditions e.g.  with other front-ends that     commands, to avoid race conditions e.g. with other front-ends that
2541     might also have sent an "ADD CHANNEL" command.     might also have sent an "ADD CHANNEL" command.
2542    
2543     Possible Answers:     Possible Answers:
2544    
2545        "OK[<sampler-channel>]" -        "OK[<sampler-channel>]" -
2546           in case a new sampler channel could be added, where  
2547           <sampler-channel> reflects the channel number of the new           in case a new sampler channel could be added, where <sampler-
2548           created sampler channel which should be used to set up the           channel> reflects the channel number of the new created sampler
2549           sampler channel by sending subsequent initialization commands           channel which should be used to set up the sampler channel by
2550             sending subsequent initialization commands
2551    
2552        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2553    
2554           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2555           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2556           code and warning message           code and warning message
2557    
2558        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2559    
2560           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2561           error message           error message
2562    
# Line 2041  Internet-Draft       LinuxSampler Contro Line 2564  Internet-Draft       LinuxSampler Contro
2564    
2565    
2566    
2567  5.4.6  Removing a sampler channel  6.4.6.  Removing a sampler channel
2568    
2569     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck             Expires December 24, 2007              [Page 46]
2576    
2577    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2578    
2579    
2580        REMOVE CHANNEL <sampler-channel>        REMOVE CHANNEL <sampler-channel>
2581    
2582     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
2583     sampler channel as given by the "ADD CHANNEL" (Section 5.4.5) or     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
2584     "LIST CHANNELS" (Section 5.4.4) command.  The channel numbers of all     "LIST CHANNELS" (Section 6.4.4) command.  The channel numbers of all
2585     subsequent sampler channels remain the same.     subsequent sampler channels remain the same.
2586    
2587     Possible Answers:     Possible Answers:
2588    
2589        "OK" -        "OK" -
2590    
2591           in case the given sampler channel could be removed           in case the given sampler channel could be removed
2592    
2593        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2594    
2595           in case the given channel was removed, but there are noteworthy           in case the given channel was removed, but there are noteworthy
2596           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
2597           warning message           warning message
2598    
2599        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2600    
2601           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2602           error message           error message
2603    
# Line 2068  Internet-Draft       LinuxSampler Contro Line 2605  Internet-Draft       LinuxSampler Contro
2605    
2606    
2607    
2608  Schoenebeck            Expires November 19, 2005               [Page 37]  6.4.7.  Getting amount of available engines
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
   
 5.4.7  Getting amount of available engines  
2609    
2610     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
2611     the following command:     the following command:
# Line 2090  Internet-Draft       LinuxSampler Contro Line 2620  Internet-Draft       LinuxSampler Contro
2620     Example:     Example:
2621    
2622        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2623    
2624        S: "4"        S: "4"
2625    
2626  5.4.8  Getting all available engines  
2627    
2628    
2629    
2630    
2631    Schoenebeck             Expires December 24, 2007              [Page 47]
2632    
2633    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2634    
2635    
2636    6.4.8.  Getting all available engines
2637    
2638     The front-end can ask for a list of all available engines by sending     The front-end can ask for a list of all available engines by sending
2639     the following command:     the following command:
# Line 2109  Internet-Draft       LinuxSampler Contro Line 2650  Internet-Draft       LinuxSampler Contro
2650     Example:     Example:
2651    
2652        C: "LIST AVAILABLE_ENGINES"        C: "LIST AVAILABLE_ENGINES"
2653    
2654        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2655    
2656  5.4.9  Getting information about an engine  6.4.9.  Getting information about an engine
2657    
2658     The front-end can ask for information about a specific engine by     The front-end can ask for information about a specific engine by
2659     sending the following command:     sending the following command:
# Line 2119  Internet-Draft       LinuxSampler Contro Line 2661  Internet-Draft       LinuxSampler Contro
2661        GET ENGINE INFO <engine-name>        GET ENGINE INFO <engine-name>
2662    
2663     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2664     AVAILABLE_ENGINES" (Section 5.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
   
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 38]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
2665    
2666     Possible Answers:     Possible Answers:
2667    
# Line 2137  Internet-Draft       LinuxSampler Contro Line 2671  Internet-Draft       LinuxSampler Contro
2671        character string to that info category.  At the moment the        character string to that info category.  At the moment the
2672        following categories are defined:        following categories are defined:
2673    
2674    
2675    
2676           DESCRIPTION -           DESCRIPTION -
2677    
2678              arbitrary description text about the engine              arbitrary description text about the engine
2679    
2680           VERSION -           VERSION -
2681    
2682              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
2683    
2684    
2685    
2686    
2687    Schoenebeck             Expires December 24, 2007              [Page 48]
2688    
2689    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2690    
2691    
2692     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2693    
2694     Example:     Example:
2695    
2696        C: "GET ENGINE INFO JoesCustomEngine"        C: "GET ENGINE INFO JoesCustomEngine"
2697    
2698        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2699    
2700           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2701    
2702           "."           "."
2703    
2704  5.4.10  Getting sampler channel information  6.4.10.  Getting sampler channel information
2705    
2706     The front-end can ask for the current settings of a sampler channel     The front-end can ask for the current settings of a sampler channel
2707     by sending the following command:     by sending the following command:
# Line 2159  Internet-Draft       LinuxSampler Contro Line 2709  Internet-Draft       LinuxSampler Contro
2709        GET CHANNEL INFO <sampler-channel>        GET CHANNEL INFO <sampler-channel>
2710    
2711     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2712     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2713       "LIST CHANNELS" (Section 6.4.4) command.
2714    
2715     Possible Answers:     Possible Answers:
2716    
# Line 2169  Internet-Draft       LinuxSampler Contro Line 2720  Internet-Draft       LinuxSampler Contro
2720        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2721        following categories are defined:        following categories are defined:
2722    
2723    
2724    
2725           ENGINE_NAME -           ENGINE_NAME -
2726              name of the engine that is deployed on the sampler channel,  
2727              "NONE" if there's no engine deployed yet for this sampler              name of the engine that is associated with the sampler
2728              channel              channel, "NONE" if there's no engine associated yet for this
2729                sampler channel
2730    
2731           AUDIO_OUTPUT_DEVICE -           AUDIO_OUTPUT_DEVICE -
2732    
2733              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2734              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2735              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
2736                sampler channel
2737    
2738    
2739    
2740    
2741    
2742    
2743  Schoenebeck            Expires November 19, 2005               [Page 39]  Schoenebeck             Expires December 24, 2007              [Page 49]
2744    
2745  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2746    
2747    
             sampler channel  
2748           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2749    
2750              number of output channels the sampler channel offers              number of output channels the sampler channel offers
2751              (dependent to used sampler engine and loaded instrument)              (dependent to used sampler engine and loaded instrument)
2752    
2753           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
2754    
2755              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2756              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2757              channel is routed to, e.g.  "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
2758              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2759              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2760              channel 3 of the audio output device              channel 3 of the audio output device
2761    
2762           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2763    
2764              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2765              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel
2766    
2767           INSTRUMENT_NR -           INSTRUMENT_NR -
2768    
2769              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument
2770    
2771           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2772    
2773              the instrument name of the loaded instrument              the instrument name of the loaded instrument
2774    
2775           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2776    
2777              integer values 0 to 100 indicating loading progress              integer values 0 to 100 indicating loading progress
2778              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2779              loading exception.  Value of 100 indicates that the              loading exception.  Value of 100 indicates that the
2780              instrument is fully loaded.              instrument is fully loaded.
2781    
2782           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2783    
2784              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2785              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2786              commands, "NONE" if there's no device connected to this              commands, "NONE" if there's no device connected to this
2787              sampler channel              sampler channel
2788    
2789           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2790    
2791              port number of the MIDI input device              port number of the MIDI input device
2792    
2793           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2794    
2795    
2796    
2797    
2798    
2799    Schoenebeck             Expires December 24, 2007              [Page 50]
2800    
2801    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2802    
2803    
2804              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
2805              listen to or "ALL" to listen on all MIDI channels              listen to or "ALL" to listen on all MIDI channels
2806    
2807           VOLUME -           VOLUME -
2808    
2809              optionally dotted number for the channel volume factor              optionally dotted number for the channel volume factor
2810              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2811              means amplification)              means amplification)
2812    
2813             MUTE -
2814    
2815                Determines whether the channel is muted, "true" if the
2816                channel is muted, "false" if the channel is not muted, and
2817                "MUTED_BY_SOLO" if the channel is muted because of the
2818                presence of a solo channel and will be unmuted when there
2819                are no solo channels left
2820    
2821             SOLO -
2822    
2823                Determines whether this is a solo channel, "true" if the
2824                channel is a solo channel; "false" otherwise
2825    
2826             MIDI_INSTRUMENT_MAP -
2827    
2828                Determines to which MIDI instrument map this sampler channel
2829                is assigned to.  Read chapter "SET CHANNEL
2830                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2831                values.
2832    
2833     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2834    
2835     Example:     Example:
2836    
2837        C: "GET CHANNEL INFO 34"        C: "GET CHANNEL INFO 34"
2838    
2839        S: "ENGINE_NAME: GigEngine"        S: "ENGINE_NAME: GigEngine"
2840    
2841           "VOLUME: 1.0"           "VOLUME: 1.0"
2842    
2843           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2844    
2845           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
2846    
2847             "AUDIO_OUTPUT_ROUTING: 0,1"
2848    
2849             "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2850    
2851    
2852    
2853    
2854  Schoenebeck            Expires November 19, 2005               [Page 40]  
2855    Schoenebeck             Expires December 24, 2007              [Page 51]
2856    
2857  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2858    
2859    
          "AUDIO_OUTPUT_ROUTING: 0,1"  
          "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"  
2860           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2861    
2862           "INSTRUMENT_NAME: Fazioli Piano"           "INSTRUMENT_NAME: Fazioli Piano"
2863    
2864           "INSTRUMENT_STATUS: 100"           "INSTRUMENT_STATUS: 100"
2865    
2866           "MIDI_INPUT_DEVICE: 0"           "MIDI_INPUT_DEVICE: 0"
2867    
2868           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2869    
2870           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2871    
2872             "VOLUME: 1.0"
2873    
2874             "MUTE: false"
2875    
2876             "SOLO: false"
2877    
2878             "MIDI_INSTRUMENT_MAP: NONE"
2879    
2880           "."           "."
2881    
2882  5.4.11  Current number of active voices  6.4.11.  Current number of active voices
2883    
2884     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2885     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2259  Internet-Draft       LinuxSampler Contro Line 2887  Internet-Draft       LinuxSampler Contro
2887        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2888    
2889     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2890     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2891       "LIST CHANNELS" (Section 6.4.4) command.
2892    
2893     Possible Answers:     Possible Answers:
2894    
# Line 2270  Internet-Draft       LinuxSampler Contro Line 2899  Internet-Draft       LinuxSampler Contro
2899    
2900    
2901    
2902  5.4.12  Current number of active disk streams  6.4.12.  Current number of active disk streams
2903    
2904     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
2905     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
2906    
2907    
2908    
2909    
2910    
2911    Schoenebeck             Expires December 24, 2007              [Page 52]
2912    
2913    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2914    
2915    
2916        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2917    
2918     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2919     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2920       "LIST CHANNELS" (Section 6.4.4) command.
2921    
2922     Possible Answers:     Possible Answers:
2923    
# Line 2291  Internet-Draft       LinuxSampler Contro Line 2930  Internet-Draft       LinuxSampler Contro
2930    
2931    
2932    
2933    6.4.13.  Current fill state of disk stream buffers
 Schoenebeck            Expires November 19, 2005               [Page 41]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
   
 5.4.13  Current fill state of disk stream buffers  
2934    
2935     The front-end can ask for the current fill state of all disk streams     The front-end can ask for the current fill state of all disk streams
2936     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
# Line 2311  Internet-Draft       LinuxSampler Contro Line 2942  Internet-Draft       LinuxSampler Contro
2942        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
2943    
2944     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2945     sampler channel number the front-end is interested in.     sampler channel number the front-end is interested in as returned by
2946       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2947       command.
2948    
2949     Possible Answers:     Possible Answers:
2950    
# Line 2328  Internet-Draft       LinuxSampler Contro Line 2961  Internet-Draft       LinuxSampler Contro
2961    
2962     Examples:     Examples:
2963    
2964    
2965    
2966    
2967    Schoenebeck             Expires December 24, 2007              [Page 53]
2968    
2969    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
2970    
2971    
2972        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2973    
2974        S: "[115]420500,[116]510300,[75]110000,[120]230700"        S: "[115]420500,[116]510300,[75]110000,[120]230700"
2975    
2976        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2977    
2978        S: "[115]90%,[116]98%,[75]40%,[120]62%"        S: "[115]90%,[116]98%,[75]40%,[120]62%"
2979    
2980        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2981    
2982        S: ""        S: ""
2983    
2984  5.4.14  Setting audio output device  6.4.14.  Setting audio output device
2985    
2986     The front-end can set the audio output device on a specific sampler     The front-end can set the audio output device on a specific sampler
2987     channel by sending the following command:     channel by sending the following command:
# Line 2343  Internet-Draft       LinuxSampler Contro Line 2989  Internet-Draft       LinuxSampler Contro
2989        SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>        SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
2990        <audio-device-id>        <audio-device-id>
2991    
2992     Where <audio-device-id> is the numerical ID of the audio output     Where <sampler-channel> is the respective sampler channel number as
2993     device and <sampler-channel> is the respective sampler channel     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
2994       (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2995       the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2996       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
2997  Schoenebeck            Expires November 19, 2005               [Page 42]     command.
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
    number.  
2998    
2999     Possible Answers:     Possible Answers:
3000    
3001        "OK" -        "OK" -
3002    
3003           on success           on success
3004    
3005        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3006    
3007           if audio output device was set, but there are noteworthy           if audio output device was set, but there are noteworthy
3008           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3009           warning message           warning message
3010    
3011        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3012    
3013           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3014           error message           error message
3015    
# Line 2371  Internet-Draft       LinuxSampler Contro Line 3017  Internet-Draft       LinuxSampler Contro
3017    
3018    
3019    
3020  5.4.15  Setting audio output type  
3021    
3022    
3023    Schoenebeck             Expires December 24, 2007              [Page 54]
3024    
3025    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3026    
3027    
3028    
3029    
3030    6.4.15.  Setting audio output type
3031    
3032     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3033    
3034     The front-end can alter the audio output type on a specific sampler     The front-end can alter the audio output type on a specific sampler
3035     channel by sending the following command:     channel by sending the following command:
3036    
3037        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel>        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3038        <audio-output-type>        type>
3039    
3040     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3041     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
# Line 2387  Internet-Draft       LinuxSampler Contro Line 3043  Internet-Draft       LinuxSampler Contro
3043     Possible Answers:     Possible Answers:
3044    
3045        "OK" -        "OK" -
3046    
3047           on success           on success
3048    
3049        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3050    
3051           if audio output type was set, but there are noteworthy issue(s)           if audio output type was set, but there are noteworthy issue(s)
3052           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3053           message           message
3054    
3055        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3056    
3057           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3058           error message           error message
3059    
# Line 2400  Internet-Draft       LinuxSampler Contro Line 3061  Internet-Draft       LinuxSampler Contro
3061    
3062    
3063    
3064    6.4.16.  Setting audio output channel
3065    
3066       The front-end can alter the audio output channel on a specific
3067       sampler channel by sending the following command:
3068    
3069          SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3070          <audio-in>
3071    
3072       Where <sampler-chan> is the sampler channel number as returned by the
3073  Schoenebeck            Expires November 19, 2005               [Page 43]     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3074       command, <audio-out> is the numerical ID of the sampler channel's
3075  Internet-Draft       LinuxSampler Control Protocol              May 2005     audio output channel which should be rerouted and <audio-in> is the
3076    
3077    
 5.4.16  Setting audio output channel  
3078    
3079     The front-end can alter the audio output channel on a specific  Schoenebeck             Expires December 24, 2007              [Page 55]
3080     sampler channel by sending the following command:  
3081    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3082    
       SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>  
       <audio-in>  
3083    
3084     Where <sampler-chan> is the sampler channel number, <audio-out> is     numerical ID of the audio channel of the selected audio output device
3085     the numerical ID of the sampler channel's audio output channel which     where <audio-out> should be routed to.
    should be rerouted and <audio-in> is the numerical ID of the audio  
    channel of the selected audio output device where <audio-out> should  
    be routed to.  
3086    
3087     Possible Answers:     Possible Answers:
3088    
3089        "OK" -        "OK" -
3090    
3091           on success           on success
3092    
3093        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3094    
3095           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3096           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3097           warning message           warning message
3098    
3099        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3100    
3101           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3102           error message           error message
3103    
# Line 2439  Internet-Draft       LinuxSampler Contro Line 3105  Internet-Draft       LinuxSampler Contro
3105    
3106    
3107    
3108  5.4.17  Setting MIDI input device  6.4.17.  Setting MIDI input device
3109    
3110     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3111     channel by sending the following command:     channel by sending the following command:
3112    
3113        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3114    
3115     Where <sampler-channel> is the sampler channel number and     Where <sampler-channel> is the sampler channel number as returned by
3116     <midi-device-id> is the the numerical ID of the MIDI input device.     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3117       command and <midi-device-id> is the numerical ID of the MIDI input
3118       device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3119       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3120    
3121     Possible Answers:     Possible Answers:
3122    
3123        "OK" -        "OK" -
3124    
3125           on success           on success
3126    
3127        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3128    
3129           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3130           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3131           message           message
3132    
3133    
3134    
3135  Schoenebeck            Expires November 19, 2005               [Page 44]  Schoenebeck             Expires December 24, 2007              [Page 56]
3136    
3137  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3138    
3139    
3140        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3141    
3142           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3143           error message           error message
3144    
# Line 2473  Internet-Draft       LinuxSampler Contro Line 3146  Internet-Draft       LinuxSampler Contro
3146    
3147    
3148    
3149  5.4.18  Setting MIDI input type  6.4.18.  Setting MIDI input type
3150    
3151     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3152    
# Line 2482  Internet-Draft       LinuxSampler Contro Line 3155  Internet-Draft       LinuxSampler Contro
3155    
3156        SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>        SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
3157    
3158     Where <midi-input-type> is currently only "ALSA" and     Where <midi-input-type> is currently only "ALSA" and <sampler-
3159     <sampler-channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3160    
3161     Possible Answers:     Possible Answers:
3162    
3163        "OK" -        "OK" -
3164    
3165           on success           on success
3166    
3167        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3168    
3169           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3170           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3171           message           message
3172    
3173        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3174    
3175           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3176           error message           error message
3177    
# Line 2501  Internet-Draft       LinuxSampler Contro Line 3179  Internet-Draft       LinuxSampler Contro
3179    
3180    
3181    
3182  5.4.19  Setting MIDI input port  6.4.19.  Setting MIDI input port
3183    
3184     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
3185     channel by sending the following command:     channel by sending the following command:
3186    
       SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>  
3187    
    Where <midi-input-port> is a MIDI input port number of the MIDI input  
    device connected to the sampler channel given by <sampler-channel>.  
3188    
    Possible Answers:  
3189    
3190    
3191    Schoenebeck             Expires December 24, 2007              [Page 57]
3192    
3193    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3194    
3195    
3196  Schoenebeck            Expires November 19, 2005               [Page 45]        SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
3197    
3198       Where <midi-input-port> is a MIDI input port number of the MIDI input
3199       device connected to the sampler channel given by <sampler-channel>.
3200    
3201       Possible Answers:
3202    
3203        "OK" -        "OK" -
3204    
3205           on success           on success
3206    
3207        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3208    
3209           if MIDI input port was set, but there are noteworthy issue(s)           if MIDI input port was set, but there are noteworthy issue(s)
3210           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3211           message           message
3212    
3213        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3214    
3215           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3216           error message           error message
3217    
# Line 2535  Internet-Draft       LinuxSampler Contro Line 3219  Internet-Draft       LinuxSampler Contro
3219    
3220    
3221    
3222  5.4.20  Setting MIDI input channel  6.4.20.  Setting MIDI input channel
3223    
3224     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3225     listen to by sending the following command:     listen to by sending the following command:
# Line 2549  Internet-Draft       LinuxSampler Contro Line 3233  Internet-Draft       LinuxSampler Contro
3233     Possible Answers:     Possible Answers:
3234    
3235        "OK" -        "OK" -
3236    
3237           on success           on success
3238    
3239        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3240    
3241           if MIDI input channel was set, but there are noteworthy           if MIDI input channel was set, but there are noteworthy
3242           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3243           warning message           warning message
3244    
3245    
3246    
3247    Schoenebeck             Expires December 24, 2007              [Page 58]
3248    
3249    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3250    
3251    
3252        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3253    
3254           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3255           error message           error message
3256    
# Line 2562  Internet-Draft       LinuxSampler Contro Line 3258  Internet-Draft       LinuxSampler Contro
3258    
3259    
3260    
3261  5.4.21  Setting channel volume  6.4.21.  Setting channel volume
3262    
3263     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
3264     the following command:     the following command:
3265    
3266        SET CHANNEL VOLUME <sampler-channel> <volume>        SET CHANNEL VOLUME <sampler-channel> <volume>
3267    
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 46]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
3268     Where <volume> is an optionally dotted positive number (a value     Where <volume> is an optionally dotted positive number (a value
3269     smaller than 1.0 means attenuation, whereas a value greater than 1.0     smaller than 1.0 means attenuation, whereas a value greater than 1.0
3270     means amplification) and <sampler-channel> defines the sampler     means amplification) and <sampler-channel> defines the sampler
# Line 2585  Internet-Draft       LinuxSampler Contro Line 3273  Internet-Draft       LinuxSampler Contro
3273     Possible Answers:     Possible Answers:
3274    
3275        "OK" -        "OK" -
3276    
3277           on success           on success
3278    
3279        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3280    
3281           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3282           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3283           message           message
3284    
3285          "ERR:<error-code>:<error-message>" -
3286    
3287             in case it failed, providing an appropriate error code and
3288             error message
3289    
3290       Examples:
3291    
3292    
3293    
3294    6.4.22.  Muting a sampler channel
3295    
3296       The front-end can mute/unmute a specific sampler channel by sending
3297       the following command:
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck             Expires December 24, 2007              [Page 59]
3304    
3305    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3306    
3307    
3308          SET CHANNEL MUTE <sampler-channel> <mute>
3309    
3310       Where <sampler-channel> is the respective sampler channel number as
3311       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3312       (Section 6.4.4) command and <mute> should be replaced either by "1"
3313       to mute the channel or "0" to unmute the channel.
3314    
3315       Possible Answers:
3316    
3317          "OK" -
3318    
3319             on success
3320    
3321          "WRN:<warning-code>:<warning-message>" -
3322    
3323             if the channel was muted/unmuted, but there are noteworthy
3324             issue(s) related, providing an appropriate warning code and
3325             warning message
3326    
3327        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3328    
3329           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3330           error message           error message
3331    
# Line 2598  Internet-Draft       LinuxSampler Contro Line 3333  Internet-Draft       LinuxSampler Contro
3333    
3334    
3335    
3336  5.4.22  Resetting a sampler channel  6.4.23.  Soloing a sampler channel
3337    
3338       The front-end can solo/unsolo a specific sampler channel by sending
3339       the following command:
3340    
3341          SET CHANNEL SOLO <sampler-channel> <solo>
3342    
3343       Where <sampler-channel> is the respective sampler channel number as
3344       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3345       (Section 6.4.4) command and <solo> should be replaced either by "1"
3346       to solo the channel or "0" to unsolo the channel.
3347    
3348       Possible Answers:
3349    
3350          "OK" -
3351    
3352             on success
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck             Expires December 24, 2007              [Page 60]
3360    
3361    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3362    
3363    
3364          "WRN:<warning-code>:<warning-message>" -
3365    
3366             if the channel was soloed/unsoloed, but there are noteworthy
3367             issue(s) related, providing an appropriate warning code and
3368             warning message
3369    
3370          "ERR:<error-code>:<error-message>" -
3371    
3372             in case it failed, providing an appropriate error code and
3373             error message
3374    
3375       Examples:
3376    
3377    
3378    
3379    6.4.24.  Assigning a MIDI instrument map to a sampler channel
3380    
3381       The front-end can assign a MIDI instrument map to a specific sampler
3382       channel by sending the following command:
3383    
3384          SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3385    
3386       Where <sampler-channel> is the respective sampler channel number as
3387       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3388       (Section 6.4.4) command and <map> can have the following
3389       possibilites:
3390    
3391          "NONE" -
3392    
3393             This is the default setting.  In this case the sampler channel
3394             is not assigned any MIDI instrument map and thus will ignore
3395             all MIDI program change messages.
3396    
3397          "DEFAULT" -
3398    
3399             The sampler channel will always use the default MIDI instrument
3400             map to handle MIDI program change messages.
3401    
3402          numeric ID -
3403    
3404             You can assign a specific MIDI instrument map by replacing
3405             <map> with the respective numeric ID of the MIDI instrument map
3406             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3407             command.  Once that map will be deleted, the sampler channel
3408             would fall back to "NONE".
3409    
3410       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3411       regarding MIDI instrument mapping.
3412    
3413    
3414    
3415    Schoenebeck             Expires December 24, 2007              [Page 61]
3416    
3417    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3418    
3419    
3420       Possible Answers:
3421    
3422          "OK" -
3423    
3424             on success
3425    
3426          "ERR:<error-code>:<error-message>" -
3427    
3428             in case it failed, providing an appropriate error code and
3429             error message
3430    
3431       Examples:
3432    
3433    
3434    
3435    6.4.25.  Adding an effect send to a sampler channel
3436    
3437       The front-end can create an additional effect send on a specific
3438       sampler channel by sending the following command:
3439    
3440          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3441    
3442       Where <sampler-channel> is the respective sampler channel number as
3443       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3444       (Section 6.4.4) command, that is the sampler channel on which the
3445       effect send should be created on, <midi-ctrl> is a number between
3446       0..127 defining the MIDI controller which can alter the effect send
3447       level and <name> is an optional argument defining a name for the
3448       effect send entity.  The name does not have to be unique.
3449    
3450       By default, that is as initial routing, the effect send's audio
3451       channels are automatically routed to the last audio channels of the
3452       sampler channel's audio output device, that way you can i.e. first
3453       increase the amount of audio channels on the audio output device for
3454       having dedicated effect send output channels and when "CREATE
3455       FX_SEND" is called, those channels will automatically be picked.  You
3456       can alter the destination channels however with "SET FX_SEND
3457       AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3458    
3459       Note: Create effect sends on a sampler channel only when needed,
3460       because having effect sends on a sampler channel will decrease
3461       runtime performance, because for implementing channel effect sends,
3462       separate (sampler channel local) audio buffers are needed to render
3463       and mix the voices and route the audio signal afterwards to the
3464       master outputs and effect send outputs (along with their respective
3465       effect send levels).  A sampler channel without effect sends however
3466       can mix its voices directly into the audio output devices's audio
3467       buffers and is thus faster.
3468    
3469    
3470    
3471    Schoenebeck             Expires December 24, 2007              [Page 62]
3472    
3473    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3474    
3475    
3476       Possible Answers:
3477    
3478          "OK[<fx-send-id>]" -
3479    
3480             in case a new effect send could be added to the sampler
3481             channel, where <fx-send-id> reflects the unique ID of the newly
3482             created effect send entity
3483    
3484          "ERR:<error-code>:<error-message>" -
3485    
3486             when a new effect send could not be added, i.e. due to invalid
3487             parameters
3488    
3489       Examples:
3490    
3491          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3492    
3493          S: "OK[0]"
3494    
3495          C: "CREATE FX_SEND 0 93"
3496    
3497          S: "OK[1]"
3498    
3499    6.4.26.  Removing an effect send from a sampler channel
3500    
3501       The front-end can remove an existing effect send on a specific
3502       sampler channel by sending the following command:
3503    
3504          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3505    
3506       Where <sampler-channel> is the respective sampler channel number as
3507       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3508       (Section 6.4.4) command, that is the sampler channel from which the
3509       effect send should be removed from and <fx-send-id> is the respective
3510       effect send number as returned by the "CREATE FX_SEND"
3511       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3512    
3513       Possible Answers:
3514    
3515          "OK" -
3516    
3517             on success
3518    
3519          "ERR:<error-code>:<error-message>" -
3520    
3521             in case it failed, providing an appropriate error code and
3522             error message
3523    
3524    
3525    
3526    
3527    Schoenebeck             Expires December 24, 2007              [Page 63]
3528    
3529    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3530    
3531    
3532       Example:
3533    
3534          C: "DESTROY FX_SEND 0 0"
3535    
3536          S: "OK"
3537    
3538    6.4.27.  Getting amount of effect sends on a sampler channel
3539    
3540       The front-end can ask for the amount of effect sends on a specific
3541       sampler channel by sending the following command:
3542    
3543          GET FX_SENDS <sampler-channel>
3544    
3545       Where <sampler-channel> is the respective sampler channel number as
3546       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3547       (Section 6.4.4) command.
3548    
3549       Possible Answers:
3550    
3551          The sampler will answer by returning the number of effect sends on
3552          the given sampler channel.
3553    
3554       Example:
3555    
3556          C: "GET FX_SENDS 0"
3557    
3558          S: "2"
3559    
3560    6.4.28.  Listing all effect sends on a sampler channel
3561    
3562       The front-end can ask for a list of effect sends on a specific
3563       sampler channel by sending the following command:
3564    
3565          LIST FX_SENDS <sampler-channel>
3566    
3567       Where <sampler-channel> is the respective sampler channel number as
3568       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3569       (Section 6.4.4) command.
3570    
3571       Possible Answers:
3572    
3573          The sampler will answer by returning a comma separated list with
3574          all effect sends' numerical IDs on the given sampler channel.
3575    
3576       Examples:
3577    
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck             Expires December 24, 2007              [Page 64]
3584    
3585    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3586    
3587    
3588          C: "LIST FX_SENDS 0"
3589    
3590          S: "0,1"
3591    
3592          C: "LIST FX_SENDS 1"
3593    
3594          S: ""
3595    
3596    6.4.29.  Getting effect send information
3597    
3598       The front-end can ask for the current settings of an effect send
3599       entity by sending the following command:
3600    
3601          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3602    
3603       Where <sampler-channel> is the sampler channel number as returned by
3604       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3605       command and <fx-send-id> reflects the numerical ID of the effect send
3606       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3607       FX_SENDS" (Section 6.4.28) command.
3608    
3609       Possible Answers:
3610    
3611          The sampler will answer by sending a <CRLF> separated list.  Each
3612          answer line begins with the settings category name followed by a
3613          colon and then a space character <SP> and finally the info
3614          character string to that setting category.  At the moment the
3615          following categories are defined:
3616    
3617    
3618    
3619             NAME -
3620    
3621                name of the effect send entity
3622    
3623             MIDI_CONTROLLER -
3624    
3625                a value between 0 and 127 reflecting the MIDI controller
3626                which is able to modify the effect send's send level
3627    
3628             LEVEL -
3629    
3630                optionally dotted number reflecting the effect send's
3631                current send level (where a value < 1.0 means attenuation
3632                and a value > 1.0 means amplification)
3633    
3634    
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires December 24, 2007              [Page 65]
3640    
3641    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3642    
3643    
3644             AUDIO_OUTPUT_ROUTING -
3645    
3646                comma separated list which reflects to which audio channel
3647                of the selected audio output device each effect send output
3648                channel is routed to, e.g. "0,3" would mean the effect
3649                send's output channel 0 is routed to channel 0 of the audio
3650                output device and the effect send's output channel 1 is
3651                routed to the channel 3 of the audio output device (see "SET
3652                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3653    
3654       The mentioned fields above don't have to be in particular order.
3655    
3656       Example:
3657    
3658          C: "GET FX_SEND INFO 0 0"
3659    
3660          S: "NAME: Reverb Send"
3661    
3662             "MIDI_CONTROLLER: 91"
3663    
3664             "LEVEL: 0.3"
3665    
3666             "AUDIO_OUTPUT_ROUTING: 2,3"
3667    
3668             "."
3669    
3670    6.4.30.  Changing effect send's name
3671    
3672       The front-end can alter the current name of an effect send entity by
3673       sending the following command:
3674    
3675          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3676    
3677       Where <sampler-chan> is the sampler channel number as returned by the
3678       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3679       command, <fx-send-id> reflects the numerical ID of the effect send
3680       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3681       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3682       effect send entity, which does not have to be unique.
3683    
3684       Possible Answers:
3685    
3686          "OK" -
3687    
3688             on success
3689    
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires December 24, 2007              [Page 66]
3696    
3697    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3698    
3699    
3700          "ERR:<error-code>:<error-message>" -
3701    
3702             in case it failed, providing an appropriate error code and
3703             error message
3704    
3705       Example:
3706    
3707          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3708    
3709          S: "OK"
3710    
3711    6.4.31.  Altering effect send's audio routing
3712    
3713       The front-end can alter the destination of an effect send's audio
3714       channel on a specific sampler channel by sending the following
3715       command:
3716    
3717          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3718          <audio-src> <audio-dst>
3719    
3720       Where <sampler-chan> is the sampler channel number as returned by the
3721       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3722       command, <fx-send-id> reflects the numerical ID of the effect send
3723       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3724       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3725       of the effect send's audio channel which should be rerouted and
3726       <audio-dst> is the numerical ID of the audio channel of the selected
3727       audio output device where <audio-src> should be routed to.
3728    
3729       Note that effect sends can only route audio to the same audio output
3730       device as assigned to the effect send's sampler channel.  Also note
3731       that an effect send entity does always have exactly as much audio
3732       channels as its sampler channel.  So if the sampler channel is
3733       stereo, the effect send does have two audio channels as well.  Also
3734       keep in mind that the amount of audio channels on a sampler channel
3735       might be dependant not only to the deployed sampler engine on the
3736       sampler channel, but also dependant to the instrument currently
3737       loaded.  However you can (effectively) turn an i.e. stereo effect
3738       send into a mono one by simply altering its audio routing
3739       appropriately.
3740    
3741       Possible Answers:
3742    
3743          "OK" -
3744    
3745             on success
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck             Expires December 24, 2007              [Page 67]
3752    
3753    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3754    
3755    
3756          "WRN:<warning-code>:<warning-message>" -
3757    
3758             if audio output channel was set, but there are noteworthy
3759             issue(s) related, providing an appropriate warning code and
3760             warning message
3761    
3762          "ERR:<error-code>:<error-message>" -
3763    
3764             in case it failed, providing an appropriate error code and
3765             error message
3766    
3767       Example:
3768    
3769          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3770    
3771          S: "OK"
3772    
3773    6.4.32.  Altering effect send's MIDI controller
3774    
3775       The front-end can alter the MIDI controller of an effect send entity
3776       by sending the following command:
3777    
3778          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3779          ctrl>
3780    
3781       Where <sampler-chan> is the sampler channel number as returned by the
3782       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3783       command, <fx-send-id> reflects the numerical ID of the effect send
3784       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3785       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3786       controller which shall be able to modify the effect send's send
3787       level.
3788    
3789       Possible Answers:
3790    
3791          "OK" -
3792    
3793             on success
3794    
3795          "WRN:<warning-code>:<warning-message>" -
3796    
3797             if MIDI controller was set, but there are noteworthy issue(s)
3798             related, providing an appropriate warning code and warning
3799             message
3800    
3801          "ERR:<error-code>:<error-message>" -
3802    
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires December 24, 2007              [Page 68]
3808    
3809    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3810    
3811    
3812             in case it failed, providing an appropriate error code and
3813             error message
3814    
3815       Example:
3816    
3817          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3818    
3819          S: "OK"
3820    
3821    6.4.33.  Altering effect send's send level
3822    
3823       The front-end can alter the current send level of an effect send
3824       entity by sending the following command:
3825    
3826          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3827    
3828       Where <sampler-chan> is the sampler channel number as returned by the
3829       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3830       command, <fx-send-id> reflects the numerical ID of the effect send
3831       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3832       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3833       dotted positive number (a value smaller than 1.0 means attenuation,
3834       whereas a value greater than 1.0 means amplification) reflecting the
3835       new send level.
3836    
3837       Possible Answers:
3838    
3839          "OK" -
3840    
3841             on success
3842    
3843          "WRN:<warning-code>:<warning-message>" -
3844    
3845             if new send level was set, but there are noteworthy issue(s)
3846             related, providing an appropriate warning code and warning
3847             message
3848    
3849          "ERR:<error-code>:<error-message>" -
3850    
3851             in case it failed, providing an appropriate error code and
3852             error message
3853    
3854       Example:
3855    
3856          C: "SET FX_SEND LEVEL 0 0 0.15"
3857    
3858          S: "OK"
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires December 24, 2007              [Page 69]
3864    
3865    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3866    
3867    
3868    6.4.34.  Resetting a sampler channel
3869    
3870     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3871     following command:     following command:
# Line 2613  Internet-Draft       LinuxSampler Contro Line 3880  Internet-Draft       LinuxSampler Contro
3880     Possible Answers:     Possible Answers:
3881    
3882        "OK" -        "OK" -
3883    
3884           on success           on success
3885    
3886        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3887    
3888           if channel was reset, but there are noteworthy issue(s)           if channel was reset, but there are noteworthy issue(s)
3889           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3890           message           message
3891    
3892        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3893    
3894           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3895           error message           error message
3896    
# Line 2626  Internet-Draft       LinuxSampler Contro Line 3898  Internet-Draft       LinuxSampler Contro
3898    
3899    
3900    
3901    6.5.  Controlling connection
   
 Schoenebeck            Expires November 19, 2005               [Page 47]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
   
 5.5  Controlling connection  
3902    
3903     The following commands are used to control the connection to     The following commands are used to control the connection to
3904     LinuxSampler.     LinuxSampler.
3905    
3906  5.5.1  Register front-end for receiving event messages  6.5.1.  Register front-end for receiving event messages
3907    
3908     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3909     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
# Line 2650  Internet-Draft       LinuxSampler Contro Line 3913  Internet-Draft       LinuxSampler Contro
3913     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
3914     wants to subscribe to.     wants to subscribe to.
3915    
3916    
3917    
3918    
3919    Schoenebeck             Expires December 24, 2007              [Page 70]
3920    
3921    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3922    
3923    
3924     Possible Answers:     Possible Answers:
3925    
3926        "OK" -        "OK" -
3927    
3928           on success           on success
3929    
3930        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3931    
3932           if registration succeeded, but there are noteworthy issue(s)           if registration succeeded, but there are noteworthy issue(s)
3933           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3934           message           message
3935    
3936        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3937    
3938           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3939           error message           error message
3940    
# Line 2666  Internet-Draft       LinuxSampler Contro Line 3942  Internet-Draft       LinuxSampler Contro
3942    
3943    
3944    
3945  5.5.2  Unregister front-end for not receiving event messages  6.5.2.  Unregister front-end for not receiving event messages
3946    
3947     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
3948     event messages anymore by sending the following command:     event messages anymore by sending the following command:
# Line 2679  Internet-Draft       LinuxSampler Contro Line 3955  Internet-Draft       LinuxSampler Contro
3955     Possible Answers:     Possible Answers:
3956    
3957        "OK" -        "OK" -
          on success  
   
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 48]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
3958    
3959             on success
3960    
3961        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3962    
3963           if unregistration succeeded, but there are noteworthy issue(s)           if unregistration succeeded, but there are noteworthy issue(s)
3964           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3965           message           message
3966    
3967        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3968    
3969           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3970           error message           error message
3971    
3972    
3973    
3974    
3975    Schoenebeck             Expires December 24, 2007              [Page 71]
3976    
3977    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
3978    
3979    
3980     Examples:     Examples:
3981    
3982    
3983    
3984  5.5.3  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
3985    
3986     To enable or disable back sending of commands to the client the     To enable or disable back sending of commands to the client the
3987     following command can be used:     following command can be used:
# Line 2718  Internet-Draft       LinuxSampler Contro Line 3998  Internet-Draft       LinuxSampler Contro
3998     Possible Answers:     Possible Answers:
3999    
4000        "OK" -        "OK" -
4001    
4002           usually           usually
4003    
4004        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4005           on syntax error, e.g.  non boolean value  
4006             on syntax error, e.g. non boolean value
4007    
4008     Examples:     Examples:
4009    
4010    
4011    
4012  5.5.4  Close client connection  6.5.4.  Close client connection
4013    
4014     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
4015     sending the following command:     sending the following command:
# Line 2736  Internet-Draft       LinuxSampler Contro Line 4019  Internet-Draft       LinuxSampler Contro
4019     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4020     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4021    
4022    6.6.  Global commands
4023    
4024       The following commands have global impact on the sampler.
4025    
4026    
4027    
4028    
4029    
4030  Schoenebeck            Expires November 19, 2005               [Page 49]  
4031    Schoenebeck             Expires December 24, 2007              [Page 72]
4032    
4033  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4034    
4035    
4036  5.6  Global commands  6.6.1.  Current number of active voices
4037    
4038     The following commands have global impact on the sampler.     The front-end can ask for the current number of active voices on the
4039       sampler by sending the following command:
4040    
4041          GET TOTAL_VOICE_COUNT
4042    
4043       Possible Answers:
4044    
4045          LinuxSampler will answer by returning the number of all active
4046          voices on the sampler.
4047    
4048    6.6.2.  Maximum amount of active voices
4049    
4050       The front-end can ask for the maximum number of active voices by
4051       sending the following command:
4052    
4053  5.6.1  Reset sampler        GET TOTAL_VOICE_COUNT_MAX
4054    
4055       Possible Answers:
4056    
4057          LinuxSampler will answer by returning the maximum number of active
4058          voices.
4059    
4060    6.6.3.  Reset sampler
4061    
4062     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4063     command:     command:
# Line 2759  Internet-Draft       LinuxSampler Contro Line 4067  Internet-Draft       LinuxSampler Contro
4067     Possible Answers:     Possible Answers:
4068    
4069        "OK" -        "OK" -
4070    
4071           always           always
4072    
4073     Examples:     Examples:
4074    
4075    
4076    
4077    6.6.4.  General sampler informations
4078    
4079       The client can ask for general informations about the LinuxSampler
4080       instance by sending the following command:
4081    
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck             Expires December 24, 2007              [Page 73]
4088    
4089    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4090    
4091    
4092          GET SERVER INFO
4093    
4094       Possible Answers:
4095    
4096          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4097          answer line begins with the information category name followed by
4098          a colon and then a space character <SP> and finally the info
4099          character string to that information category.  At the moment the
4100          following categories are defined:
4101    
4102    
4103    
4104             DESCRIPTION -
4105    
4106                arbitrary textual description about the sampler
4107    
4108             VERSION -
4109    
4110                version of the sampler
4111    
4112             PROTOCOL_VERSION -
4113    
4114                version of the LSCP specification the sampler complies with
4115                (see Section 2 for details)
4116    
4117             INSTRUMENTS_DB_SUPPORT -
4118    
4119                either yes or no, specifies whether the sampler is build
4120                with instruments database support.
4121    
4122       The mentioned fields above don't have to be in particular order.
4123       Other fields might be added in future.
4124    
4125    6.6.5.  Getting global volume attenuation
4126    
4127       The client can ask for the current global sampler-wide volume
4128       attenuation by sending the following command:
4129    
4130          GET VOLUME
4131    
4132       Possible Answers:
4133    
4134          The sampler will always answer by returning the optional dotted
4135          floating point coefficient, reflecting the current global volume
4136          attenuation.
4137    
4138       Note: it is up to the respective sampler engine whether to obey that
4139       global volume parameter or not, but in general all engines SHOULD use
4140    
4141    
4142    
4143  Schoenebeck            Expires November 19, 2005               [Page 50]  Schoenebeck             Expires December 24, 2007              [Page 74]
4144    
4145  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4146    
4147    
4148       this parameter.
4149    
4150    6.6.6.  Setting global volume attenuation
4151    
4152       The client can alter the current global sampler-wide volume
4153       attenuation by sending the following command:
4154    
4155          SET VOLUME <volume>
4156    
4157       Where <volume> should be replaced by the optional dotted floating
4158       point value, reflecting the new global volume parameter.  This value
4159       might usually be in the range between 0.0 and 1.0, that is for
4160       attenuating the overall volume.
4161    
4162       Possible Answers:
4163    
4164          "OK" -
4165    
4166             on success
4167    
4168          "WRN:<warning-code>:<warning-message>" -
4169    
4170             if the global volume was set, but there are noteworthy issue(s)
4171             related, providing an appropriate warning code and warning
4172             message
4173    
4174          "ERR:<error-code>:<error-message>" -
4175    
4176             in case it failed, providing an appropriate error code and
4177             error message
4178    
4179  6.  Command Syntax  6.7.  MIDI Instrument Mapping
4180    
4181     TODO: will soon automatically included from src/network/lscp.y,     The MIDI protocol provides a way to switch between instruments by
4182     meanwhile have a look at that file to get the exact definition of the     sending so called MIDI bank select and MIDI program change messages
4183     command syntax.     which are essentially just numbers.  The following commands allow to
4184       actually map arbitrary MIDI bank select / program change numbers with
4185       real instruments.
4186    
4187       The sampler allows to manage an arbitrary amount of MIDI instrument
4188       maps which define which instrument to load on which MIDI program
4189       change message.
4190    
4191       By default, that is when the sampler is launched, there is no map,
4192       thus the sampler will simply ignore all program change messages.  The
4193       front-end has to explicitly create at least one map, add entries to
4194       the map and tell the respective sampler channel(s) which MIDI
4195       instrument map to use, so the sampler knows how to react on a given
4196    
4197    
4198    
4199    Schoenebeck             Expires December 24, 2007              [Page 75]
4200    
4201    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4202    
4203    
4204       program change message on the respective sampler channel, that is by
4205       switching to the respectively defined engine type and loading the
4206       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4207       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4208       channel.
4209    
4210       Also note per MIDI specification a bank select message does not cause
4211       to switch to another instrument.  Instead when receiving a bank
4212       select message the bank value will be stored and a subsequent program
4213       change message (which may occur at any time) will finally cause the
4214       sampler to switch to the respective instrument as reflected by the
4215       current MIDI instrument map.
4216    
4217    6.7.1.  Create a new MIDI instrument map
4218    
4219       The front-end can add a new MIDI instrument map by sending the
4220       following command:
4221    
4222          ADD MIDI_INSTRUMENT_MAP [<name>]
4223    
4224       Where <name> is an optional argument allowing to assign a custom name
4225       to the new map.  MIDI instrument Map names do not have to be unique.
4226    
4227       Possible Answers:
4228    
4229          "OK[<map>]" -
4230    
4231             in case a new MIDI instrument map could be added, where <map>
4232             reflects the unique ID of the newly created MIDI instrument map
4233    
4234          "ERR:<error-code>:<error-message>" -
4235    
4236             when a new map could not be created, which might never occur in
4237             practice
4238    
4239       Examples:
4240    
4241          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4242    
4243          S: "OK[0]"
4244    
4245          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4246    
4247          S: "OK[1]"
4248    
4249          C: "ADD MIDI_INSTRUMENT_MAP"
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck             Expires December 24, 2007              [Page 76]
4256    
4257    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4258    
4259    
4260          S: "OK[5]"
4261    
4262    6.7.2.  Delete one particular or all MIDI instrument maps
4263    
4264       The front-end can delete a particular MIDI instrument map by sending
4265       the following command:
4266    
4267          REMOVE MIDI_INSTRUMENT_MAP <map>
4268    
4269       Where <map> reflects the unique ID of the map to delete as returned
4270       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4271    
4272       The front-end can delete all MIDI instrument maps by sending the
4273       following command:
4274    
4275          REMOVE MIDI_INSTRUMENT_MAP ALL
4276    
4277       Possible Answers:
4278    
4279          "OK" -
4280    
4281             in case the map(s) could be deleted
4282    
4283          "ERR:<error-code>:<error-message>" -
4284    
4285             when the given map does not exist
4286    
4287       Examples:
4288    
4289          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4290    
4291          S: "OK"
4292    
4293          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4294    
4295          S: "OK"
4296    
4297    6.7.3.  Get amount of existing MIDI instrument maps
4298    
4299       The front-end can retrieve the current amount of MIDI instrument maps
4300       by sending the following command:
4301    
4302          GET MIDI_INSTRUMENT_MAPS
4303    
4304  Schoenebeck            Expires November 19, 2005               [Page 51]     Possible Answers:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck             Expires December 24, 2007              [Page 77]
4312    
4313    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4314    
4315    
4316          The sampler will answer by returning the current number of MIDI
4317          instrument maps.
4318    
4319       Example:
4320    
4321          C: "GET MIDI_INSTRUMENT_MAPS"
4322    
4323          S: "2"
4324    
4325    6.7.4.  Getting all created MIDI instrument maps
4326    
4327       The number of MIDI instrument maps can change on runtime.  To get the
4328       current list of MIDI instrument maps, the front-end can send the
4329       following command:
4330    
4331          LIST MIDI_INSTRUMENT_MAPS
4332    
4333       Possible Answers:
4334    
4335          The sampler will answer by returning a comma separated list with
4336          all MIDI instrument maps' numerical IDs.
4337    
4338       Example:
4339    
4340          C: "LIST MIDI_INSTRUMENT_MAPS"
4341    
4342          S: "0,1,5,12"
4343    
4344    6.7.5.  Getting MIDI instrument map information
4345    
4346       The front-end can ask for the current settings of a MIDI instrument
4347       map by sending the following command:
4348    
4349          GET MIDI_INSTRUMENT_MAP INFO <map>
4350    
4351       Where <map> is the numerical ID of the map the front-end is
4352       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4353       (Section 6.7.4) command.
4354    
4355       Possible Answers:
4356    
4357          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4358          answer line begins with the settings category name followed by a
4359          colon and then a space character <SP> and finally the info
4360          character string to that setting category.  At the moment the
4361          following categories are defined:
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck             Expires December 24, 2007              [Page 78]
4368    
4369    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4370    
4371    
4372    
4373    
4374             NAME -
4375    
4376                custom name of the given map, which does not have to be
4377                unique
4378    
4379             DEFAULT -
4380    
4381                either true or false, defines whether this map is the
4382                default map
4383    
4384       The mentioned fields above don't have to be in particular order.
4385    
4386       Example:
4387    
4388          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4389    
4390          S: "NAME: Standard Map"
4391    
4392             "DEFAULT: true"
4393    
4394             "."
4395    
4396    6.7.6.  Renaming a MIDI instrument map
4397    
4398       The front-end can alter the custom name of a MIDI instrument map by
4399       sending the following command:
4400    
4401          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4402    
4403       Where <map> is the numerical ID of the map and <name> the new custom
4404       name of the map, which does not have to be unique.
4405    
4406       Possible Answers:
4407    
4408          "OK" -
4409    
4410             on success
4411    
4412          "ERR:<error-code>:<error-message>" -
4413    
4414             in case the given map does not exist
4415    
4416       Example:
4417    
4418    
4419    
4420    
4421    
4422    
4423    Schoenebeck             Expires December 24, 2007              [Page 79]
4424    
4425  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4426    
4427    
4428  7.  Events        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4429    
4430          S: "OK"
4431    
4432    6.7.7.  Create or replace a MIDI instrument map entry
4433    
4434       The front-end can create a new or replace an existing entry in a
4435       sampler's MIDI instrument map by sending the following command:
4436    
4437          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4438          <engine_name> <filename> <instrument_index> <volume_value>
4439          [<instr_load_mode>] [<name>]
4440    
4441       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4442       integer value between 0..16383 reflecting the MIDI bank select index,
4443       <midi_prog> an integer value between 0..127 reflecting the MIDI
4444       program change index, <engine_name> a sampler engine name as returned
4445       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4446       encapsulated into apostrophes), <filename> the name of the
4447       instrument's file to be deployed (encapsulated into apostrophes,
4448       supporting escape sequences as described in chapter "Character Set
4449       and Escape Sequences (Section 7.1)"), <instrument_index> the index
4450       (integer value) of the instrument within the given file,
4451       <volume_value> reflects the master volume of the instrument as
4452       optionally dotted number (where a value < 1.0 means attenuation and a
4453       value > 1.0 means amplification).  This parameter easily allows to
4454       adjust the volume of all intruments within a custom instrument map
4455       without having to adjust their instrument files.  The OPTIONAL
4456       <instr_load_mode> argument defines the life time of the instrument,
4457       that is when the instrument should be loaded, when freed and has
4458       exactly the following possibilities:
4459    
4460          "ON_DEMAND" -
4461    
4462             The instrument will be loaded when needed, that is when
4463             demanded by at least one sampler channel.  It will immediately
4464             be freed from memory when not needed by any sampler channel
4465             anymore.
4466    
4467          "ON_DEMAND_HOLD" -
4468    
4469             The instrument will be loaded when needed, that is when
4470             demanded by at least one sampler channel.  It will be kept in
4471             memory even when not needed by any sampler channel anymore.
4472             Instruments with this mode are only freed when the sampler is
4473             reset or all mapping entries with this mode (and respective
4474             instrument) are explicitly changed to "ON_DEMAND" and no
4475             sampler channel is using the instrument anymore.
4476    
4477    
4478    
4479    Schoenebeck             Expires December 24, 2007              [Page 80]
4480    
4481    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4482    
4483    
4484          "PERSISTENT" -
4485    
4486             The instrument will immediately be loaded into memory when this
4487             mapping command is sent and the instrument is kept all the
4488             time.  Instruments with this mode are only freed when the
4489             sampler is reset or all mapping entries with this mode (and
4490             respective instrument) are explicitly changed to "ON_DEMAND"
4491             and no sampler channel is using the instrument anymore.
4492    
4493          not supplied -
4494    
4495             In case there is no <instr_load_mode> argument given, it will
4496             be up to the InstrumentManager to decide which mode to use.
4497             Usually it will use "ON_DEMAND" if an entry for the given
4498             instrument does not exist in the InstrumentManager's list yet,
4499             otherwise if an entry already exists, it will simply stick with
4500             the mode currently reflected by the already existing entry,
4501             that is it will not change the mode.
4502    
4503       The <instr_load_mode> argument thus allows to define an appropriate
4504       strategy (low memory consumption vs. fast instrument switching) for
4505       each instrument individually.  Note, the following restrictions apply
4506       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4507       supported by the respective sampler engine (which is technically the
4508       case when the engine provides an InstrumentManager for its format).
4509       If this is not the case the argument will automatically fall back to
4510       the default value "ON_DEMAND".  Also the load mode of one instrument
4511       may automatically change the laod mode of other instrument(s), i.e.
4512       because the instruments are part of the same file and the engine does
4513       not allow a way to manage load modes for them individually.  Due to
4514       this, in case the frontend shows the load modes of entries, the
4515       frontend should retrieve the actual mode by i.e. sending "GET
4516       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4517       OPTIONAL <name> argument allows to set a custom name (encapsulated
4518       into apostrophes) for the mapping entry, useful for frontends for
4519       displaying an appropriate name for mapped instruments (using "GET
4520       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4521    
4522       By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4523       completely established in the sampler.  The OPTIONAL "NON_MODAL"
4524       argument however causes the respective "MAP MIDI_INSTRUMENT" command
4525       to return immediately, that is to let the sampler establish the
4526       mapping in the background.  So this argument might be especially
4527       useful for mappings with a "PERSISTENT" type, because these have to
4528       load the respective instruments immediately and might thus block for
4529       a very long time.  It is recommended however to use the OPTIONAL
4530       "NON_MODAL" argument only if really necessary, because it has the
4531       following drawbacks: as "NON_MODAL" instructions return immediately,
4532    
4533    
4534    
4535    Schoenebeck             Expires December 24, 2007              [Page 81]
4536    
4537    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4538    
4539    
4540       they may not necessarily return an error i.e. when the given
4541       instrument file turns out to be corrupt, beside that subsequent
4542       commands in a LSCP instruction sequence might fail, because mandatory
4543       mappings are not yet completed.
4544    
4545       Possible Answers:
4546    
4547          "OK" -
4548    
4549             usually
4550    
4551          "ERR:<error-code>:<error-message>" -
4552    
4553             when the given map or engine does not exist or a value is out
4554             of range
4555    
4556       Examples:
4557    
4558          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4559          0.8 PERSISTENT"
4560    
4561          S: "OK"
4562    
4563          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4564          1.0"
4565    
4566          S: "OK"
4567    
4568          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4569          'Normal Piano'"
4570    
4571          S: "OK"
4572    
4573          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4574          'Silent Piano'"
4575    
4576          S: "OK"
4577    
4578          C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4579          foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4580    
4581          S: "OK"
4582    
4583    6.7.8.  Getting ammount of MIDI instrument map entries
4584    
4585       The front-end can query the amount of currently existing entries in a
4586       MIDI instrument map by sending the following command:
4587    
4588    
4589    
4590    
4591    Schoenebeck             Expires December 24, 2007              [Page 82]
4592    
4593    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4594    
4595    
4596          GET MIDI_INSTRUMENTS <map>
4597    
4598       The front-end can query the amount of currently existing entries in
4599       all MIDI instrument maps by sending the following command:
4600    
4601          GET MIDI_INSTRUMENTS ALL
4602    
4603       Possible Answers:
4604    
4605          The sampler will answer by sending the current number of entries
4606          in the MIDI instrument map(s).
4607    
4608       Example:
4609    
4610          C: "GET MIDI_INSTRUMENTS 0"
4611    
4612          S: "234"
4613    
4614          C: "GET MIDI_INSTRUMENTS ALL"
4615    
4616          S: "954"
4617    
4618    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4619    
4620       The front-end can query a list of all currently existing entries in a
4621       certain MIDI instrument map by sending the following command:
4622    
4623          LIST MIDI_INSTRUMENTS <map>
4624    
4625       Where <map> is the numeric ID of the MIDI instrument map.
4626    
4627       The front-end can query a list of all currently existing entries of
4628       all MIDI instrument maps by sending the following command:
4629    
4630          LIST MIDI_INSTRUMENTS ALL
4631    
4632       Possible Answers:
4633    
4634          The sampler will answer by sending a comma separated list of map
4635          ID - MIDI bank - MIDI program triples, where each triple is
4636          encapsulated into curly braces.  The list is returned in one
4637          single line.  Each triple just reflects the key of the respective
4638          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4639          (Section 6.7.11) command(s) are necessary to retrieve detailed
4640          informations about each entry.
4641    
4642       Example:
4643    
4644    
4645    
4646    
4647    Schoenebeck             Expires December 24, 2007              [Page 83]
4648    
4649    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4650    
4651    
4652          C: "LIST MIDI_INSTRUMENTS 0"
4653    
4654          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4655    
4656    6.7.10.  Remove an entry from the MIDI instrument map
4657    
4658       The front-end can delete an entry from a MIDI instrument map by
4659       sending the following command:
4660    
4661          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4662    
4663       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4664       is an integer value between 0..16383 reflecting the MIDI bank value
4665       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4666       program value of the map's entrie's key index triple.
4667    
4668       Possible Answers:
4669    
4670          "OK" -
4671    
4672             usually
4673    
4674          "ERR:<error-code>:<error-message>" -
4675    
4676             when index out of bounds
4677    
4678       Example:
4679    
4680          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4681    
4682          S: "OK"
4683    
4684    6.7.11.  Get current settings of MIDI instrument map entry
4685    
4686       The front-end can retrieve the current settings of a certain
4687       instrument map entry by sending the following command:
4688    
4689          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4690    
4691       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4692       is an integer value between 0..16383 reflecting the MIDI bank value,
4693       <midi_bank> and <midi_prog> an integer value between 0..127
4694       reflecting the MIDI program value of the map's entrie's key index
4695       triple.
4696    
4697       Possible Answers:
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck             Expires December 24, 2007              [Page 84]
4704    
4705    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4706    
4707    
4708          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4709          answer line begins with the information category name followed by
4710          a colon and then a space character <SP> and finally the info
4711          character string to that info category.  At the moment the
4712          following categories are defined:
4713    
4714          "NAME" -
4715    
4716             Name for this MIDI instrument map entry (if defined).  This
4717             name shall be used by frontends for displaying a name for this
4718             mapped instrument.  It can be set and changed with the "MAP
4719             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4720             be unique.
4721    
4722          "ENGINE_NAME" -
4723    
4724             Name of the engine to be deployed for this instrument.
4725    
4726          "INSTRUMENT_FILE" -
4727    
4728             File name of the instrument.
4729    
4730          "INSTRUMENT_NR" -
4731    
4732             Index of the instrument within the file.
4733    
4734          "INSTRUMENT_NAME" -
4735    
4736             Name of the loaded instrument as reflected by its file.  In
4737             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4738             cannot be changed.
4739    
4740          "LOAD_MODE" -
4741    
4742             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4743             (Section 6.7.7) for details about this setting).
4744    
4745          "VOLUME" -
4746    
4747             master volume of the instrument as optionally dotted number
4748             (where a value < 1.0 means attenuation and a value > 1.0 means
4749             amplification)
4750    
4751          The mentioned fields above don't have to be in particular order.
4752    
4753       Example:
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck             Expires December 24, 2007              [Page 85]
4760    
4761    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4762    
4763    
4764          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4765    
4766          S: "NAME: Drums for Foo Song"
4767    
4768             "ENGINE_NAME: GigEngine"
4769    
4770             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4771    
4772             "INSTRUMENT_NR: 0"
4773    
4774             "INSTRUMENT_NAME: Joe's Drumkit"
4775    
4776             "LOAD_MODE: PERSISTENT"
4777    
4778             "VOLUME: 1.0"
4779    
4780             "."
4781    
4782    6.7.12.  Clear MIDI instrument map
4783    
4784       The front-end can clear a whole MIDI instrument map, that is delete
4785       all its entries by sending the following command:
4786    
4787          CLEAR MIDI_INSTRUMENTS <map>
4788    
4789       Where <map> is the numeric ID of the map to clear.
4790    
4791       The front-end can clear all MIDI instrument maps, that is delete all
4792       entries of all maps by sending the following command:
4793    
4794          CLEAR MIDI_INSTRUMENTS ALL
4795    
4796       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4797       only their entries, thus the map's settings like custom name will be
4798       preservevd.
4799    
4800       Possible Answers:
4801    
4802          "OK" -
4803    
4804             always
4805    
4806       Examples:
4807    
4808          C: "CLEAR MIDI_INSTRUMENTS 0"
4809    
4810          S: "OK"
4811    
4812    
4813    
4814    
4815    Schoenebeck             Expires December 24, 2007              [Page 86]
4816    
4817    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4818    
4819    
4820          C: "CLEAR MIDI_INSTRUMENTS ALL"
4821    
4822          S: "OK"
4823    
4824    6.8.  Managing Instruments Database
4825    
4826       The following commands describe how to use and manage the instruments
4827       database.
4828    
4829    6.8.1.  Creating a new instrument directory
4830    
4831       The front-end can add a new instrument directory to the instruments
4832       database by sending the following command:
4833    
4834          ADD DB_INSTRUMENT_DIRECTORY <dir>
4835    
4836       Where <dir> is the absolute path name of the directory to be created
4837       (encapsulated into apostrophes).
4838    
4839       Possible Answers:
4840    
4841          "OK" -
4842    
4843             on success
4844    
4845          "ERR:<error-code>:<error-message>" -
4846    
4847             when the directory could not be created, which can happen if
4848             the directory already exists or the name contains not allowed
4849             symbols
4850    
4851       Examples:
4852    
4853          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4854    
4855          S: "OK"
4856    
4857    6.8.2.  Deleting an instrument directory
4858    
4859       The front-end can delete a particular instrument directory from the
4860       instruments database by sending the following command:
4861    
4862          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4863    
4864       Where <dir> is the absolute path name of the directory to delete.
4865       The optional FORCE argument can be used to force the deletion of a
4866       non-empty directory and all its content.
4867    
4868    
4869    
4870    
4871    Schoenebeck             Expires December 24, 2007              [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4874    
4875    
4876       Possible Answers:
4877    
4878          "OK" -
4879    
4880             if the directory is deleted successfully
4881    
4882          "ERR:<error-code>:<error-message>" -
4883    
4884             if the given directory does not exist, or if trying to delete a
4885             non-empty directory, without using the FORCE argument.
4886    
4887       Examples:
4888    
4889          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4890    
4891          S: "OK"
4892    
4893    6.8.3.  Getting amount of instrument directories
4894    
4895       The front-end can retrieve the current amount of directories in a
4896       specific directory by sending the following command:
4897    
4898          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4899    
4900       Where <dir> should be replaced by the absolute path name of the
4901       directory.  If RECURSIVE is specified, the number of all directories,
4902       including those located in subdirectories of the specified directory,
4903       will be returned.
4904    
4905       Possible Answers:
4906    
4907          The current number of instrument directories in the specified
4908          directory.
4909    
4910          "ERR:<error-code>:<error-message>" -
4911    
4912             if the given directory does not exist.
4913    
4914       Example:
4915    
4916          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4917    
4918          S: "2"
4919    
4920    
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck             Expires December 24, 2007              [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4930    
4931    
4932    6.8.4.  Listing all directories in specific directory
4933    
4934       The front-end can retrieve the current list of directories in
4935       specific directory by sending the following command:
4936    
4937          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4938    
4939       Where <dir> should be replaced by the absolute path name of the
4940       directory.  If RECURSIVE is specified, the absolute path names of all
4941       directories, including those located in subdirectories of the
4942       specified directory, will be returned.
4943    
4944       Possible Answers:
4945    
4946          A comma separated list of all instrument directories (encapsulated
4947          into apostrophes) in the specified directory.
4948    
4949          "ERR:<error-code>:<error-message>" -
4950    
4951             if the given directory does not exist.
4952    
4953       Example:
4954    
4955          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4956    
4957          S: "'Piano Collection','Percussion Collection'"
4958    
4959          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
4960    
4961          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
4962          Collection/Acoustic/New','/Percussion Collection'"
4963    
4964    6.8.5.  Getting instrument directory information
4965    
4966       The front-end can ask for the current settings of an instrument
4967       directory by sending the following command:
4968    
4969          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4970    
4971       Where <dir> should be replaced by the absolute path name of the
4972       directory the front-end is interested in.
4973    
4974       Possible Answers:
4975    
4976          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4977          answer line begins with the settings category name followed by a
4978          colon and then a space character <SP> and finally the info
4979          character string to that setting category.  At the moment the
4980    
4981    
4982    
4983    Schoenebeck             Expires December 24, 2007              [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
4986    
4987    
4988          following categories are defined:
4989    
4990    
4991    
4992             DESCRIPTION -
4993    
4994                A brief description of the directory content
4995    
4996             CREATED -
4997    
4998                The creation date and time of the directory, represented in
4999                "YYYY-MM-DD HH:MM:SS" format
5000    
5001             MODIFIED -
5002    
5003                The date and time of the last modification of the directory,
5004                represented in "YYYY-MM-DD HH:MM:SS" format
5005    
5006       The mentioned fields above don't have to be in particular order.
5007    
5008       Example:
5009    
5010          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5011    
5012          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5013          format."
5014    
5015             "CREATED: 2007-02-05 10:23:12"
5016    
5017             "MODIFIED: 2007-04-07 12:50:21"
5018    
5019             "."
5020    
5021    6.8.6.  Renaming an instrument directory
5022    
5023       The front-end can alter the name of a specific instrument directory
5024       by sending the following command:
5025    
5026          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5027    
5028       Where <dir> is the absolute path name of the directory and <name> is
5029       the new name for that directory.
5030    
5031       Possible Answers:
5032    
5033          "OK" -
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck             Expires December 24, 2007              [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5042    
5043    
5044             on success
5045    
5046          "ERR:<error-code>:<error-message>" -
5047    
5048             in case the given directory does not exists, or if a directory
5049             with name equal to the new name already exists.
5050    
5051       Example:
5052    
5053          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5054          'Acoustic'"
5055    
5056          S: "OK"
5057    
5058    6.8.7.  Moving an instrument directory
5059    
5060       The front-end can move a specific instrument directory by sending the
5061       following command:
5062    
5063          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5064    
5065       Where <dir> is the absolute path name of the directory to move and
5066       <dst> is the location where the directory will be moved to.
5067    
5068       Possible Answers:
5069    
5070          "OK" -
5071    
5072             on success
5073    
5074          "ERR:<error-code>:<error-message>" -
5075    
5076             in case a given directory does not exists, or if a directory
5077             with name equal to the name of the specified directory already
5078             exists in the destination directory.  Error is also thrown when
5079             trying to move a directory to a subdirectory of itself.
5080    
5081       Example:
5082    
5083          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5084          Acoustic'"
5085    
5086          S: "OK"
5087    
5088    
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck             Expires December 24, 2007              [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5098    
5099    
5100    6.8.8.  Copying instrument directories
5101    
5102       The front-end can copy a specific instrument directory by sending the
5103       following command:
5104    
5105          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5106    
5107       Where <dir> is the absolute path name of the directory to copy and
5108       <dst> is the location where the directory will be copied to.
5109    
5110       Possible Answers:
5111    
5112          "OK" -
5113    
5114             on success
5115    
5116          "ERR:<error-code>:<error-message>" -
5117    
5118             in case a given directory does not exists, or if a directory
5119             with name equal to the name of the specified directory already
5120             exists in the destination directory.  Error is also thrown when
5121             trying to copy a directory to a subdirectory of itself.
5122    
5123       Example:
5124    
5125          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5126          '/Acoustic/Pianos'"
5127    
5128          S: "OK"
5129    
5130    6.8.9.  Changing the description of directory
5131    
5132       The front-end can alter the description of a specific instrument
5133       directory by sending the following command:
5134    
5135          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5136    
5137       Where <dir> is the absolute path name of the directory and <desc> is
5138       the new description for the directory.
5139    
5140       Possible Answers:
5141    
5142          "OK" -
5143    
5144             on success
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck             Expires December 24, 2007              [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5154    
5155    
5156          "ERR:<error-code>:<error-message>" -
5157    
5158             in case the given directory does not exists.
5159    
5160       Example:
5161    
5162          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5163          collection of piano instruments in various format.'"
5164    
5165          S: "OK"
5166    
5167    6.8.10.  Finding directories
5168    
5169       The front-end can search for directories in specific directory by
5170       sending the following command:
5171    
5172          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5173          list>
5174    
5175       Where <dir> should be replaced by the absolute path name of the
5176       directory to search in.  If NON_RECURSIVE is specified, the
5177       directories located in subdirectories of the specified directory will
5178       not be searched. <criteria-list> is a list of search criterias in
5179       form of "key1=val1 key2=val2 ...".  The following criterias are
5180       allowed:
5181    
5182       NAME='<search-string>'
5183    
5184          Restricts the search to directories, which names satisfy the
5185          supplied search string.
5186    
5187       CREATED='[<date-after>]..[<date-before>]'
5188    
5189          Restricts the search to directories, which creation date satisfies
5190          the specified period, where <date-after> and <date-before> are in
5191          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5192          search is restricted to directories created before <date-before>.
5193          If <date-before> is omitted, the search is restricted to
5194          directories created after <date-after>.
5195    
5196       MODIFIED='[<date-after>]..[<date-before>]'
5197    
5198          Restricts the search to directories, which date of last
5199          modification satisfies the specified period, where <date-after>
5200          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5201          after> is omitted the search is restricted to directories, which
5202          are last modified before <date-before>.  If <date-before> is
5203          omitted, the search is restricted to directories, which are last
5204    
5205    
5206    
5207    Schoenebeck             Expires December 24, 2007              [Page 93]
5208    
5209    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5210    
5211    
5212          modified after <date-after>.
5213    
5214       DESCRIPTION='<search-string>'
5215    
5216          Restricts the search to directories with description that
5217          satisfies the supplied search string.
5218    
5219       Where <search-string> is either a regular expression, or a word list
5220       separated with spaces for OR search and with '+' for AND search.
5221    
5222       Possible Answers:
5223    
5224          A comma separated list with the absolute path names (encapsulated
5225          into apostrophes) of all directories in the specified directory
5226          that satisfy the supplied search criterias.
5227    
5228          "ERR:<error-code>:<error-message>" -
5229    
5230             if the given directory does not exist.
5231    
5232       Example:
5233    
5234          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5235    
5236          S: "'/Piano Collection'"
5237    
5238          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5239          30:13'"
5240    
5241          S: "'/Piano Collection','/Percussions'"
5242    
5243    6.8.11.  Adding instruments to the instruments database
5244    
5245       The front-end can add one or more instruments to the instruments
5246       database by sending the following command:
5247    
5248          ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>
5249          [<instr_index>]
5250    
5251       Where <db_dir> is the absolute path name of a directory (encapsulated
5252       into apostrophes) in the instruments database in which only the new
5253       instruments (that are not already in the database) will be added,
5254       <file_path> is the absolute path name of a file or directory in the
5255       file system (encapsulated into apostrophes).  In case an instrument
5256       file is supplied, only the instruments in the specified file will be
5257       added to the instruments database.  If the optional <instr_index>
5258       (the index of the instrument within the given file) is supplied too,
5259       then only the specified instrument will be added.  In case a
5260    
5261    
5262    
5263    Schoenebeck             Expires December 24, 2007              [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5266    
5267    
5268       directory is supplied, the instruments in that directory will be
5269       added.  The OPTIONAL <mode> argument is only applied when a directory
5270       is provided as <file_path> and specifies how the scanning will be
5271       done and has exactly the following possibilities:
5272    
5273          "RECURSIVE" -
5274    
5275             All instruments will be processed, including those in the
5276             subdirectories, and the respective subdirectory tree structure
5277             will be recreated in the instruments database
5278    
5279          "NON_RECURSIVE" -
5280    
5281             Only the instruments in the specified directory will be added,
5282             the instruments in the subdirectories will not be processed.
5283    
5284          "FLAT" -
5285    
5286             All instruments will be processed, including those in the
5287             subdirectories, but the respective subdirectory structure will
5288             not be recreated in the instruments database.  All instruments
5289             will be added directly in the specified database directory.
5290    
5291       The difference between regular and NON_MODAL versions of the command
5292       is that the regular command returns when the scanning is finished
5293       while NON_MODAL version returns immediately and a background process
5294       is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5295       command can be used to monitor the scanning progress.
5296    
5297       Possible Answers:
5298    
5299          "OK" -
5300    
5301             on success when NON_MODAL is not supplied
5302    
5303          "OK[<job-id>]" -
5304    
5305             on success when NON_MODAL is supplied, where <job-id> is a
5306             numerical ID used to obtain status information about the job
5307             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5308    
5309          "ERR:<error-code>:<error-message>" -
5310    
5311             if an invalid path is specified.
5312    
5313       Examples:
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck             Expires December 24, 2007              [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5322    
5323    
5324          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5325          Bosendorfer 290.gig' 0"
5326    
5327          S: "OK"
5328    
5329    6.8.12.  Removing an instrument
5330    
5331       The front-end can remove a particular instrument from the instruments
5332       database by sending the following command:
5333    
5334          REMOVE DB_INSTRUMENT <instr_path>
5335    
5336       Where <instr_path> is the absolute path name (in the instruments
5337       database) of the instrument to remove.
5338    
5339       Possible Answers:
5340    
5341          "OK" -
5342    
5343             if the instrument is removed successfully
5344    
5345          "ERR:<error-code>:<error-message>" -
5346    
5347             if the given path does not exist or is a directory.
5348    
5349       Examples:
5350    
5351          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5352    
5353          S: "OK"
5354    
5355    6.8.13.  Getting amount of instruments
5356    
5357       The front-end can retrieve the current amount of instruments in a
5358       specific directory by sending the following command:
5359    
5360          GET DB_INSTRUMENTS [RECURSIVE] <dir>
5361    
5362       Where <dir> should be replaced by the absolute path name of the
5363       directory.  If RECURSIVE is specified, the number of all instruments,
5364       including those located in subdirectories of the specified directory,
5365       will be returned.
5366    
5367       Possible Answers:
5368    
5369          The current number of instruments in the specified directory.
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck             Expires December 24, 2007              [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5378    
5379    
5380          "ERR:<error-code>:<error-message>" -
5381    
5382             if the given directory does not exist.
5383    
5384       Example:
5385    
5386          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5387    
5388          S: "2"
5389    
5390    6.8.14.  Listing all instruments in specific directory
5391    
5392       The front-end can retrieve the current list of instruments in
5393       specific directory by sending the following command:
5394    
5395          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5396    
5397       Where <dir> should be replaced by the absolute path name of the
5398       directory.  If RECURSIVE is specified, the absolute path names of all
5399       instruments, including those located in subdirectories of the
5400       specified directory, will be returned.
5401    
5402       Possible Answers:
5403    
5404          A comma separated list of all instruments (encapsulated into
5405          apostrophes) in the specified directory.
5406    
5407          "ERR:<error-code>:<error-message>" -
5408    
5409             if the given directory does not exist.
5410    
5411       Example:
5412    
5413          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5414    
5415          S: "'Bosendorfer 290','Steinway D'"
5416    
5417          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5418    
5419          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5420          Steinway D','/Piano Collection/Lite/Free Piano'"
5421    
5422    6.8.15.  Getting instrument information
5423    
5424       The front-end can ask for the current settings of an instrument by
5425       sending the following command:
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck             Expires December 24, 2007              [Page 97]
5432    
5433    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5434    
5435    
5436          GET DB_INSTRUMENT INFO <instr_path>
5437    
5438       Where <instr_path> should be replaced by the absolute path name of
5439       the instrument the front-end is interested in.
5440    
5441       Possible Answers:
5442    
5443          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5444          answer line begins with the settings category name followed by a
5445          colon and then a space character <SP> and finally the info
5446          character string to that setting category.  At the moment the
5447          following categories are defined:
5448    
5449    
5450    
5451             INSTRUMENT_FILE -
5452    
5453                File name of the instrument.
5454    
5455             INSTRUMENT_NR -
5456    
5457                Index of the instrument within the file.
5458    
5459             FORMAT_FAMILY -
5460    
5461                The format family of the instrument.
5462    
5463             FORMAT_VERSION -
5464    
5465                The format version of the instrument.
5466    
5467             SIZE -
5468    
5469                The size of the instrument in bytes.
5470    
5471             CREATED -
5472    
5473                The date and time when the instrument is added in the
5474                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5475                format
5476    
5477             MODIFIED -
5478    
5479                The date and time of the last modification of the
5480                instrument's database settings, represented in "YYYY-MM-DD
5481                HH:MM:SS" format
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires December 24, 2007              [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5490    
5491    
5492             DESCRIPTION -
5493    
5494                A brief description of the instrument
5495    
5496             IS_DRUM -
5497    
5498                either true or false, determines whether the instrument is a
5499                drumkit or a chromatic instrument
5500    
5501             PRODUCT -
5502    
5503                The product title of the instrument
5504    
5505             ARTISTS -
5506    
5507                Lists the artist names
5508    
5509             KEYWORDS -
5510    
5511                Provides a list of keywords that refer to the instrument.
5512                Keywords are separated with semicolon and blank.
5513    
5514       The mentioned fields above don't have to be in particular order.
5515    
5516       Example:
5517    
5518          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5519    
5520          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5521    
5522             "INSTRUMENT_NR: 0"
5523    
5524             "FORMAT_FAMILY: GIG"
5525    
5526             "FORMAT_VERSION: 2"
5527    
5528             "SIZE: 2050871870"
5529    
5530             "CREATED: 2007-02-05 10:23:12"
5531    
5532             "MODIFIED: 2007-04-07 12:50:21"
5533    
5534             "DESCRIPTION: "
5535    
5536             "IS_DRUM: false"
5537    
5538             "PRODUCT: GRANDIOSO Bosendorfer 290"
5539    
5540    
5541    
5542    
5543    Schoenebeck             Expires December 24, 2007              [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5546    
5547    
5548             "ARTISTS: Post Musical Instruments"
5549    
5550             "KEYWORDS: Bosendorfer"
5551    
5552             "."
5553    
5554    6.8.16.  Renaming an instrument
5555    
5556       The front-end can alter the name of a specific instrument by sending
5557       the following command:
5558    
5559          SET DB_INSTRUMENT NAME <instr> <name>
5560    
5561       Where <instr> is the absolute path name of the instrument and <name>
5562       is the new name for that instrument.
5563    
5564       Possible Answers:
5565    
5566          "OK" -
5567    
5568             on success
5569    
5570          "ERR:<error-code>:<error-message>" -
5571    
5572             in case the given instrument does not exists, or if an
5573             instrument with name equal to the new name already exists.
5574    
5575       Example:
5576    
5577          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5578          'Bosendorfer 290'"
5579    
5580          S: "OK"
5581    
5582    6.8.17.  Moving an instrument
5583    
5584       The front-end can move a specific instrument to another directory by
5585       sending the following command:
5586    
5587          MOVE DB_INSTRUMENT <instr> <dst>
5588    
5589       Where <instr> is the absolute path name of the instrument to move and
5590       <dst> is the directory where the instrument will be moved to.
5591    
5592       Possible Answers:
5593    
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck             Expires December 24, 2007             [Page 100]
5600    
5601    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5602    
5603    
5604          "OK" -
5605    
5606             on success
5607    
5608          "ERR:<error-code>:<error-message>" -
5609    
5610             in case the given instrument does not exists, or if an
5611             instrument with name equal to the name of the specified
5612             instrument already exists in the destination directory.
5613    
5614       Example:
5615    
5616          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5617          Collection/Acoustic'"
5618    
5619          S: "OK"
5620    
5621    6.8.18.  Copying instruments
5622    
5623       The front-end can copy a specific instrument to another directory by
5624       sending the following command:
5625    
5626          COPY DB_INSTRUMENT <instr> <dst>
5627    
5628       Where <instr> is the absolute path name of the instrument to copy and
5629       <dst> is the directory where the instrument will be copied to.
5630    
5631       Possible Answers:
5632    
5633          "OK" -
5634    
5635             on success
5636    
5637          "ERR:<error-code>:<error-message>" -
5638    
5639             in case the given instrument does not exists, or if an
5640             instrument with name equal to the name of the specified
5641             instrument already exists in the destination directory.
5642    
5643       Example:
5644    
5645          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5646          '/Acoustic/Pianos/'"
5647    
5648          S: "OK"
5649    
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck             Expires December 24, 2007             [Page 101]
5656    
5657    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5658    
5659    
5660    6.8.19.  Changing the description of instrument
5661    
5662       The front-end can alter the description of a specific instrument by
5663       sending the following command:
5664    
5665          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5666    
5667       Where <instr> is the absolute path name of the instrument and <desc>
5668       is the new description for the instrument.
5669    
5670       Possible Answers:
5671    
5672          "OK" -
5673    
5674             on success
5675    
5676          "ERR:<error-code>:<error-message>" -
5677    
5678             in case the given instrument does not exists.
5679    
5680       Example:
5681    
5682          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5683          Bosendorfer 290' 'No comment :)'"
5684    
5685          S: "OK"
5686    
5687    6.8.20.  Finding instruments
5688    
5689       The front-end can search for instruments in specific directory by
5690       sending the following command:
5691    
5692          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5693    
5694       Where <dir> should be replaced by the absolute path name of the
5695       directory to search in.  If NON_RECURSIVE is specified, the
5696       directories located in subdirectories of the specified directory will
5697       not be searched. <criteria-list> is a list of search criterias in
5698       form of "key1=val1 key2=val2 ...".  The following criterias are
5699       allowed:
5700    
5701       NAME='<search-string>'
5702    
5703          Restricts the search to instruments, which names satisfy the
5704          supplied search string.
5705    
5706       SIZE=[<min>]..[<max>]
5707    
5708    
5709    
5710    
5711    Schoenebeck             Expires December 24, 2007             [Page 102]
5712    
5713    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5714    
5715    
5716          Restricts the search to instruments, which size is in the
5717          specified range.  If <min> is omitted, the search results are
5718          restricted to instruments with size less then or equal to <max>.
5719          If <max> is omitted, the search is restricted to instruments with
5720          size greater then or equal to <min>.
5721    
5722       CREATED='[<date-after>]..[<date-before>]'
5723    
5724          Restricts the search to instruments, which creation date satisfies
5725          the specified period, where <date-after> and <date-before> are in
5726          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5727          search is restricted to instruments created before <date-before>.
5728          If <date-before> is omitted, the search is restricted to
5729          instruments created after <date-after>.
5730    
5731       MODIFIED='[<date-after>]..[<date-before>]'
5732    
5733          Restricts the search to instruments, which date of last
5734          modification satisfies the specified period, where <date-after>
5735          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5736          after> is omitted the search is restricted to instruments, which
5737          are last modified before <date-before>.  If <date-before> is
5738          omitted, the search is restricted to instruments, which are last
5739          modified after <date-after>.
5740    
5741       DESCRIPTION='<search-string>'
5742    
5743          Restricts the search to instruments with description that
5744          satisfies the supplied search string.
5745    
5746       PRODUCT='<search-string>'
5747    
5748          Restricts the search to instruments with product info that
5749          satisfies the supplied search string.
5750    
5751       ARTISTS='<search-string>'
5752    
5753          Restricts the search to instruments with artists info that
5754          satisfies the supplied search string.
5755    
5756       KEYWORDS='<search-string>'
5757    
5758          Restricts the search to instruments with keyword list that
5759          satisfies the supplied search string.
5760    
5761       IS_DRUM=true | false
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck             Expires December 24, 2007             [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5770    
5771    
5772          Either true or false.  Restricts the search to drum kits or
5773          chromatic instruments.
5774    
5775       FORMAT_FAMILIES='<format-list>'
5776    
5777          Restricts the search to instruments of the supplied format
5778          families, where <format-list> is a comma separated list of format
5779          families.
5780    
5781       Where <search-string> is either a regular expression, or a word list
5782       separated with spaces for OR search and with '+' for AND search.
5783    
5784       Possible Answers:
5785    
5786          A comma separated list with the absolute path names (encapsulated
5787          into apostrophes) of all instruments in the specified directory
5788          that satisfy the supplied search criterias.
5789    
5790          "ERR:<error-code>:<error-message>" -
5791    
5792             if the given directory does not exist.
5793    
5794       Example:
5795    
5796          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5797          290'"
5798    
5799          S: "'/Piano Collection/Bosendorfer 290'"
5800    
5801          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5802          09:30:13..'"
5803    
5804          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5805          Steinway D'"
5806    
5807    6.8.21.  Getting job status information
5808    
5809       The front-end can ask for the current status of a particular database
5810       instruments job by sending the following command:
5811    
5812          GET DB_INSTRUMENTS_JOB INFO <job-id>
5813    
5814       Where <job-id> should be replaced by the numerical ID of the job the
5815       front-end is interested in.
5816    
5817       Possible Answers:
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck             Expires December 24, 2007             [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5826    
5827    
5828          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5829          answer line begins with the settings category name followed by a
5830          colon and then a space character <SP> and finally the info
5831          character string to that setting category.  At the moment the
5832          following categories are defined:
5833    
5834    
5835    
5836             FILES_TOTAL -
5837    
5838                The total number of files scheduled for scanning
5839    
5840             FILES_SCANNED -
5841    
5842                The current number of scanned files
5843    
5844             SCANNING -
5845    
5846                The absolute path name of the file which is currently being
5847                scanned
5848    
5849             STATUS -
5850    
5851                An integer value between 0 and 100 indicating the scanning
5852                progress percentage of the file which is currently being
5853                scanned
5854    
5855       The mentioned fields above don't have to be in particular order.
5856    
5857       Example:
5858    
5859          C: "GET DB_INSTRUMENTS_JOB INFO 2"
5860    
5861          S: "FILES_TOTAL: 12"
5862    
5863             "FILES_SCANNED: 7"
5864    
5865             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
5866    
5867             "STATUS: 42"
5868    
5869             "."
5870    
5871    
5872    
5873    
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires December 24, 2007             [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5882    
5883    
5884    7.  Command Syntax
5885    
5886       The grammar of the control protocol as descibed in Section 6 is
5887       defined below using Backus-Naur Form (BNF as described in [RFC2234])
5888       where applicable.
5889    
5890       input =
5891    
5892          line LF
5893    
5894          / line CR LF
5895    
5896       line =
5897    
5898          /* epsilon (empty line ignored) */
5899    
5900          / comment
5901    
5902          / command
5903    
5904          / error
5905    
5906       comment =
5907    
5908          '#'
5909    
5910          / comment '#'
5911    
5912          / comment SP
5913    
5914          / comment number
5915    
5916          / comment string
5917    
5918       command =
5919    
5920          ADD SP add_instruction
5921    
5922          / MAP SP map_instruction
5923    
5924          / UNMAP SP unmap_instruction
5925    
5926          / GET SP get_instruction
5927    
5928          / CREATE SP create_instruction
5929    
5930          / DESTROY SP destroy_instruction
5931    
5932    
5933    
5934    
5935    Schoenebeck             Expires December 24, 2007             [Page 106]
5936    
5937    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5938    
5939    
5940          / LIST SP list_instruction
5941    
5942          / LOAD SP load_instruction
5943    
5944          / REMOVE SP remove_instruction
5945    
5946          / SET SP set_instruction
5947    
5948          / SUBSCRIBE SP subscribe_event
5949    
5950          / UNSUBSCRIBE SP unsubscribe_event
5951    
5952          / RESET SP reset_instruction
5953    
5954          / CLEAR SP clear_instruction
5955    
5956          / FIND SP find_instruction
5957    
5958          / MOVE SP move_instruction
5959    
5960          / COPY SP copy_instruction
5961    
5962          / EDIT SP edit_instruction
5963    
5964          / RESET
5965    
5966          / QUIT
5967    
5968       add_instruction =
5969    
5970          CHANNEL
5971    
5972          / DB_INSTRUMENT_DIRECTORY SP pathname
5973    
5974          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
5975    
5976          / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
5977    
5978          / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
5979    
5980          / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP
5981          instrument_index
5982    
5983          / DB_INSTRUMENTS SP pathname SP pathname
5984    
5985          / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck             Expires December 24, 2007             [Page 107]
5992    
5993    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
5994    
5995    
5996          / MIDI_INSTRUMENT_MAP
5997    
5998          / MIDI_INSTRUMENT_MAP SP map_name
5999    
6000       subscribe_event =
6001    
6002          AUDIO_OUTPUT_DEVICE_COUNT
6003    
6004          / AUDIO_OUTPUT_DEVICE_INFO
6005    
6006          / MIDI_INPUT_DEVICE_COUNT
6007    
6008          / MIDI_INPUT_DEVICE_INFO
6009    
6010          / CHANNEL_COUNT
6011    
6012          / VOICE_COUNT
6013    
6014          / STREAM_COUNT
6015    
6016          / BUFFER_FILL
6017    
6018          / CHANNEL_INFO
6019    
6020          / FX_SEND_COUNT
6021    
6022          / FX_SEND_INFO
6023    
6024          / MIDI_INSTRUMENT_MAP_COUNT
6025    
6026          / MIDI_INSTRUMENT_MAP_INFO
6027    
6028          / MIDI_INSTRUMENT_COUNT
6029    
6030          / MIDI_INSTRUMENT_INFO
6031    
6032          / DB_INSTRUMENT_DIRECTORY_COUNT
6033    
6034          / DB_INSTRUMENT_DIRECTORY_INFO
6035    
6036          / DB_INSTRUMENT_COUNT
6037    
6038          / DB_INSTRUMENT_INFO
6039    
6040          / DB_INSTRUMENTS_JOB_INFO
6041    
6042          / MISCELLANEOUS
6043    
6044    
6045    
6046    
6047    Schoenebeck             Expires December 24, 2007             [Page 108]
6048    
6049    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6050    
6051    
6052          / TOTAL_VOICE_COUNT
6053    
6054          / GLOBAL_INFO
6055    
6056       unsubscribe_event =
6057    
6058          AUDIO_OUTPUT_DEVICE_COUNT
6059    
6060          / AUDIO_OUTPUT_DEVICE_INFO
6061    
6062          / MIDI_INPUT_DEVICE_COUNT
6063    
6064          / MIDI_INPUT_DEVICE_INFO
6065    
6066          / CHANNEL_COUNT
6067    
6068          / VOICE_COUNT
6069    
6070          / STREAM_COUNT
6071    
6072          / BUFFER_FILL
6073    
6074          / CHANNEL_INFO
6075    
6076          / FX_SEND_COUNT
6077    
6078          / FX_SEND_INFO
6079    
6080          / MIDI_INSTRUMENT_MAP_COUNT
6081    
6082          / MIDI_INSTRUMENT_MAP_INFO
6083    
6084          / MIDI_INSTRUMENT_COUNT
6085    
6086          / MIDI_INSTRUMENT_INFO
6087    
6088          / DB_INSTRUMENT_DIRECTORY_COUNT
6089    
6090          / DB_INSTRUMENT_DIRECTORY_INFO
6091    
6092          / DB_INSTRUMENT_COUNT
6093    
6094          / DB_INSTRUMENT_INFO
6095    
6096          / DB_INSTRUMENTS_JOB_INFO
6097    
6098          / MISCELLANEOUS
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires December 24, 2007             [Page 109]
6104    
6105    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6106    
6107    
6108          / TOTAL_VOICE_COUNT
6109    
6110          / GLOBAL_INFO
6111    
6112       map_instruction =
6113    
6114          MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
6115          engine_name SP filename SP instrument_index SP volume_value
6116    
6117          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6118          SP engine_name SP filename SP instrument_index SP volume_value SP
6119          instr_load_mode
6120    
6121          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6122          SP engine_name SP filename SP instrument_index SP volume_value SP
6123          entry_name
6124    
6125          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6126          SP engine_name SP filename SP instrument_index SP volume_value SP
6127          instr_load_mode SP entry_name
6128    
6129       unmap_instruction =
6130    
6131          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6132    
6133       remove_instruction =
6134    
6135          CHANNEL SP sampler_channel
6136    
6137          / MIDI_INSTRUMENT_MAP SP midi_map
6138    
6139          / MIDI_INSTRUMENT_MAP SP ALL
6140    
6141          / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6142    
6143          / DB_INSTRUMENT_DIRECTORY SP pathname
6144    
6145          / DB_INSTRUMENT SP pathname
6146    
6147       get_instruction =
6148    
6149          AVAILABLE_ENGINES
6150    
6151          / AVAILABLE_MIDI_INPUT_DRIVERS
6152    
6153          / MIDI_INPUT_DRIVER SP INFO SP string
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck             Expires December 24, 2007             [Page 110]
6160    
6161    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6162    
6163    
6164          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6165    
6166          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6167          key_val_list
6168    
6169          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6170    
6171          / AUDIO_OUTPUT_DRIVER SP INFO SP string
6172    
6173          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6174    
6175          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6176          key_val_list
6177    
6178          / AUDIO_OUTPUT_DEVICES
6179    
6180          / MIDI_INPUT_DEVICES
6181    
6182          / AUDIO_OUTPUT_DEVICE SP INFO SP number
6183    
6184          / MIDI_INPUT_DEVICE SP INFO SP number
6185    
6186          / MIDI_INPUT_PORT SP INFO SP number SP number
6187    
6188          / MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6189    
6190          / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6191    
6192          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6193          string
6194    
6195          / CHANNELS
6196    
6197          / CHANNEL SP INFO SP sampler_channel
6198    
6199          / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6200    
6201          / CHANNEL SP STREAM_COUNT SP sampler_channel
6202    
6203          / CHANNEL SP VOICE_COUNT SP sampler_channel
6204    
6205          / ENGINE SP INFO SP engine_name
6206    
6207          / SERVER SP INFO
6208    
6209          / TOTAL_VOICE_COUNT
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck             Expires December 24, 2007             [Page 111]
6216    
6217    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6218    
6219    
6220          / TOTAL_VOICE_COUNT_MAX
6221    
6222          / MIDI_INSTRUMENTS SP midi_map
6223    
6224          / MIDI_INSTRUMENTS SP ALL
6225    
6226          / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6227    
6228          / MIDI_INSTRUMENT_MAPS
6229    
6230          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6231    
6232          / FX_SENDS SP sampler_channel
6233    
6234          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6235    
6236          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6237    
6238          / DB_INSTRUMENT_DIRECTORIES SP pathname
6239    
6240          / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6241    
6242          / DB_INSTRUMENTS SP RECURSIVE SP pathname
6243    
6244          / DB_INSTRUMENTS SP pathname
6245    
6246          / DB_INSTRUMENT SP INFO SP pathname
6247    
6248          / DB_INSTRUMENTS_JOB SP INFO SP number
6249    
6250          / VOLUME
6251    
6252       set_instruction =
6253    
6254          AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
6255          param_val_list
6256    
6257          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
6258          param_val_list
6259    
6260          / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6261          param_val_list
6262    
6263          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6264          param_val_list
6265    
6266          / CHANNEL SP set_chan_instruction
6267    
6268    
6269    
6270    
6271    Schoenebeck             Expires December 24, 2007             [Page 112]
6272    
6273    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6274    
6275    
6276          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6277    
6278          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6279    
6280          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6281          SP audio_channel_index SP audio_channel_index
6282    
6283          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
6284          midi_ctrl
6285    
6286          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6287          volume_value
6288    
6289          / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6290    
6291          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6292    
6293          / DB_INSTRUMENT SP NAME SP pathname SP dirname
6294    
6295          / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6296    
6297          / ECHO SP boolean
6298    
6299          / VOLUME SP volume_value
6300    
6301       create_instruction =
6302    
6303          AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6304    
6305          / AUDIO_OUTPUT_DEVICE SP string
6306    
6307          / MIDI_INPUT_DEVICE SP string SP key_val_list
6308    
6309          / MIDI_INPUT_DEVICE SP string
6310    
6311          / FX_SEND SP sampler_channel SP midi_ctrl
6312    
6313          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6314    
6315       reset_instruction =
6316    
6317          CHANNEL SP sampler_channel
6318    
6319       clear_instruction =
6320    
6321          MIDI_INSTRUMENTS SP midi_map
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck             Expires December 24, 2007             [Page 113]
6328    
6329    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6330    
6331    
6332          / MIDI_INSTRUMENTS SP ALL
6333    
6334       find_instruction =
6335    
6336          DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6337    
6338          / DB_INSTRUMENTS SP pathname SP query_val_list
6339    
6340          / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP
6341          query_val_list
6342    
6343          / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6344    
6345       move_instruction =
6346    
6347          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6348    
6349          / DB_INSTRUMENT SP pathname SP pathname
6350    
6351       copy_instruction =
6352    
6353          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6354    
6355          / DB_INSTRUMENT SP pathname SP pathname
6356    
6357       destroy_instruction =
6358    
6359          AUDIO_OUTPUT_DEVICE SP number
6360    
6361          / MIDI_INPUT_DEVICE SP number
6362    
6363          / FX_SEND SP sampler_channel SP fx_send_id
6364    
6365       load_instruction =
6366    
6367          INSTRUMENT SP load_instr_args
6368    
6369          / ENGINE SP load_engine_args
6370    
6371       set_chan_instruction =
6372    
6373          AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6374    
6375          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6376          SP audio_channel_index
6377    
6378          / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6379    
6380    
6381    
6382    
6383    Schoenebeck             Expires December 24, 2007             [Page 114]
6384    
6385    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6386    
6387    
6388          / MIDI_INPUT SP sampler_channel SP device_index SP
6389          midi_input_port_index SP midi_input_channel_index
6390    
6391          / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6392    
6393          / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
6394    
6395          / MIDI_INPUT_CHANNEL SP sampler_channel SP
6396          midi_input_channel_index
6397    
6398          / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
6399    
6400          / VOLUME SP sampler_channel SP volume_value
6401    
6402          / MUTE SP sampler_channel SP boolean
6403    
6404          / SOLO SP sampler_channel SP boolean
6405    
6406          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6407    
6408          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6409    
6410          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6411    
6412       edit_instruction =
6413    
6414          INSTRUMENT SP sampler_channel
6415    
6416       modal_arg =
6417    
6418          /* epsilon (empty argument) */
6419    
6420          / NON_MODAL SP
6421    
6422       key_val_list =
6423    
6424          string '=' param_val_list
6425    
6426          / key_val_list SP string '=' param_val_list
6427    
6428       buffer_size_type =
6429    
6430          BYTES
6431    
6432          / PERCENTAGE
6433    
6434       list_instruction =
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires December 24, 2007             [Page 115]
6440    
6441    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6442    
6443    
6444          AUDIO_OUTPUT_DEVICES
6445    
6446          / MIDI_INPUT_DEVICES
6447    
6448          / CHANNELS
6449    
6450          / AVAILABLE_ENGINES
6451    
6452          / AVAILABLE_MIDI_INPUT_DRIVERS
6453    
6454          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6455    
6456          / MIDI_INSTRUMENTS SP midi_map
6457    
6458          / MIDI_INSTRUMENTS SP ALL
6459    
6460          / MIDI_INSTRUMENT_MAPS
6461    
6462          / FX_SENDS SP sampler_channel
6463    
6464          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6465    
6466          / DB_INSTRUMENT_DIRECTORIES SP pathname
6467    
6468          / DB_INSTRUMENTS SP RECURSIVE SP pathname
6469    
6470          / DB_INSTRUMENTS SP pathname
6471    
6472       load_instr_args =
6473    
6474          filename SP instrument_index SP sampler_channel
6475    
6476          / NON_MODAL SP filename SP instrument_index SP sampler_channel
6477    
6478       load_engine_args =
6479    
6480          engine_name SP sampler_channel
6481    
6482       instr_load_mode =
6483    
6484          ON_DEMAND
6485    
6486          / ON_DEMAND_HOLD
6487    
6488          / PERSISTENT
6489    
6490       device_index =
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires December 24, 2007             [Page 116]
6496    
6497    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6498    
6499    
6500          number
6501    
6502       audio_channel_index =
6503    
6504          number
6505    
6506       audio_output_type_name =
6507    
6508          string
6509    
6510       midi_input_port_index =
6511    
6512          number
6513    
6514       midi_input_channel_index =
6515    
6516          number
6517    
6518          / ALL
6519    
6520       midi_input_type_name =
6521    
6522          string
6523    
6524       midi_map =
6525    
6526          number
6527    
6528       midi_bank =
6529    
6530          number
6531    
6532       midi_prog =
6533    
6534          number
6535    
6536       midi_ctrl =
6537    
6538          number
6539    
6540       volume_value =
6541    
6542          dotnum
6543    
6544          / number
6545    
6546       sampler_channel =
6547    
6548    
6549    
6550    
6551    Schoenebeck             Expires December 24, 2007             [Page 117]
6552    
6553    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6554    
6555    
6556          number
6557    
6558       instrument_index =
6559    
6560          number
6561    
6562       fx_send_id =
6563    
6564          number
6565    
6566       engine_name =
6567    
6568          string
6569    
6570       pathname =
6571    
6572          stringval
6573    
6574       dirname =
6575    
6576          stringval
6577    
6578       filename =
6579    
6580          stringval_escaped
6581    
6582       map_name =
6583    
6584          stringval
6585    
6586       entry_name =
6587    
6588          stringval
6589    
6590       fx_send_name =
6591    
6592          stringval
6593    
6594       param_val_list =
6595    
6596          param_val
6597    
6598          / param_val_list','param_val
6599    
6600       param_val =
6601    
6602          string
6603    
6604    
6605    
6606    
6607    Schoenebeck             Expires December 24, 2007             [Page 118]
6608    
6609    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6610    
6611    
6612          / stringval
6613    
6614          / number
6615    
6616          / dotnum
6617    
6618       query_val_list =
6619    
6620          string '=' query_val
6621    
6622          / query_val_list SP string '=' query_val
6623    
6624       query_val =
6625    
6626          string
6627    
6628          / stringval
6629    
6630       scan_mode =
6631    
6632          RECURSIVE
6633    
6634          / NON_RECURSIVE
6635    
6636          / FLAT
6637    
6638    7.1.  Character Set and Escape Sequences
6639    
6640       Older versions of this protocol up to and including v1.1 only
6641       supported the standard ASCII character set (ASCII code 0 - 127)
6642       [RFC20], all younger versions of this protocol however support the
6643       Extended ASCII character set (ASCII code 0 - 255).  The same group of
6644       younger protocols also support escape sequences, but only for
6645       certain, explicitly declared parts of the protocol.  The supported
6646       escape sequences are defined as follows:
6647    
6648    
6649    
6650    
6651    
6652    
6653    
6654    
6655    
6656    
6657    
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck             Expires December 24, 2007             [Page 119]
6664    
6665    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6666    
6667    
6668       +------------------------+------------------------------------------+
6669       | ASCII Character        | Translated into (Name)                   |
6670       | Sequence               |                                          |
6671       +------------------------+------------------------------------------+
6672       | \n                     | new line                                 |
6673       |                        |                                          |
6674       | \r                     | carriage return                          |
6675       |                        |                                          |
6676       | \f                     | form feed                                |
6677       |                        |                                          |
6678       | \t                     | horizontal tab                           |
6679       |                        |                                          |
6680       | \v                     | vertical tab                             |
6681       |                        |                                          |
6682       | \'                     | apostrophe                               |
6683       |                        |                                          |
6684       | \"                     | quotation mark                           |
6685       |                        |                                          |
6686       | \\                     | backslash                                |
6687       |                        |                                          |
6688       | \OOO                   | three digit octal ASCII code of the      |
6689       |                        | character                                |
6690       |                        |                                          |
6691       | \xHH                   | two digit hex ASCII code of the          |
6692       |                        | character                                |
6693       +------------------------+------------------------------------------+
6694    
6695       Notice: due to the transition of certain parts of the protocol which
6696       now support escape sequences, a slight backward incompatibility to
6697       protocols version v1.1 and younger has been introduced.  The only
6698       difference is that in parts of the protocol where escape characters
6699       are now supported, a backslash characters MUST be escaped as well
6700       (that is as double backslash), whereas in the old versions a single
6701       backslash was sufficient.
6702    
6703    
6704    
6705    
6706    
6707    
6708    
6709    
6710    
6711    
6712    
6713    
6714    
6715    
6716    
6717    
6718    
6719    Schoenebeck             Expires December 24, 2007             [Page 120]
6720    
6721    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6722    
6723    
6724    8.  Events
6725    
6726     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
6727     LinuxSampler.     LinuxSampler.
6728    
6729  7.1  Number of sampler channels changed  8.1.  Number of audio output devices changed
6730    
6731       Client may want to be notified when the total number of audio output
6732       devices on the back-end changes by issuing the following command:
6733    
6734          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
6735    
6736       Server will start sending the following notification messages:
6737    
6738          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
6739    
6740       where <devices> will be replaced by the new number of audio output
6741       devices.
6742    
6743    8.2.  Audio output device's settings changed
6744    
6745       Client may want to be notified when changes were made to audio output
6746       devices on the back-end by issuing the following command:
6747    
6748          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
6749    
6750       Server will start sending the following notification messages:
6751    
6752          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
6753    
6754       where <device-id> will be replaced by the numerical ID of the audio
6755       output device, which settings has been changed.  The front-end will
6756       have to send the respective command to actually get the audio output
6757       device info.  Because these messages will be triggered by LSCP
6758       commands issued by other clients rather than real time events
6759       happening on the server, it is believed that an empty notification
6760       message is sufficient here.
6761    
6762    8.3.  Number of MIDI input devices changed
6763    
6764       Client may want to be notified when the total number of MIDI input
6765       devices on the back-end changes by issuing the following command:
6766    
6767          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
6768    
6769       Server will start sending the following notification messages:
6770    
6771    
6772    
6773    
6774    
6775    Schoenebeck             Expires December 24, 2007             [Page 121]
6776    
6777    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6778    
6779    
6780          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
6781    
6782       where <devices> will be replaced by the new number of MIDI input
6783       devices.
6784    
6785    8.4.  MIDI input device's settings changed
6786    
6787       Client may want to be notified when changes were made to MIDI input
6788       devices on the back-end by issuing the following command:
6789    
6790          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
6791    
6792       Server will start sending the following notification messages:
6793    
6794          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
6795    
6796       where <device-id> will be replaced by the numerical ID of the MIDI
6797       input device, which settings has been changed.  The front-end will
6798       have to send the respective command to actually get the MIDI input
6799       device info.  Because these messages will be triggered by LSCP
6800       commands issued by other clients rather than real time events
6801       happening on the server, it is believed that an empty notification
6802       message is sufficient here.
6803    
6804    8.5.  Number of sampler channels changed
6805    
6806     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
6807     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 2876  Internet-Draft       LinuxSampler Contro Line 6815  Internet-Draft       LinuxSampler Contro
6815     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
6816     channels.     channels.
6817    
6818  7.2  Number of active voices changed  8.6.  Number of active voices changed
6819    
6820     Client may want to be notified when the number of voices on the     Client may want to be notified when the number of voices on the back-
6821     back-end changes by issuing the following command:     end changes by issuing the following command:
6822    
6823        SUBSCRIBE VOICE_COUNT        SUBSCRIBE VOICE_COUNT
6824    
6825     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6826    
6827        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
6828    
6829    
6830    
6831    Schoenebeck             Expires December 24, 2007             [Page 122]
6832    
6833    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6834    
6835    
6836          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
6837    
6838     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6839     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
6840     voices on that channel.     voices on that channel.
6841    
6842  7.3  Number of active disk streams changed  8.7.  Number of active disk streams changed
6843    
6844     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
6845     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 2905  Internet-Draft       LinuxSampler Contro Line 6853  Internet-Draft       LinuxSampler Contro
6853    
6854     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6855     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck            Expires November 19, 2005               [Page 52]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
6856     active disk streams on that channel.     active disk streams on that channel.
6857    
6858  7.4  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
6859    
6860     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
6861     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 2928  Internet-Draft       LinuxSampler Contro Line 6868  Internet-Draft       LinuxSampler Contro
6868    
6869     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6870     buffer fill state change occurred on and <fill-data> will be replaced     buffer fill state change occurred on and <fill-data> will be replaced
6871     by the buffer fill data for this channel as described in Section     by the buffer fill data for this channel as described in
6872     5.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" (Section     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
6873     5.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
6874    
6875  7.5  Channel information changed  8.9.  Channel information changed
6876    
6877     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
6878     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 2941  Internet-Draft       LinuxSampler Contro Line 6881  Internet-Draft       LinuxSampler Contro
6881    
6882     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6883    
6884    
6885    
6886    
6887    Schoenebeck             Expires December 24, 2007             [Page 123]
6888    
6889    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6890    
6891    
6892        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
6893    
6894     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 2950  Internet-Draft       LinuxSampler Contro Line 6898  Internet-Draft       LinuxSampler Contro
6898     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
6899     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
6900    
6901  7.6  Miscellaneous and debugging events  8.10.  Number of effect sends changed
6902    
6903     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified when the number of effect sends on a
6904     occurring at the server by issuing the following command:     particular sampler channel is changed by issuing the following
6905       command:
6906    
6907        SUBSCRIBE MISCELLANEOUS        SUBSCRIBE FX_SEND_COUNT
6908    
6909     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6910    
6911        "NOTIFY:MISCELLANEOUS:<string>"        "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
6912    
6913       where <channel-id> will be replaced by the numerical ID of the
6914       sampler channel, on which the effect sends number is changed and <fx-
6915       sends> will be replaced by the new number of effect sends on that
6916       channel.
6917    
6918    8.11.  Effect send information changed
6919    
6920       Client may want to be notified when changes were made to effect sends
6921       on a a particular sampler channel by issuing the following command:
6922    
6923          SUBSCRIBE FX_SEND_INFO
6924    
6925       Server will start sending the following notification messages:
6926    
6927          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
6928    
6929       where <channel-id> will be replaced by the numerical ID of the
6930       sampler channel, on which an effect send entity is changed and <fx-
6931       send-id> will be replaced by the numerical ID of the changed effect
6932       send.
6933    
6934    8.12.  Total number of active voices changed
6935    
6936       Client may want to be notified when the total number of voices on the
6937       back-end changes by issuing the following command:
6938    
6939    
6940    
6941    
6942    
6943  Schoenebeck            Expires November 19, 2005               [Page 53]  Schoenebeck             Expires December 24, 2007             [Page 124]
6944    
6945  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
6946    
6947    
6948     where <string> will be replaced by whatever data server wants to send        SUBSCRIBE TOTAL_VOICE_COUNT
6949     to the client.  Client MAY display this data to the user AS IS to  
6950     facilitate debugging.     Server will start sending the following notification messages:
6951    
6952          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
6953    
6954       where <voices> will be replaced by the new number of all currently
6955       active voices.
6956    
6957    8.13.  Number of MIDI instrument maps changed
6958    
6959       Client may want to be notified when the number of MIDI instrument
6960       maps on the back-end changes by issuing the following command:
6961    
6962          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
6963    
6964       Server will start sending the following notification messages:
6965    
6966          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
6967    
6968       where <maps> will be replaced by the new number of MIDI instrument
6969       maps.
6970    
6971    8.14.  MIDI instrument map information changed
6972    
6973       Client may want to be notified when changes were made to MIDI
6974       instrument maps on the back-end by issuing the following command:
6975    
6976          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
6977    
6978       Server will start sending the following notification messages:
6979    
6980          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
6981    
6982       where <map-id> will be replaced by the numerical ID of the MIDI
6983       instrument map, for which information changes occurred.  The front-
6984       end will have to send the respective command to actually get the MIDI
6985       instrument map info.  Because these messages will be triggered by
6986       LSCP commands issued by other clients rather than real time events
6987       happening on the server, it is believed that an empty notification
6988       message is sufficient here.
6989    
6990    8.15.  Number of MIDI instruments changed
6991    
6992       Client may want to be notified when the number of MIDI instrument
6993       maps on the back-end changes by issuing the following command:
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck             Expires December 24, 2007             [Page 125]
7000    
7001    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7002    
7003    
7004          SUBSCRIBE MIDI_INSTRUMENT_COUNT
7005    
7006       Server will start sending the following notification messages:
7007    
7008          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
7009    
7010       where <map-id> is the numerical ID of the MIDI instrument map, in
7011       which the nuber of instruments has changed and <instruments> will be
7012       replaced by the new number of MIDI instruments in the specified map.
7013    
7014    8.16.  MIDI instrument information changed
7015    
7016       Client may want to be notified when changes were made to MIDI
7017       instruments on the back-end by issuing the following command:
7018    
7019          SUBSCRIBE MIDI_INSTRUMENT_INFO
7020    
7021       Server will start sending the following notification messages:
7022    
7023          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
7024    
7025       where <map-id> will be replaced by the numerical ID of the MIDI
7026       instrument map, in which a MIDI instrument is changed. <bank> and
7027       <program> specifies the location of the changed MIDI instrument in
7028       the map.  The front-end will have to send the respective command to
7029       actually get the MIDI instrument info.  Because these messages will
7030       be triggered by LSCP commands issued by other clients rather than
7031       real time events happening on the server, it is believed that an
7032       empty notification message is sufficient here.
7033    
7034    8.17.  Global settings changed
7035    
7036       Client may want to be notified when changes to the global settings of
7037       the sampler were made by issuing the following command:
7038    
7039          SUBSCRIBE GLOBAL_INFO
7040    
7041       Server will start sending the following types of notification
7042       messages:
7043    
7044          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
7045          volume of the sampler is changed, where <volume> will be replaced
7046          by the optional dotted floating point value, reflecting the new
7047          global volume parameter.
7048    
7049    
7050    
# Line 2980  Internet-Draft       LinuxSampler Contro Line 7052  Internet-Draft       LinuxSampler Contro
7052    
7053    
7054    
7055    Schoenebeck             Expires December 24, 2007             [Page 126]
7056    
7057    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7058    
7059    
7060    8.18.  Number of database instrument directories changed
7061    
7062       Client may want to be notified when the number of instrument
7063       directories in a particular directory in the instruments database is
7064       changed by issuing the following command:
7065    
7066          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
7067    
7068       Server will start sending the following notification messages:
7069    
7070          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
7071    
7072       where <dir-path> will be replaced by the absolute path name of the
7073       directory in the instruments database, in which the number of
7074       directories is changed.
7075    
7076       Note that when a non-empty directory is removed, this event is not
7077       sent for the subdirectories in that directory.
7078    
7079    8.19.  Database instrument directory information changed
7080    
7081       Client may want to be notified when changes were made to directories
7082       in the instruments database by issuing the following command:
7083    
7084          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
7085    
7086       Server will start sending the following notification messages:
7087    
7088          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
7089    
7090       where <dir-path> will be replaced by the absolute path name of the
7091       directory, for which information changes occurred.  The front-end
7092       will have to send the respective command to actually get the updated
7093       directory info.  Because these messages will be triggered by LSCP
7094       commands issued by other clients rather than real time events
7095       happening on the server, it is believed that an empty notification
7096       message is sufficient here.
7097    
7098          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
7099          name>"
7100    
7101       where <old-dir-path> is the old absolute path name of the directory
7102       (encapsulated into apostrophes), which name is changes and <new-name>
7103       is the new name of the directory, encapsulated into apostrophes.
7104    
7105    
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck             Expires December 24, 2007             [Page 127]
7112    
7113    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7114    
7115    
7116    8.20.  Number of database instruments changed
7117    
7118       Client may want to be notified when the number of instruments in a
7119       particular directory in the instruments database is changed by
7120       issuing the following command:
7121    
7122          SUBSCRIBE DB_INSTRUMENT_COUNT
7123    
7124       Server will start sending the following notification messages:
7125    
7126          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
7127    
7128       where <dir-path> will be replaced by the absolute path name of the
7129       directory in the instruments database, in which the number of
7130       instruments is changed.
7131    
7132       Note that when a non-empty directory is removed, this event is not
7133       sent for the instruments in that directory.
7134    
7135    8.21.  Database instrument information changed
7136    
7137       Client may want to be notified when changes were made to instruments
7138       in the instruments database by issuing the following command:
7139    
7140          SUBSCRIBE DB_INSTRUMENT_INFO
7141    
7142       Server will start sending the following notification messages:
7143    
7144          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
7145    
7146       where <instr-path> will be replaced by the absolute path name of the
7147       instrument, which settings are changed.  The front-end will have to
7148       send the respective command to actually get the updated directory
7149       info.  Because these messages will be triggered by LSCP commands
7150       issued by other clients rather than real time events happening on the
7151       server, it is believed that an empty notification message is
7152       sufficient here.
7153    
7154          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
7155    
7156       where <old-instr-path> is the old absolute path name of the
7157       instrument (encapsulated into apostrophes), which name is changes and
7158       <new-name> is the new name of the instrument, encapsulated into
7159       apostrophes.
7160    
7161    
7162    
# Line 2997  Internet-Draft       LinuxSampler Contro Line 7164  Internet-Draft       LinuxSampler Contro
7164    
7165    
7166    
7167    Schoenebeck             Expires December 24, 2007             [Page 128]
7168    
7169    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7170    
7171    
7172    8.22.  Database job status information changed
7173    
7174       Client may want to be notified when the status of particular database
7175       instruments job is changed by issuing the following command:
7176    
7177          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
7178    
7179       Server will start sending the following notification messages:
7180    
7181          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
7182    
7183       where <job-id> will be replaced by the numerical ID of the job, which
7184       status is changed.  The front-end will have to send the respective
7185       command to actually get the status info.  Because these messages will
7186       be triggered by LSCP commands issued by other clients rather than
7187       real time events happening on the server, it is believed that an
7188       empty notification message is sufficient here.
7189    
7190    8.23.  Miscellaneous and debugging events
7191    
7192       Client may want to be notified of miscellaneous and debugging events
7193       occurring at the server by issuing the following command:
7194    
7195          SUBSCRIBE MISCELLANEOUS
7196    
7197       Server will start sending the following notification messages:
7198    
7199          "NOTIFY:MISCELLANEOUS:<string>"
7200    
7201       where <string> will be replaced by whatever data server wants to send
7202       to the client.  Client MAY display this data to the user AS IS to
7203       facilitate debugging.
7204    
7205    
7206    
# Line 3020  Internet-Draft       LinuxSampler Contro Line 7220  Internet-Draft       LinuxSampler Contro
7220    
7221    
7222    
7223  Schoenebeck            Expires November 19, 2005               [Page 54]  Schoenebeck             Expires December 24, 2007             [Page 129]
7224    
7225  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7226    
7227    
7228  8.  Security Considerations  9.  Security Considerations
7229    
7230     As there is so far no method of authentication and authorization     As there is so far no method of authentication and authorization
7231     defined and so not required for a client applications to succeed to     defined and so not required for a client applications to succeed to
# Line 3076  Internet-Draft       LinuxSampler Contro Line 7276  Internet-Draft       LinuxSampler Contro
7276    
7277    
7278    
7279  Schoenebeck            Expires November 19, 2005               [Page 55]  Schoenebeck             Expires December 24, 2007             [Page 130]
7280    
7281  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7282    
7283    
7284  9.  Acknowledgments  10.  Acknowledgments
7285    
7286     This document has benefited greatly from the comments of the     This document has benefited greatly from the comments of the
7287     following people, discussed on the LinuxSampler developer's mailing     following people, discussed on the LinuxSampler developer's mailing
7288     list:     list:
7289    
7290        Rui Nuno Capela        Rui Nuno Capela
7291    
7292        Vladimir Senkov        Vladimir Senkov
7293    
7294        Mark Knecht        Mark Knecht
7295    
7296        Grigor Iliev        Grigor Iliev
7297    
 10  References  
7298    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", BCP 14, RFC 2119, March 1997.  
7299    
7300    
 Author's Address  
7301    
    C. Schoenebeck  
    Interessengemeinschaft Software Engineering e. V.  
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
7302    
    EMail: schoenebeck at software minus engineering dot org  
7303    
7304    
7305    
# Line 3132  Author's Address Line 7325  Author's Address
7325    
7326    
7327    
7328  Schoenebeck            Expires November 19, 2005               [Page 56]  
7329    
7330    
7331    
7332    
7333    
7334    
7335    Schoenebeck             Expires December 24, 2007             [Page 131]
7336    
7337  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7338    
7339    
7340    11.  References
7341    
7342       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
7343                  1969.
7344    
7345       [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
7346                  Requirement Levels", RFC 2119, 1997.
7347    
7348       [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
7349                  Specifications", RFC 2234, 1997.
7350    
7351       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
7352                  CONTROL PROTOCOL", RFC 793, 1981.
7353    
7354    
7355    
7356    
7357    
7358    
7359    
7360    
7361    
7362    
 Intellectual Property Statement  
7363    
    The IETF takes no position regarding the validity or scope of any  
    intellectual property or other rights that might be claimed to  
    pertain to the implementation or use of the technology described in  
    this document or the extent to which any license under such rights  
    might or might not be available; neither does it represent that it  
    has made any effort to identify any such rights.  Information on the  
    IETF's procedures with respect to rights in standards-track and  
    standards-related documentation can be found in BCP-11.  Copies of  
    claims of rights made available for publication and any assurances of  
    licenses to be made available, or the result of an attempt made to  
    obtain a general license or permission for the use of such  
    proprietary rights by implementors or users of this specification can  
    be obtained from the IETF Secretariat.  
7364    
    The IETF invites any interested party to bring to its attention any  
    copyrights, patents or patent applications, or other proprietary  
    rights which may cover technology that may be required to practice  
    this standard.  Please address the information to the IETF Executive  
    Director.  
7365    
7366    
 Full Copyright Statement  
7367    
    Copyright (C) The Internet Society (2005).  All Rights Reserved.  
7368    
    This document and translations of it may be copied and furnished to  
    others, and derivative works that comment on or otherwise explain it  
    or assist in its implementation may be prepared, copied, published  
    and distributed, in whole or in part, without restriction of any  
    kind, provided that the above copyright notice and this paragraph are  
    included on all such copies and derivative works.  However, this  
    document itself may not be modified in any way, such as by removing  
    the copyright notice or references to the Internet Society or other  
    Internet organizations, except as needed for the purpose of  
    developing Internet standards in which case the procedures for  
    copyrights defined in the Internet Standards process must be  
    followed, or as required to translate it into languages other than  
    English.  
7369    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
7370    
    This document and the information contained herein is provided on an  
    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  
    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  
    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  
7371    
7372    
7373    
7374  Schoenebeck            Expires November 19, 2005               [Page 57]  
7375    
7376    
7377    
7378    
7379    
7380    
7381    
7382    
7383    
7384    
7385    
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck             Expires December 24, 2007             [Page 132]
7392    
7393  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7394    
7395    
7396    Author's Address
7397    
7398       C. Schoenebeck
7399       Interessengemeinschaft Software Engineering e. V.
7400       Max-Planck-Str. 39
7401       74081 Heilbronn
7402       Germany
7403    
7404       Email: schoenebeck at software minus engineering dot org
7405    
7406    
7407    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
7408    
7409    
 Acknowledgment  
7410    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
7411    
7412    
7413    
# Line 3237  Acknowledgment Line 7444  Acknowledgment
7444    
7445    
7446    
7447    Schoenebeck             Expires December 24, 2007             [Page 133]
7448    
7449    Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007
7450    
7451    
7452    Full Copyright Statement
7453    
7454       Copyright (C) The IETF Trust (2007).
7455    
7456       This document is subject to the rights, licenses and restrictions
7457       contained in BCP 78, and except as set forth therein, the authors
7458       retain all their rights.
7459    
7460       This document and the information contained herein are provided on an
7461       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
7462       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
7463       THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
7464       OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
7465       THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
7466       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
7467    
7468    
7469    Intellectual Property
7470    
7471       The IETF takes no position regarding the validity or scope of any
7472       Intellectual Property Rights or other rights that might be claimed to
7473       pertain to the implementation or use of the technology described in
7474       this document or the extent to which any license under such rights
7475       might or might not be available; nor does it represent that it has
7476       made any independent effort to identify any such rights.  Information
7477       on the procedures with respect to rights in RFC documents can be
7478       found in BCP 78 and BCP 79.
7479    
7480       Copies of IPR disclosures made to the IETF Secretariat and any
7481       assurances of licenses to be made available, or the result of an
7482       attempt made to obtain a general license or permission for the use of
7483       such proprietary rights by implementers or users of this
7484       specification can be obtained from the IETF on-line IPR repository at
7485       http://www.ietf.org/ipr.
7486    
7487       The IETF invites any interested party to bring to its attention any
7488       copyrights, patents or patent applications, or other proprietary
7489       rights that may cover technology that may be required to implement
7490       this standard.  Please address the information to the IETF at
7491       ietf-ipr@ietf.org.
7492    
7493    
7494    Acknowledgment
7495    
7496       Funding for the RFC Editor function is provided by the IETF
7497       Administrative Support Activity (IASA).
7498    
7499    
7500    
7501    
7502    
7503  Schoenebeck            Expires November 19, 2005               [Page 58]  Schoenebeck             Expires December 24, 2007             [Page 134]
7504    
Legend:
Removed from v.561  
changed lines
  Added in v.1251
  ViewVC Help
Powered by ViewVC