/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 945 by schoenebeck, Sun Nov 26 16:39:49 2006 UTC revision 1162 by iliev, Mon Apr 16 16:02:19 2007 UTC
# Line 3  Line 3 
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: May 30, 2007                                  Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                         November 26, 2006  Expires: October 18, 2007                                 April 16, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 12  Expires: May 30, 2007 Line 12  Expires: May 30, 2007
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC 2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
# Line 31  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on May 30, 2007.     This Internet-Draft will expire on October 18, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).  All Rights Reserved.     Copyright (C) The IETF Trust (2007).
41    
42    
 Abstract  
43    
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
44    
45    
46    
# Line 52  Abstract Line 49  Abstract
49    
50    
51    
52  Schoenebeck               Expires May 30, 2007                  [Page 1]  
53    
54    
55    Schoenebeck             Expires October 18, 2007                [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
58    
59    
60    Abstract
61    
62       The LinuxSampler Control Protocol (LSCP) is an application-level
63       protocol primarily intended for local and remote controlling the
64       LinuxSampler backend application, which is a sophisticated server-
65       like console application essentially playing back audio samples and
66       manipulating the samples in real time to certain extent.
67    
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72     2.  Versioning of this specification . . . . . . . . . . . . . . .  6     2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73     3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74     4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75     5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76       5.1.  Request/response communication method  . . . . . . . . . .  9       5.1.  Request/response communication method . . . . . . . . . .  10
77         5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78       5.2.  Subscribe/notify communication method  . . . . . . . . . . 12       5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79     6.  Description for control commands . . . . . . . . . . . . . . . 14     6.  Description for control commands  . . . . . . . . . . . . . .  15
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82         6.2.1.  Getting amount of available audio output drivers . . . 14         6.2.1.  Getting amount of available audio output drivers  . .  16
83         6.2.2.  Getting all available audio output drivers . . . . . . 15         6.2.2.  Getting all available audio output drivers  . . . . .  16
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver . . . . . . . . . . . . . . . . . . . . . . . . 15                 driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter . . . . . . . . . . . . . . . . . . . 16                 driver parameter  . . . . . . . . . . . . . . . . . .  17
88         6.2.5.  Creating an audio output device  . . . . . . . . . . . 20         6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89         6.2.6.  Destroying an audio output device  . . . . . . . . . . 21         6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90         6.2.7.  Getting all created audio output device count  . . . . 22         6.2.7.  Getting all created audio output device count . . . .  23
91         6.2.8.  Getting all created audio output device list . . . . . 22         6.2.8.  Getting all created audio output device list  . . . .  23
92         6.2.9.  Getting current settings of an audio output device . . 22         6.2.9.  Getting current settings of an audio output device  .  23
93         6.2.10. Changing settings of audio output devices  . . . . . . 24         6.2.10. Changing settings of audio output devices . . . . . .  25
94         6.2.11. Getting information about an audio channel . . . . . . 24         6.2.11. Getting information about an audio channel  . . . . .  26
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 26                 parameter . . . . . . . . . . . . . . . . . . . . . .  27
97         6.2.13. Changing settings of audio output channels . . . . . . 28         6.2.13. Changing settings of audio output channels  . . . . .  29
98       6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 30         6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver . . . . . . . . . . . . . . . . . . . . . . . . 30                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter . . . . . . . . . . . . . . . . . . . 31                 driver parameter  . . . . . . . . . . . . . . . . . .  33
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107         6.3.7.  Getting all created MIDI input device count  . . . . . 36         6.3.7.  Getting all created MIDI input device count . . . . .  37
        6.3.8.  Getting all created MIDI input device list . . . . . . 36  
        6.3.9.  Getting current settings of a MIDI input device  . . . 36  
        6.3.10. Changing settings of MIDI input devices  . . . . . . . 38  
        6.3.11. Getting information about a MIDI port  . . . . . . . . 38  
        6.3.12. Getting information about specific MIDI port  
                parameter  . . . . . . . . . . . . . . . . . . . . . . 39  
        6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41  
      6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42  
        6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42  
108    
109    
110    
111  Schoenebeck               Expires May 30, 2007                  [Page 2]  Schoenebeck             Expires October 18, 2007                [Page 2]
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
        6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43  
        6.4.3.  Getting all created sampler channel count  . . . . . . 44  
        6.4.4.  Getting all created sampler channel list . . . . . . . 44  
        6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 44  
        6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 45  
        6.4.7.  Getting amount of available engines  . . . . . . . . . 46  
        6.4.8.  Getting all available engines  . . . . . . . . . . . . 46  
        6.4.9.  Getting information about an engine  . . . . . . . . . 47  
        6.4.10. Getting sampler channel information  . . . . . . . . . 48  
        6.4.11. Current number of active voices  . . . . . . . . . . . 51  
        6.4.12. Current number of active disk streams  . . . . . . . . 51  
        6.4.13. Current fill state of disk stream buffers  . . . . . . 51  
        6.4.14. Setting audio output device  . . . . . . . . . . . . . 52  
        6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53  
        6.4.16. Setting audio output channel . . . . . . . . . . . . . 54  
        6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55  
        6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 55  
        6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56  
        6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57  
        6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 57  
        6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58  
        6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59  
        6.4.24. Resetting a sampler channel  . . . . . . . . . . . . . 59  
      6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 60  
        6.5.1.  Register front-end for receiving event messages  . . . 60  
        6.5.2.  Unregister front-end for not receiving event  
                messages . . . . . . . . . . . . . . . . . . . . . . . 61  
        6.5.3.  Enable or disable echo of commands . . . . . . . . . . 62  
        6.5.4.  Close client connection  . . . . . . . . . . . . . . . 62  
      6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 62  
        6.6.1.  Current number of active voices  . . . . . . . . . . . 62  
        6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 63  
        6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 63  
        6.6.4.  General sampler informations . . . . . . . . . . . . . 63  
      6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 64  
        6.7.1.  Create or replace a MIDI instrument map entry  . . . . 64  
        6.7.2.  Getting ammount of MIDI instrument map entries . . . . 67  
        6.7.3.  Getting indeces of all MIDI instrument map entries . . 67  
        6.7.4.  Remove an entry from the MIDI instrument map . . . . . 68  
        6.7.5.  Get current settings of MIDI instrument map entry  . . 69  
        6.7.6.  Clear MIDI instrument map  . . . . . . . . . . . . . . 70  
    7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 72  
    8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81  
      8.1.  Number of sampler channels changed . . . . . . . . . . . . 81  
      8.2.  Number of active voices changed  . . . . . . . . . . . . . 81  
      8.3.  Number of active disk streams changed  . . . . . . . . . . 81  
      8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 82  
      8.5.  Channel information changed  . . . . . . . . . . . . . . . 82  
   
   
   
 Schoenebeck               Expires May 30, 2007                  [Page 3]  
112    
113  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
   
   
      8.6.  Total number of active voices changed  . . . . . . . . . . 82  
      8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 83  
    9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 84  
    10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 85  
    11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 85  
    Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 86  
    Intellectual Property and Copyright Statements . . . . . . . . . . 87  
   
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  . . . . . . . . . . . .  45
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 . . . . . . . . . . . .  47
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 . . . . . . . . . . . . . .  54
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 . . . . . . . . . .  68
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69
159         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160           6.5.1.  Register front-end for receiving event messages . . .  70
161           6.5.2.  Unregister front-end for not receiving event
162                   messages  . . . . . . . . . . . . . . . . . . . . . .  71
163           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71
164    
165    
166    
167    Schoenebeck             Expires October 18, 2007                [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol           April 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 . . . . . . . . . . .  72
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 . . . . . . . . . .  74
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 . .  76
183           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77
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 . . . .  79
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189           6.7.9.  Getting indeces of all entries of a MIDI
190                   instrument map  . . . . . . . . . . . . . . . . . . .  83
191           6.7.10. Remove an entry from the MIDI instrument map  . . . .  83
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 . . . . . . . . . . . . . .  86
195           6.8.1.  Creating a new instrument directory . . . . . . . . .  86
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 . . . .  88
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  . . . . . . . . . . .  90
202           6.8.8.  Changing the description of directory . . . . . . . .  91
203           6.8.9.  Adding instruments to the instruments database  . . .  92
204           6.8.10. Removing an instrument  . . . . . . . . . . . . . . .  93
205           6.8.11. Getting amount of instruments . . . . . . . . . . . .  93
206           6.8.12. Listing all instruments in specific directory . . . .  94
207           6.8.13. Getting instrument information  . . . . . . . . . . .  94
208           6.8.14. Renaming an instrument  . . . . . . . . . . . . . . .  97
209           6.8.15. Moving an instrument  . . . . . . . . . . . . . . . .  97
210           6.8.16. Changing the description of instrument  . . . . . . .  98
211       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  99
212       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
213         8.1.  Number of audio output devices changed  . . . . . . . . . 112
214         8.2.  Audio output device's settings changed  . . . . . . . . . 112
215         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 112
216         8.4.  MIDI input device's settings changed  . . . . . . . . . . 113
217         8.5.  Number of sampler channels changed  . . . . . . . . . . . 113
218         8.6.  Number of active voices changed . . . . . . . . . . . . . 113
219         8.7.  Number of active disk streams changed . . . . . . . . . . 114
220    
221    
222    
223    Schoenebeck             Expires October 18, 2007                [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol           April 2007
226    
227    
228         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 114
229         8.9.  Channel information changed . . . . . . . . . . . . . . . 114
230         8.10. Number of effect sends changed  . . . . . . . . . . . . . 115
231         8.11. Effect send information changed . . . . . . . . . . . . . 115
232         8.12. Total number of active voices changed . . . . . . . . . . 115
233         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 116
234         8.14. MIDI instrument map information changed . . . . . . . . . 116
235         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 116
236         8.16. MIDI instrument information changed . . . . . . . . . . . 117
237         8.17. Global settings changed . . . . . . . . . . . . . . . . . 117
238         8.18. Number of database instrument directories changed . . . . 118
239         8.19. Database instrument directory information changed . . . . 118
240         8.20. Number of database instruments changed  . . . . . . . . . 119
241         8.21. Database instrument information changed . . . . . . . . . 119
242         8.22. Miscellaneous and debugging events  . . . . . . . . . . . 120
243       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 121
244       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 122
245       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 123
246       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 124
247       Intellectual Property and Copyright Statements  . . . . . . . . . 125
248    
249    
250    
# Line 220  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires May 30, 2007                  [Page 4]  Schoenebeck             Expires October 18, 2007                [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires May 30, 2007                  [Page 5]  Schoenebeck             Expires October 18, 2007                [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires May 30, 2007                  [Page 6]  Schoenebeck             Expires October 18, 2007                [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires May 30, 2007                  [Page 7]  Schoenebeck             Expires October 18, 2007                [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires May 30, 2007                  [Page 8]  Schoenebeck             Expires October 18, 2007                [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires May 30, 2007                  [Page 9]  Schoenebeck             Expires October 18, 2007               [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires May 30, 2007                 [Page 10]  Schoenebeck             Expires October 18, 2007               [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires May 30, 2007                 [Page 11]  Schoenebeck             Expires October 18, 2007               [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires May 30, 2007                 [Page 12]  Schoenebeck             Expires October 18, 2007               [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires May 30, 2007                 [Page 13]  Schoenebeck             Expires October 18, 2007               [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 774  Internet-Draft        LinuxSampler Contr Line 830  Internet-Draft        LinuxSampler Contr
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    
 6.2.1.  Getting amount of available audio output drivers  
833    
    Use the following command to get the number of audio output drivers  
834    
835    
836    
837  Schoenebeck               Expires May 30, 2007                 [Page 14]  
838    
839    Schoenebeck             Expires October 18, 2007               [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 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:     currently available for the LinuxSampler instance:
848    
849        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 833  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895    Schoenebeck             Expires October 18, 2007               [Page 16]
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 15]  
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires May 30, 2007                 [Page 16]  Schoenebeck             Expires October 18, 2007               [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires May 30, 2007                 [Page 17]  Schoenebeck             Expires October 18, 2007               [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires May 30, 2007                 [Page 18]  Schoenebeck             Expires October 18, 2007               [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires May 30, 2007                 [Page 19]  Schoenebeck             Expires October 18, 2007               [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires May 30, 2007                 [Page 20]  Schoenebeck             Expires October 18, 2007               [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires May 30, 2007                 [Page 21]  Schoenebeck             Expires October 18, 2007               [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires May 30, 2007                 [Page 22]  Schoenebeck             Expires October 18, 2007               [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires May 30, 2007                 [Page 23]  Schoenebeck             Expires October 18, 2007               [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1333  Internet-Draft        LinuxSampler Contr Line 1389  Internet-Draft        LinuxSampler Contr
1389    
1390        S: "OK"        S: "OK"
1391    
 6.2.11.  Getting information about an audio channel  
1392    
    Use the following command to get information about an audio channel:  
1393    
1394    
1395    
1396    
1397  Schoenebeck               Expires May 30, 2007                 [Page 24]  
1398    
1399    Schoenebeck             Expires October 18, 2007               [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 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>        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1409    
# Line 1390  Internet-Draft        LinuxSampler Contr Line 1450  Internet-Draft        LinuxSampler Contr
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    
    Examples:  
   
   
   
1453    
1454    
1455  Schoenebeck               Expires May 30, 2007                 [Page 25]  Schoenebeck             Expires October 18, 2007               [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1458    
1459    
1460       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"
# Line 1447  Internet-Draft        LinuxSampler Contr Line 1505  Internet-Draft        LinuxSampler Contr
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 "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1507     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
    channel number and <param> a specific channel parameter name for  
    which information should be obtained (as returned by the "GET  
1508    
1509    
1510    
1511  Schoenebeck               Expires May 30, 2007                 [Page 26]  Schoenebeck             Expires October 18, 2007               [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 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).     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1519    
1520     Possible Answers:     Possible Answers:
# Line 1506  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567    Schoenebeck             Expires October 18, 2007               [Page 28]
   
 Schoenebeck               Expires May 30, 2007                 [Page 27]  
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires May 30, 2007                 [Page 28]  Schoenebeck             Expires October 18, 2007               [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires May 30, 2007                 [Page 29]  Schoenebeck             Expires October 18, 2007               [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1669  Internet-Draft        LinuxSampler Contr Line 1725  Internet-Draft        LinuxSampler Contr
1725    
1726        S: "ALSA,JACK"        S: "ALSA,JACK"
1727    
 6.3.3.  Getting information about a specific MIDI input driver  
1728    
    Use the following command to get detailed information about a  
    specific MIDI input driver:  
1729    
1730    
1731    
1732  Schoenebeck               Expires May 30, 2007                 [Page 30]  
1733    
1734    
1735    Schoenebeck             Expires October 18, 2007               [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 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
1743       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 as     Where <midi-input-driver> is the name of the MIDI input driver as
# Line 1724  Internet-Draft        LinuxSampler Contr Line 1785  Internet-Draft        LinuxSampler Contr
1785    
1786           "."           "."
1787    
 6.3.4.  Getting information about specific MIDI input driver parameter  
1788    
    Use the following command to get detailed information about a  
    specific parameter of a specific MIDI input driver:  
1789    
1790    
1791    Schoenebeck             Expires October 18, 2007               [Page 32]
1792    
1793    Internet-Draft        LinuxSampler Control Protocol           April 2007
1794    
1795    
1796  Schoenebeck               Expires May 30, 2007                 [Page 31]  6.3.4.  Getting information about specific MIDI input driver parameter
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
1797    
1798       Use the following command to get detailed information about a
1799       specific parameter of a specific MIDI input driver:
1800    
1801        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1802    
# Line 1781  Internet-Draft        LinuxSampler Contr Line 1842  Internet-Draft        LinuxSampler Contr
1842           MIDI_INPUT_DEVICE' (Section 6.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    
       FIX -  
   
          either true or false, if false then this parameter can be  
          changed at any time, once the device is created by the 'CREATE  
1845    
1846    
1847    Schoenebeck             Expires October 18, 2007               [Page 33]
 Schoenebeck               Expires May 30, 2007                 [Page 32]  
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1850    
1851    
1852          FIX -
1853    
1854             either true or false, if false then this parameter can be
1855             changed at any time, once the device is created by the 'CREATE
1856           MIDI_INPUT_DEVICE' (Section 6.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    
# Line 1837  Internet-Draft        LinuxSampler Contr Line 1897  Internet-Draft        LinuxSampler Contr
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 May 30, 2007                 [Page 33]  Schoenebeck             Expires October 18, 2007               [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 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,
# Line 1893  Internet-Draft        LinuxSampler Contr Line 1952  Internet-Draft        LinuxSampler Contr
1952    
1953     Possible Answers:     Possible Answers:
1954    
       "OK[<device-id>]" -  
1955    
          in case the device was successfully created, where <device-id>  
          is the numerical ID of the new device  
1956    
1957    
1958    
1959  Schoenebeck               Expires May 30, 2007                 [Page 34]  Schoenebeck             Expires October 18, 2007               [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
1962    
1963    
1964          "OK[<device-id>]" -
1965    
1966             in case the device was successfully created, where <device-id>
1967             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>
# Line 1947  Internet-Draft        LinuxSampler Contr Line 2008  Internet-Draft        LinuxSampler Contr
2008    
2009        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2010    
          in case it failed, providing an appropriate error code and  
          error message  
2011    
    Example:  
2012    
2013    
2014    
2015    Schoenebeck             Expires October 18, 2007               [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol           April 2007
2018    
2019    
2020  Schoenebeck               Expires May 30, 2007                 [Page 35]           in case it failed, providing an appropriate error code and
2021             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2022    
2023       Example:
2024    
2025        C: "DESTROY MIDI_INPUT_DEVICE 0"        C: "DESTROY MIDI_INPUT_DEVICE 0"
2026    
# Line 2003  Internet-Draft        LinuxSampler Contr Line 2064  Internet-Draft        LinuxSampler Contr
2064    
2065        S: "1,3"        S: "1,3"
2066    
 6.3.9.  Getting current settings of a MIDI input device  
2067    
    Use the following command to get current settings of a specific,  
    created MIDI input device:  
2068    
2069    
2070    
2071    Schoenebeck             Expires October 18, 2007               [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol           April 2007
2074    
2075    
2076  Schoenebeck               Expires May 30, 2007                 [Page 36]  6.3.9.  Getting current settings of a MIDI input device
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2077    
2078       Use the following command to get current settings of a specific,
2079       created MIDI input device:
2080    
2081        GET MIDI_INPUT_DEVICE INFO <device-id>        GET MIDI_INPUT_DEVICE INFO <device-id>
2082    
# Line 2060  Internet-Draft        LinuxSampler Contr Line 2121  Internet-Draft        LinuxSampler Contr
2121    
2122        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
2123    
          "ACTIVE: true"  
   
          "."  
2124    
2125    
2126    
2127    Schoenebeck             Expires October 18, 2007               [Page 38]
2128    
2129    Internet-Draft        LinuxSampler Control Protocol           April 2007
2130    
2131    
2132  Schoenebeck               Expires May 30, 2007                 [Page 37]           "ACTIVE: true"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2133    
2134             "."
2135    
2136  6.3.10.  Changing settings of MIDI input devices  6.3.10.  Changing settings of MIDI input devices
2137    
# Line 2117  Internet-Draft        LinuxSampler Contr Line 2177  Internet-Draft        LinuxSampler Contr
2177    
2178     Where <device-id> is the numerical ID of the MIDI input device as     Where <device-id> is the numerical ID of the MIDI input device as
2179     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
    MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI  
    input port number.  
   
    Possible Answers:  
2180    
2181    
2182    
2183  Schoenebeck               Expires May 30, 2007                 [Page 38]  Schoenebeck             Expires October 18, 2007               [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2186    
2187    
2188       MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2189       input port number.
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
# Line 2172  Internet-Draft        LinuxSampler Contr Line 2233  Internet-Draft        LinuxSampler Contr
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
       character string to that info category.  There is information  
       which is always returned, independently of the given channel  
       parameter and there is optional information which are only shown  
       dependently to the given MIDI port.  At the moment the following  
       information categories are defined:  
2236    
2237    
2238    
2239  Schoenebeck               Expires May 30, 2007                 [Page 39]  Schoenebeck             Expires October 18, 2007               [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2242    
2243    
2244          character string to that info category.  There is information
2245          which is always returned, independently of the given channel
2246          parameter and there is optional information which are only shown
2247          dependently to the given MIDI port.  At the moment the following
2248          information categories are defined:
2249    
2250        TYPE -        TYPE -
2251    
# Line 2227  Internet-Draft        LinuxSampler Contr Line 2289  Internet-Draft        LinuxSampler Contr
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
          returned, dependent to device and port parameter)  
2292    
    The mentioned fields above don't have to be in particular order.  
2293    
    Example:  
2294    
2295    Schoenebeck             Expires October 18, 2007               [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol           April 2007
2298    
2299    
2300             returned, dependent to device and port parameter)
2301    
2302  Schoenebeck               Expires May 30, 2007                 [Page 40]     The mentioned fields above don't have to be in particular order.
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2303    
2304       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    
# Line 2282  Internet-Draft        LinuxSampler Contr Line 2344  Internet-Draft        LinuxSampler Contr
2344    
2345        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2346    
          in case it failed, providing an appropriate error code and  
          error message  
   
    Example:  
2347    
2348    
2349    
2350    
2351    Schoenebeck             Expires October 18, 2007               [Page 42]
2352    
2353    Internet-Draft        LinuxSampler Control Protocol           April 2007
2354    
2355    
2356  Schoenebeck               Expires May 30, 2007                 [Page 41]           in case it failed, providing an appropriate error code and
2357             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2358    
2359       Example:
2360    
2361    
2362    
# Line 2340  Internet-Draft        LinuxSampler Contr Line 2401  Internet-Draft        LinuxSampler Contr
2401    
2402           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2403           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
          or more patch parameters provided by the loaded instrument  
          file), providing an appropriate warning code and warning  
          message  
   
2404    
2405    
2406    
2407    Schoenebeck             Expires October 18, 2007               [Page 43]
 Schoenebeck               Expires May 30, 2007                 [Page 42]  
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2410    
2411    
2412             or more patch parameters provided by the loaded instrument
2413             file), providing an appropriate warning code and warning
2414             message
2415    
2416        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2417    
# Line 2398  Internet-Draft        LinuxSampler Contr Line 2458  Internet-Draft        LinuxSampler Contr
2458           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2459           error message           error message
2460    
    Example:  
   
   
   
2461    
2462    
2463  Schoenebeck               Expires May 30, 2007                 [Page 43]  Schoenebeck             Expires October 18, 2007               [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2466    
2467    
2468       Example:
2469    
2470    
2471    
2472  6.4.3.  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
# Line 2454  Internet-Draft        LinuxSampler Contr Line 2512  Internet-Draft        LinuxSampler Contr
2512     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
2513     list by sending the following command:     list by sending the following command:
2514    
       ADD CHANNEL  
2515    
    This will increment the sampler channel count by one and the new  
2516    
2517    
2518    
2519  Schoenebeck               Expires May 30, 2007                 [Page 44]  Schoenebeck             Expires October 18, 2007               [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2522    
2523    
2524          ADD CHANNEL
2525    
2526       This will increment the sampler channel count by one and the new
2527     sampler channel will be appended to the end of the sampler channel     sampler channel will be appended to the end of the sampler channel
2528     list.  The front-end should send the respective, related commands     list.  The front-end should send the respective, related commands
2529     right after to e.g. load an engine, load an instrument and setting     right after to e.g. load an engine, load an instrument and setting
# Line 2513  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575    Schoenebeck             Expires October 18, 2007               [Page 46]
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 45]  
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2578    
2579    
2580        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires May 30, 2007                 [Page 46]  Schoenebeck             Expires October 18, 2007               [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2634    
2635    
2636        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires May 30, 2007                 [Page 47]  Schoenebeck             Expires October 18, 2007               [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2690    
2691    
2692           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires May 30, 2007                 [Page 48]  Schoenebeck             Expires October 18, 2007               [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2746    
2747    
2748              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck               Expires May 30, 2007                 [Page 49]  Schoenebeck             Expires October 18, 2007               [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
2802    
2803    
2804           MUTE -           MUTE -
# Line 2758  Internet-Draft        LinuxSampler Contr Line 2814  Internet-Draft        LinuxSampler Contr
2814              Determines whether this is a solo channel, "true" if the              Determines whether this is a solo channel, "true" if the
2815              channel is a solo channel; "false" otherwise              channel is a solo channel; "false" otherwise
2816    
2817             MIDI_INSTRUMENT_MAP -
2818    
2819                Determines to which MIDI instrument map this sampler channel
2820                is assigned to.  Read chapter "SET CHANNEL
2821                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2822                values.
2823    
2824     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2825    
2826     Example:     Example:
# Line 2786  Internet-Draft        LinuxSampler Contr Line 2849  Internet-Draft        LinuxSampler Contr
2849    
2850           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2851    
          "MIDI_INPUT_CHANNEL: 5"  
2852    
          "."  
2853    
2854    
2855    Schoenebeck             Expires October 18, 2007               [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol           April 2007
2858    
2859    
2860             "MIDI_INPUT_CHANNEL: 5"
2861    
2862             "VOLUME: 1.0"
2863    
2864             "MUTE: false"
2865    
2866  Schoenebeck               Expires May 30, 2007                 [Page 50]           "SOLO: false"
2867    
2868  Internet-Draft        LinuxSampler Control Protocol        November 2006           "MIDI_INSTRUMENT_MAP: NONE"
2869    
2870             "."
2871    
2872  6.4.11.  Current number of active voices  6.4.11.  Current number of active voices
2873    
# Line 2837  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2906        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2907        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
       return "NA" for not available.  
   
    Example:  
2908    
2909    
2910    
2911  6.4.13.  Current fill state of disk stream buffers  Schoenebeck             Expires October 18, 2007               [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol           April 2007
2914    
    The front-end can ask for the current fill state of all disk streams  
    on a sampler channel by sending the following command:  
2915    
2916          return "NA" for not available.
2917    
2918       Example:
2919    
2920    
2921    
2922  Schoenebeck               Expires May 30, 2007                 [Page 51]  6.4.13.  Current fill state of disk stream buffers
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2923    
2924       The front-end can ask for the current fill state of all disk streams
2925       on a sampler channel by sending the following command:
2926    
2927        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
2928    
# Line 2893  Internet-Draft        LinuxSampler Contr Line 2960  Internet-Draft        LinuxSampler Contr
2960    
2961        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2962    
2963    
2964    
2965    
2966    
2967    Schoenebeck             Expires October 18, 2007               [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol           April 2007
2970    
2971    
2972        S: ""        S: ""
2973    
2974  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2905  Internet-Draft        LinuxSampler Contr Line 2981  Internet-Draft        LinuxSampler Contr
2981    
2982     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
2983     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
2984     (Section 6.4.4) command and <audio-device-id> is the numerical ID of     (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2985     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2986     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
# Line 2949  Internet-Draft        LinuxSampler Contr Line 3017  Internet-Draft        LinuxSampler Contr
3017        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3018        type>        type>
3019    
3020    
3021    
3022    
3023    Schoenebeck             Expires October 18, 2007               [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol           April 2007
3026    
3027    
3028     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3029     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3030    
# Line 2960  Internet-Draft        LinuxSampler Contr Line 3036  Internet-Draft        LinuxSampler Contr
3036    
3037        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3038    
   
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3039           if audio output type was set, but there are noteworthy issue(s)           if audio output type was set, but there are noteworthy issue(s)
3040           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3041           message           message
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3072  Internet-Draft        LinuxSampler Contr
3072    
3073        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck             Expires October 18, 2007               [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol           April 2007
3082    
3083    
3084           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3085           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3086           warning message           warning message
# Line 3018  Internet-Draft        LinuxSampler Contr Line 3094  Internet-Draft        LinuxSampler Contr
3094    
3095    
3096    
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
   
   
3097  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
3098    
3099     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
# Line 3061  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129    
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck             Expires October 18, 2007               [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol           April 2007
3138    
3139    
3140  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3141    
3142     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3073  Internet-Draft        LinuxSampler Contr Line 3149  Internet-Draft        LinuxSampler Contr
3149     Where <midi-input-type> is currently only "ALSA" and <sampler-     Where <midi-input-type> is currently only "ALSA" and <sampler-
3150     channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3151    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3152     Possible Answers:     Possible Answers:
3153    
3154        "OK" -        "OK" -
# Line 3116  Internet-Draft        LinuxSampler Contr Line 3184  Internet-Draft        LinuxSampler Contr
3184    
3185        "OK" -        "OK" -
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck             Expires October 18, 2007               [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol           April 2007
3194    
3195    
3196           on success           on success
3197    
3198        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3129  Internet-Draft        LinuxSampler Contr Line 3206  Internet-Draft        LinuxSampler Contr
3206           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3207           error message           error message
3208    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3209     Examples:     Examples:
3210    
3211    
# Line 3173  Internet-Draft        LinuxSampler Contr Line 3242  Internet-Draft        LinuxSampler Contr
3242    
3243    
3244    
3245    
3246    
3247    Schoenebeck             Expires October 18, 2007               [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol           April 2007
3250    
3251    
3252    
3253    
3254  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3255    
3256     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
# Line 3185  Internet-Draft        LinuxSampler Contr Line 3263  Internet-Draft        LinuxSampler Contr
3263     means amplification) and <sampler-channel> defines the sampler     means amplification) and <sampler-channel> defines the sampler
3264     channel where this volume factor should be set.     channel where this volume factor should be set.
3265    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3266     Possible Answers:     Possible Answers:
3267    
3268        "OK" -        "OK" -
# Line 3228  Internet-Draft        LinuxSampler Contr Line 3298  Internet-Draft        LinuxSampler Contr
3298    
3299     Possible Answers:     Possible Answers:
3300    
3301    
3302    
3303    Schoenebeck             Expires October 18, 2007               [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol           April 2007
3306    
3307    
3308        "OK" -        "OK" -
3309    
3310           on success           on success
# Line 3240  Internet-Draft        LinuxSampler Contr Line 3317  Internet-Draft        LinuxSampler Contr
3317    
3318        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3319    
   
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3320           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3321           error message           error message
3322    
# Line 3285  Internet-Draft        LinuxSampler Contr Line 3353  Internet-Draft        LinuxSampler Contr
3353           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3354           error message           error message
3355    
3356    
3357    
3358    
3359    Schoenebeck             Expires October 18, 2007               [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol           April 2007
3362    
3363    
3364     Examples:     Examples:
3365    
3366    
3367    
3368  6.4.24.  Resetting a sampler channel  6.4.24.  Assigning a MIDI instrument map to a sampler channel
3369    
3370     The front-end can reset a particular sampler channel by sending the     The front-end can assign a MIDI instrument map to a specific sampler
3371     following command:     channel by sending the following command:
3372    
3373        RESET CHANNEL <sampler-channel>        SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3374    
3375     Where <sampler-channel> defines the sampler channel to be reset.     Where <sampler-channel> is the respective sampler channel number as
3376       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3377       (Section 6.4.4) command and <map> can have the following
3378       possibilites:
3379    
3380          "NONE" -
3381    
3382             This is the default setting.  In this case the sampler channel
3383             is not assigned any MIDI instrument map and thus will ignore
3384             all MIDI program change messages.
3385    
3386          "DEFAULT" -
3387    
3388             The sampler channel will always use the default MIDI instrument
3389             map to handle MIDI program change messages.
3390    
3391          numeric ID -
3392    
3393             You can assign a specific MIDI instrument map by replacing
3394             <map> with the respective numeric ID of the MIDI instrument map
3395             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3396             command.  Once that map will be deleted, the sampler channel
3397             would fall back to "NONE".
3398    
3399  Schoenebeck               Expires May 30, 2007                 [Page 59]     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3400       regarding MIDI instrument mapping.
3401    
3402       Possible Answers:
3403    
3404          "OK" -
3405    
3406             on success
3407    
3408          "ERR:<error-code>:<error-message>" -
3409    
3410             in case it failed, providing an appropriate error code and
3411             error message
3412    
3413    
3414    
3415    Schoenebeck             Expires October 18, 2007               [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol           April 2007
3418    
3419    
3420       Examples:
3421    
3422    
3423    
3424    6.4.25.  Adding an effect send to a sampler channel
3425    
3426       The front-end can create an additional effect send on a specific
3427       sampler channel by sending the following command:
3428    
3429          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3430    
3431       Where <sampler-channel> is the respective sampler channel number as
3432       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3433       (Section 6.4.4) command, that is the sampler channel on which the
3434       effect send should be created on, <midi-ctrl> is a number between
3435       0..127 defining the MIDI controller which can alter the effect send
3436       level and <name> is an optional argument defining a name for the
3437       effect send entity.  The name does not have to be unique.
3438    
3439       By default, that is as initial routing, the effect send's audio
3440       channels are automatically routed to the last audio channels of the
3441       sampler channel's audio output device, that way you can i.e. first
3442       increase the amount of audio channels on the audio output device for
3443       having dedicated effect send output channels and when "CREATE
3444       FX_SEND" is called, those channels will automatically be picked.  You
3445       can alter the destination channels however with "SET FX_SEND
3446       AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3447    
3448       Note: Create effect sends on a sampler channel only when needed,
3449       because having effect sends on a sampler channel will decrease
3450       runtime performance, because for implementing channel effect sends,
3451       separate (sampler channel local) audio buffers are needed to render
3452       and mix the voices and route the audio signal afterwards to the
3453       master outputs and effect send outputs (along with their respective
3454       effect send levels).  A sampler channel without effect sends however
3455       can mix its voices directly into the audio output devices's audio
3456       buffers and is thus faster.
3457    
3458       Possible Answers:
3459    
3460          "OK[<fx-send-id>]" -
3461    
3462             in case a new effect send could be added to the sampler
3463             channel, where <fx-send-id> reflects the unique ID of the newly
3464             created effect send entity
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck             Expires October 18, 2007               [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol           April 2007
3474    
3475    
3476          "ERR:<error-code>:<error-message>" -
3477    
3478             when a new effect send could not be added, i.e. due to invalid
3479             parameters
3480    
3481       Examples:
3482    
3483          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3484    
3485          S: "OK[0]"
3486    
3487          C: "CREATE FX_SEND 0 93"
3488    
3489          S: "OK[1]"
3490    
3491    6.4.26.  Removing an effect send from a sampler channel
3492    
3493       The front-end can remove an existing effect send on a specific
3494       sampler channel by sending the following command:
3495    
3496          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3497    
3498       Where <sampler-channel> is the respective sampler channel number as
3499       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3500       (Section 6.4.4) command, that is the sampler channel from which the
3501       effect send should be removed from and <fx-send-id> is the respective
3502       effect send number as returned by the "CREATE FX_SEND"
3503       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3504    
3505       Possible Answers:
3506    
3507          "OK" -
3508    
3509             on success
3510    
3511          "ERR:<error-code>:<error-message>" -
3512    
3513             in case it failed, providing an appropriate error code and
3514             error message
3515    
3516       Example:
3517    
3518          C: "DESTROY FX_SEND 0 0"
3519    
3520          S: "OK"
3521    
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck             Expires October 18, 2007               [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
3530    
3531    
3532    6.4.27.  Getting amount of effect sends on a sampler channel
3533    
3534       The front-end can ask for the amount of effect sends on a specific
3535       sampler channel by sending the following command:
3536    
3537          GET FX_SENDS <sampler-channel>
3538    
3539       Where <sampler-channel> is the respective sampler channel number as
3540       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3541       (Section 6.4.4) command.
3542    
3543       Possible Answers:
3544    
3545          The sampler will answer by returning the number of effect sends on
3546          the given sampler channel.
3547    
3548       Example:
3549    
3550          C: "GET FX_SENDS 0"
3551    
3552          S: "2"
3553    
3554    6.4.28.  Listing all effect sends on a sampler channel
3555    
3556       The front-end can ask for a list of effect sends on a specific
3557       sampler channel by sending the following command:
3558    
3559          LIST FX_SENDS <sampler-channel>
3560    
3561       Where <sampler-channel> is the respective sampler channel number as
3562       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3563       (Section 6.4.4) command.
3564    
3565       Possible Answers:
3566    
3567          The sampler will answer by returning a comma separated list with
3568          all effect sends' numerical IDs on the given sampler channel.
3569    
3570       Examples:
3571    
3572          C: "LIST FX_SENDS 0"
3573    
3574          S: "0,1"
3575    
3576          C: "LIST FX_SENDS 1"
3577    
3578          S: ""
3579    
3580    
3581    
3582    
3583    Schoenebeck             Expires October 18, 2007               [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol           April 2007
3586    
3587    
3588    6.4.29.  Getting effect send information
3589    
3590       The front-end can ask for the current settings of an effect send
3591       entity by sending the following command:
3592    
3593          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3594    
3595       Where <sampler-channel> is the sampler channel number as returned by
3596       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3597       command and <fx-send-id> reflects the numerical ID of the effect send
3598       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3599       FX_SENDS" (Section 6.4.28) command.
3600    
3601       Possible Answers:
3602    
3603          The sampler will answer by sending a <CRLF> separated list.  Each
3604          answer line begins with the settings category name followed by a
3605          colon and then a space character <SP> and finally the info
3606          character string to that setting category.  At the moment the
3607          following categories are defined:
3608    
3609    
3610    
3611             NAME -
3612    
3613                name of the effect send entity
3614    
3615             MIDI_CONTROLLER -
3616    
3617                a value between 0 and 127 reflecting the MIDI controller
3618                which is able to modify the effect send's send level
3619    
3620             LEVEL -
3621    
3622                optionally dotted number reflecting the effect send's
3623                current send level (where a value < 1.0 means attenuation
3624                and a value > 1.0 means amplification)
3625    
3626             AUDIO_OUTPUT_ROUTING -
3627    
3628                comma separated list which reflects to which audio channel
3629                of the selected audio output device each effect send output
3630                channel is routed to, e.g. "0,3" would mean the effect
3631                send's output channel 0 is routed to channel 0 of the audio
3632                output device and the effect send's output channel 1 is
3633                routed to the channel 3 of the audio output device (see "SET
3634                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires October 18, 2007               [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol           April 2007
3642    
3643    
3644       The mentioned fields above don't have to be in particular order.
3645    
3646       Example:
3647    
3648          C: "GET FX_SEND INFO 0 0"
3649    
3650          S: "NAME: Reverb Send"
3651    
3652             "MIDI_CONTROLLER: 91"
3653    
3654             "LEVEL: 0.3"
3655    
3656             "AUDIO_OUTPUT_ROUTING: 2,3"
3657    
3658             "."
3659    
3660    6.4.30.  Changing effect send's name
3661    
3662       The front-end can alter the current name of an effect send entity by
3663       sending the following command:
3664    
3665          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3666    
3667       Where <sampler-chan> is the sampler channel number as returned by the
3668       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3669       command, <fx-send-id> reflects the numerical ID of the effect send
3670       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3671       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3672       effect send entity, which does not have to be unique.
3673    
3674       Possible Answers:
3675    
3676          "OK" -
3677    
3678             on success
3679    
3680          "ERR:<error-code>:<error-message>" -
3681    
3682             in case it failed, providing an appropriate error code and
3683             error message
3684    
3685       Example:
3686    
3687          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3688    
3689          S: "OK"
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires October 18, 2007               [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol           April 2007
3698    
3699    
3700    6.4.31.  Altering effect send's audio routing
3701    
3702       The front-end can alter the destination of an effect send's audio
3703       channel on a specific sampler channel by sending the following
3704       command:
3705    
3706          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3707          <audio-src> <audio-dst>
3708    
3709       Where <sampler-chan> is the sampler channel number as returned by the
3710       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3711       command, <fx-send-id> reflects the numerical ID of the effect send
3712       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3713       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3714       of the effect send's audio channel which should be rerouted and
3715       <audio-dst> is the numerical ID of the audio channel of the selected
3716       audio output device where <audio-src> should be routed to.
3717    
3718       Note that effect sends can only route audio to the same audio output
3719       device as assigned to the effect send's sampler channel.  Also note
3720       that an effect send entity does always have exactly as much audio
3721       channels as its sampler channel.  So if the sampler channel is
3722       stereo, the effect send does have two audio channels as well.  Also
3723       keep in mind that the amount of audio channels on a sampler channel
3724       might be dependant not only to the deployed sampler engine on the
3725       sampler channel, but also dependant to the instrument currently
3726       loaded.  However you can (effectively) turn an i.e. stereo effect
3727       send into a mono one by simply altering its audio routing
3728       appropriately.
3729    
3730       Possible Answers:
3731    
3732          "OK" -
3733    
3734             on success
3735    
3736          "WRN:<warning-code>:<warning-message>" -
3737    
3738             if audio output channel was set, but there are noteworthy
3739             issue(s) related, providing an appropriate warning code and
3740             warning message
3741    
3742          "ERR:<error-code>:<error-message>" -
3743    
3744             in case it failed, providing an appropriate error code and
3745             error message
3746    
3747       Example:
3748    
3749    
3750    
3751    Schoenebeck             Expires October 18, 2007               [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol           April 2007
3754    
3755    
3756          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3757    
3758          S: "OK"
3759    
3760    6.4.32.  Altering effect send's MIDI controller
3761    
3762       The front-end can alter the MIDI controller of an effect send entity
3763       by sending the following command:
3764    
3765          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3766          ctrl>
3767    
3768       Where <sampler-chan> is the sampler channel number as returned by the
3769       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3770       command, <fx-send-id> reflects the numerical ID of the effect send
3771       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3772       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3773       controller which shall be able to modify the effect send's send
3774       level.
3775    
3776       Possible Answers:
3777    
3778          "OK" -
3779    
3780             on success
3781    
3782          "WRN:<warning-code>:<warning-message>" -
3783    
3784             if MIDI controller was set, but there are noteworthy issue(s)
3785             related, providing an appropriate warning code and warning
3786             message
3787    
3788          "ERR:<error-code>:<error-message>" -
3789    
3790             in case it failed, providing an appropriate error code and
3791             error message
3792    
3793       Example:
3794    
3795          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3796    
3797          S: "OK"
3798    
3799    6.4.33.  Altering effect send's send level
3800    
3801       The front-end can alter the current send level of an effect send
3802       entity by sending the following command:
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires October 18, 2007               [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol           April 2007
3810    
3811    
3812          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3813    
3814       Where <sampler-chan> is the sampler channel number as returned by the
3815       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3816       command, <fx-send-id> reflects the numerical ID of the effect send
3817       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3818       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3819       dotted positive number (a value smaller than 1.0 means attenuation,
3820       whereas a value greater than 1.0 means amplification) reflecting the
3821       new send level.
3822    
3823       Possible Answers:
3824    
3825          "OK" -
3826    
3827             on success
3828    
3829          "WRN:<warning-code>:<warning-message>" -
3830    
3831             if new send level was set, but there are noteworthy issue(s)
3832             related, providing an appropriate warning code and warning
3833             message
3834    
3835          "ERR:<error-code>:<error-message>" -
3836    
3837             in case it failed, providing an appropriate error code and
3838             error message
3839    
3840       Example:
3841    
3842          C: "SET FX_SEND LEVEL 0 0 0.15"
3843    
3844          S: "OK"
3845    
3846    6.4.34.  Resetting a sampler channel
3847    
3848       The front-end can reset a particular sampler channel by sending the
3849       following command:
3850    
3851          RESET CHANNEL <sampler-channel>
3852    
3853       Where <sampler-channel> defines the sampler channel to be reset.
3854     This will cause the engine on that sampler channel, its voices and     This will cause the engine on that sampler channel, its voices and
3855     eventually disk streams and all control and status variables to be     eventually disk streams and all control and status variables to be
3856     reset.     reset.
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires October 18, 2007               [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol           April 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3351  Internet-Draft        LinuxSampler Contr Line 3905  Internet-Draft        LinuxSampler Contr
3905    
3906           on success           on success
3907    
3908          "WRN:<warning-code>:<warning-message>" -
3909    
3910             if registration succeeded, but there are noteworthy issue(s)
3911             related, providing an appropriate warning code and warning
3912             message
3913    
3914    
3915    
3916    
 Schoenebeck               Expires May 30, 2007                 [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3917    
3918    
3919        "WRN:<warning-code>:<warning-message>" -  Schoenebeck             Expires October 18, 2007               [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol           April 2007
3922    
          if registration succeeded, but there are noteworthy issue(s)  
          related, providing an appropriate warning code and warning  
          message  
3923    
3924        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3925    
# Line 3407  Internet-Draft        LinuxSampler Contr Line 3961  Internet-Draft        LinuxSampler Contr
3961    
3962    
3963    
   
   
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3964  6.5.3.  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
3965    
3966     To enable or disable back sending of commands to the client the     To enable or disable back sending of commands to the client the
# Line 3425  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969        SET ECHO <value>        SET ECHO <value>
3970    
3971     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
3972    
3973    
3974    
3975    Schoenebeck             Expires October 18, 2007               [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol           April 2007
3978    
3979    
3980     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3981     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3982     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 3464  Internet-Draft        LinuxSampler Contr Line 4016  Internet-Draft        LinuxSampler Contr
4016     The front-end can ask for the current number of active voices on the     The front-end can ask for the current number of active voices on the
4017     sampler by sending the following command:     sampler by sending the following command:
4018    
4019          GET TOTAL_VOICE_COUNT
4020    
4021       Possible Answers:
4022    
4023          LinuxSampler will answer by returning the number of all active
4024          voices on the sampler.
4025    
4026    
 Schoenebeck               Expires May 30, 2007                 [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4027    
4028    
       GET TOTAL_VOICE_COUNT  
4029    
    Possible Answers:  
4030    
4031        LinuxSampler will answer by returning the number of all active  Schoenebeck             Expires October 18, 2007               [Page 72]
4032        voices on the sampler.  
4033    Internet-Draft        LinuxSampler Control Protocol           April 2007
4034    
4035    
4036  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4037    
# Line 3521  Internet-Draft        LinuxSampler Contr Line 4074  Internet-Draft        LinuxSampler Contr
4074        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4075        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4076        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
4077          character string to that information category.  At the moment the
4078          following categories are defined:
4079    
4080    
4081    
4082  Schoenebeck               Expires May 30, 2007                 [Page 63]           DESCRIPTION -
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4083    
4084    
       character string to that information category.  At the moment the  
       following categories are defined:  
4085    
4086    
4087    Schoenebeck             Expires October 18, 2007               [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol           April 2007
4090    
          DESCRIPTION -  
4091    
4092              arbitrary textual description about the sampler              arbitrary textual description about the sampler
4093    
# Line 3547  Internet-Draft        LinuxSampler Contr Line 4100  Internet-Draft        LinuxSampler Contr
4100              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4101              (see Section 2 for details)              (see Section 2 for details)
4102    
4103             INSTRUMENTS_DB_SUPPORT -
4104    
4105                either yes or no, specifies whether the sampler is build
4106                with instruments database support.
4107    
4108     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4109     Other fields might be added in future.     Other fields might be added in future.
4110    
4111    6.6.5.  Getting global volume attenuation
4112    
4113       The client can ask for the current global sampler-wide volume
4114       attenuation by sending the following command:
4115    
4116          GET VOLUME
4117    
4118       Possible Answers:
4119    
4120          The sampler will always answer by returning the optional dotted
4121          floating point coefficient, reflecting the current global volume
4122          attenuation.
4123    
4124       Note: it is up to the respective sampler engine whether to obey that
4125       global volume parameter or not, but in general all engines SHOULD use
4126       this parameter.
4127    
4128    6.6.6.  Setting global volume attenuation
4129    
4130       The client can alter the current global sampler-wide volume
4131       attenuation by sending the following command:
4132    
4133          SET VOLUME <volume>
4134    
4135       Where <volume> should be replaced by the optional dotted floating
4136       point value, reflecting the new global volume parameter.  This value
4137       might usually be in the range between 0.0 and 1.0, that is for
4138       attenuating the overall volume.
4139    
4140    
4141    
4142    
4143    Schoenebeck             Expires October 18, 2007               [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol           April 2007
4146    
4147    
4148       Possible Answers:
4149    
4150          "OK" -
4151    
4152             on success
4153    
4154          "WRN:<warning-code>:<warning-message>" -
4155    
4156             if the global volume was set, but there are noteworthy issue(s)
4157             related, providing an appropriate warning code and warning
4158             message
4159    
4160          "ERR:<error-code>:<error-message>" -
4161    
4162             in case it failed, providing an appropriate error code and
4163             error message
4164    
4165  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4166    
4167     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 3558  Internet-Draft        LinuxSampler Contr Line 4170  Internet-Draft        LinuxSampler Contr
4170     actually map arbitrary MIDI bank select / program change numbers with     actually map arbitrary MIDI bank select / program change numbers with
4171     real instruments.     real instruments.
4172    
4173     By default, that is when the sampler is launched, this map will be     The sampler allows to manage an arbitrary amount of MIDI instrument
4174     empty, thus the sampler will simply ignore all program change     maps which define which instrument to load on which MIDI program
4175     messages.  The front-end has to explicitly add entries to the map so     change message.
4176     the sampler knows how to react on a given program change message,  
4177     that is by switching to the respectively defined engine type and     By default, that is when the sampler is launched, there is no map,
4178     loading the respective instrument.     thus the sampler will simply ignore all program change messages.  The
4179       front-end has to explicitly create at least one map, add entries to
4180       the map and tell the respective sampler channel(s) which MIDI
4181       instrument map to use, so the sampler knows how to react on a given
4182       program change message on the respective sampler channel, that is by
4183       switching to the respectively defined engine type and loading the
4184       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4185       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4186       channel.
4187    
4188     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4189     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
# Line 3572  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4193     current MIDI instrument map.     current MIDI instrument map.
4194    
 6.7.1.  Create or replace a MIDI instrument map entry  
4195    
    The front-end can create a new or replace an existing entry in the  
    sampler's MIDI instrument map by sending the following command:  
4196    
4197    
4198    
4199    Schoenebeck             Expires October 18, 2007               [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol           April 2007
4202    
4203    
4204    6.7.1.  Create a new MIDI instrument map
4205    
4206       The front-end can add a new MIDI instrument map by sending the
4207       following command:
4208    
4209          ADD MIDI_INSTRUMENT_MAP [<name>]
4210    
4211       Where <name> is an optional argument allowing to assign a custom name
4212       to the new map.  MIDI instrument Map names do not have to be unique.
4213    
4214       Possible Answers:
4215    
4216          "OK[<map>]" -
4217    
4218             in case a new MIDI instrument map could be added, where <map>
4219             reflects the unique ID of the newly created MIDI instrument map
4220    
4221          "ERR:<error-code>:<error-message>" -
4222    
4223             when a new map could not be created, which might never occur in
4224             practice
4225    
4226       Examples:
4227    
4228          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4229    
4230          S: "OK[0]"
4231    
4232  Schoenebeck               Expires May 30, 2007                 [Page 64]        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4233    
4234          S: "OK[1]"
4235    
4236          C: "ADD MIDI_INSTRUMENT_MAP"
4237    
4238          S: "OK[5]"
4239    
4240    6.7.2.  Delete one particular or all MIDI instrument maps
4241    
4242       The front-end can delete a particular MIDI instrument map by sending
4243       the following command:
4244    
4245          REMOVE MIDI_INSTRUMENT_MAP <map>
4246    
4247       Where <map> reflects the unique ID of the map to delete as returned
4248       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4249    
4250       The front-end can delete all MIDI instrument maps by sending the
4251       following command:
4252    
4253    
4254    
4255    Schoenebeck             Expires October 18, 2007               [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4258    
4259    
4260          REMOVE MIDI_INSTRUMENT_MAP ALL
4261    
4262       Possible Answers:
4263    
4264          "OK" -
4265    
4266             in case the map(s) could be deleted
4267    
4268          "ERR:<error-code>:<error-message>" -
4269    
4270             when the given map does not exist
4271    
4272       Examples:
4273    
4274          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4275    
4276        MAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        S: "OK"
4277    
4278          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4279    
4280          S: "OK"
4281    
4282    6.7.3.  Get amount of existing MIDI instrument maps
4283    
4284       The front-end can retrieve the current amount of MIDI instrument maps
4285       by sending the following command:
4286    
4287          GET MIDI_INSTRUMENT_MAPS
4288    
4289       Possible Answers:
4290    
4291          The sampler will answer by returning the current number of MIDI
4292          instrument maps.
4293    
4294       Example:
4295    
4296          C: "GET MIDI_INSTRUMENT_MAPS"
4297    
4298          S: "2"
4299    
4300    6.7.4.  Getting all created MIDI instrument maps
4301    
4302       The number of MIDI instrument maps can change on runtime.  To get the
4303       current list of MIDI instrument maps, the front-end can send the
4304       following command:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck             Expires October 18, 2007               [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol           April 2007
4314    
4315    
4316          LIST MIDI_INSTRUMENT_MAPS
4317    
4318       Possible Answers:
4319    
4320          The sampler will answer by returning a comma separated list with
4321          all MIDI instrument maps' numerical IDs.
4322    
4323       Example:
4324    
4325          C: "LIST MIDI_INSTRUMENT_MAPS"
4326    
4327          S: "0,1,5,12"
4328    
4329    6.7.5.  Getting MIDI instrument map information
4330    
4331       The front-end can ask for the current settings of a MIDI instrument
4332       map by sending the following command:
4333    
4334          GET MIDI_INSTRUMENT_MAP INFO <map>
4335    
4336       Where <map> is the numerical ID of the map the front-end is
4337       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4338       (Section 6.7.4) command.
4339    
4340       Possible Answers:
4341    
4342          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4343          answer line begins with the settings category name followed by a
4344          colon and then a space character <SP> and finally the info
4345          character string to that setting category.  At the moment the
4346          following categories are defined:
4347    
4348    
4349    
4350             NAME -
4351    
4352                custom name of the given map, which does not have to be
4353                unique
4354    
4355             DEFAULT -
4356    
4357                either true or false, defines whether this map is the
4358                default map
4359    
4360       The mentioned fields above don't have to be in particular order.
4361    
4362       Example:
4363    
4364    
4365    
4366    
4367    Schoenebeck             Expires October 18, 2007               [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol           April 2007
4370    
4371    
4372          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4373    
4374          S: "NAME: Standard Map"
4375    
4376             "DEFAULT: true"
4377    
4378             "."
4379    
4380    6.7.6.  Renaming a MIDI instrument map
4381    
4382       The front-end can alter the custom name of a MIDI instrument map by
4383       sending the following command:
4384    
4385          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4386    
4387       Where <map> is the numerical ID of the map and <name> the new custom
4388       name of the map, which does not have to be unique.
4389    
4390       Possible Answers:
4391    
4392          "OK" -
4393    
4394             on success
4395    
4396          "ERR:<error-code>:<error-message>" -
4397    
4398             in case the given map does not exist
4399    
4400       Example:
4401    
4402          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4403    
4404          S: "OK"
4405    
4406    6.7.7.  Create or replace a MIDI instrument map entry
4407    
4408       The front-end can create a new or replace an existing entry in a
4409       sampler's MIDI instrument map by sending the following command:
4410    
4411          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4412        <engine_name> <filename> <instrument_index> <volume_value>        <engine_name> <filename> <instrument_index> <volume_value>
4413        [<instr_load_mode>] [<name>]        [<instr_load_mode>] [<name>]
4414    
4415     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4416     the MIDI bank select MSB (coarse) index, <midi_bank_lsb> an integer     integer value between 0..16383 reflecting the MIDI bank select index,
4417     value between 0..127 reflecting the MIDI bank select LSB (fine)     <midi_prog> an integer value between 0..127 reflecting the MIDI
4418     index, <midi_prog> an integer value between 0..127 reflecting the     program change index, <engine_name> a sampler engine name as returned
4419     MIDI program change index, <engine_name> a sampler engine name as     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4420     returned by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not  
4421    
4422    
4423    Schoenebeck             Expires October 18, 2007               [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol           April 2007
4426    
4427    
4428     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4429     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
4430     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 3626  Internet-Draft        LinuxSampler Contr Line 4456  Internet-Draft        LinuxSampler Contr
4456    
4457        "PERSISTENT" -        "PERSISTENT" -
4458    
4459           The instrument will immediately be loaded into memory in the           The instrument will immediately be loaded into memory when this
4460           background when this mapping command is sent and the instrument           mapping command is sent and the instrument is kept all the
4461           is kept all the time.  Instruments with this mode are only           time.  Instruments with this mode are only freed when the
4462           freed when the sampler is reset or all mapping entries with           sampler is reset or all mapping entries with this mode (and
4463           this mode (and respective instrument) are explicitly changed to           respective instrument) are explicitly changed to "ON_DEMAND"
4464           "ON_DEMAND" and no sampler channel is using the instrument           and no sampler channel is using the instrument anymore.
          anymore.  
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
4465    
4466        not supplied -        not supplied -
4467    
# Line 3651  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4474           that is it will not change the mode.           that is it will not change the mode.
4475    
4476    
4477    
4478    
4479    Schoenebeck             Expires October 18, 2007               [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol           April 2007
4482    
4483    
4484     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4485     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4486     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 3664  Internet-Draft        LinuxSampler Contr Line 4494  Internet-Draft        LinuxSampler Contr
4494     not allow a way to manage load modes for them individually.  Due to     not allow a way to manage load modes for them individually.  Due to
4495     this, in case the frontend shows the load modes of entries, the     this, in case the frontend shows the load modes of entries, the
4496     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4497     MIDI_INSTRUMENT INFO" (Section 6.7.5) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4498     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4499     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes) for the mapping entry, useful for frontends for
4500     displaying an appropriate name for mapped instruments (using "GET     displaying an appropriate name for mapped instruments (using "GET
4501     MIDI_INSTRUMENT INFO" (Section 6.7.5)).     MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4502    
4503     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4504     will not block when an instrument is to be loaded due to a     completely established in the sampler.  The OPTIONAL "NON_MODAL"
4505     "PERSISTENT" type entry as instruments are loaded in the background.     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4506     As a consequence this command may not necessarily return an error     to return immediately, that is to let the sampler establish the
4507     i.e. when the given instrument file does not exist or may turn out to     mapping in the background.  So this argument might be especially
4508     be corrupt.     useful for mappings with a "PERSISTENT" type, because these have to
4509       load the respective instruments immediately and might thus block for
4510       a very long time.  It is recommended however to use the OPTIONAL
4511       "NON_MODAL" argument only if really necessary, because it has the
4512       following drawbacks: as "NON_MODAL" instructions return immediately,
4513       they may not necessarily return an error i.e. when the given
4514       instrument file turns out to be corrupt, beside that subsequent
4515       commands in a LSCP instruction sequence might fail, because mandatory
4516       mappings are not yet completed.
4517    
4518     Possible Answers:     Possible Answers:
4519    
# Line 3685  Internet-Draft        LinuxSampler Contr Line 4523  Internet-Draft        LinuxSampler Contr
4523    
4524        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4525    
4526           when the given engine does not exist or a value is out of range           when the given map or engine does not exist or a value is out
4527             of range
4528    
4529     Examples:     Examples:
4530    
4531    
4532    
4533    
4534  Schoenebeck               Expires May 30, 2007                 [Page 66]  
4535    Schoenebeck             Expires October 18, 2007               [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
4538    
4539    
4540        C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4541        0.8 PERSISTENT"        0.8 PERSISTENT"
4542    
4543        S: "OK"        S: "OK"
4544    
4545        C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7        C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4546        1.0"        1.0"
4547    
4548        S: "OK"        S: "OK"
# Line 3712  Internet-Draft        LinuxSampler Contr Line 4552  Internet-Draft        LinuxSampler Contr
4552    
4553        S: "OK"        S: "OK"
4554    
4555        C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4556        'Silent Piano'"        'Silent Piano'"
4557    
4558        S: "OK"        S: "OK"
4559    
4560        C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4561        1.0 PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4562    
4563        S: "OK"        S: "OK"
4564    
4565  6.7.2.  Getting ammount of MIDI instrument map entries  6.7.8.  Getting ammount of MIDI instrument map entries
4566    
4567       The front-end can query the amount of currently existing entries in a
4568       MIDI instrument map by sending the following command:
4569    
4570     The front-end can query the amount of currently existing MIDI        GET MIDI_INSTRUMENTS <map>
    instrument map entries by sending the following command:  
4571    
4572        GET MIDI_INSTRUMENTS     The front-end can query the amount of currently existing entries in
4573       all MIDI instrument maps by sending the following command:
4574    
4575          GET MIDI_INSTRUMENTS ALL
4576    
4577     Possible Answers:     Possible Answers:
4578    
4579        LinuxSampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4580        in the sampler's MIDI instrument map.        in the MIDI instrument map(s).
4581    
4582     Example:     Example:
4583    
4584        C: "GET MIDI_INSTRUMENTS"        C: "GET MIDI_INSTRUMENTS 0"
4585    
4586        S: "634"        S: "234"
4587    
 6.7.3.  Getting indeces of all MIDI instrument map entries  
4588    
    The front-end can query a list of all currently existing MIDI  
    instrument map entries by sending the following command:  
4589    
4590    
4591    Schoenebeck             Expires October 18, 2007               [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol           April 2007
4594    
4595    
4596  Schoenebeck               Expires May 30, 2007                 [Page 67]        C: "GET MIDI_INSTRUMENTS ALL"
4597    
4598  Internet-Draft        LinuxSampler Control Protocol        November 2006        S: "954"
4599    
4600    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4601    
4602       The front-end can query a list of all currently existing entries in a
4603       certain MIDI instrument map by sending the following command:
4604    
4605        LIST MIDI_INSTRUMENTS        LIST MIDI_INSTRUMENTS <map>
4606    
4607       Where <map> is the numeric ID of the MIDI instrument map.
4608    
4609       The front-end can query a list of all currently existing entries of
4610       all MIDI instrument maps by sending the following command:
4611    
4612          LIST MIDI_INSTRUMENTS ALL
4613    
4614     Possible Answers:     Possible Answers:
4615    
4616        LinuxSampler will answer by sending a comma separated list of MIDI        The sampler will answer by sending a comma separated list of map
4617        bank MSB (coarse) - MIDI bank LSB (fine) - MIDI program triples,        ID - MIDI bank - MIDI program triples, where each triple is
4618        where each triple is encapsulated into curly braces.  The list is        encapsulated into curly braces.  The list is returned in one
4619        returned in one single line.  Each triple just reflects the key of        single line.  Each triple just reflects the key of the respective
4620        the respective map entry, thus subsequent "GET MIDI_INSTRUMENT        map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4621        INFO" (Section 6.7.5) command(s) are necessary to retrieve        (Section 6.7.11) command(s) are necessary to retrieve detailed
4622        detailed informations about each entry.        informations about each entry.
4623    
4624     Example:     Example:
4625    
4626        C: "LIST MIDI_INSTRUMENTS"        C: "LIST MIDI_INSTRUMENTS 0"
4627    
4628        S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4629    
4630  6.7.4.  Remove an entry from the MIDI instrument map  6.7.10.  Remove an entry from the MIDI instrument map
4631    
4632     The front-end can delete an entry from the MIDI instrument map by     The front-end can delete an entry from a MIDI instrument map by
4633     sending the following command:     sending the following command:
4634    
4635        UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4636    
4637     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4638     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value
4639     between 0..127 reflecting the MIDI bank LSB (fine) value and     and <midi_prog> an integer value between 0..127 reflecting the MIDI
4640     <midi_prog> an integer value between 0..127 reflecting the MIDI     program value of the map's entrie's key index triple.
    program value of the map entrie's key index triple.  
4641    
4642     Possible Answers:     Possible Answers:
4643    
4644    
4645    
4646    
4647    Schoenebeck             Expires October 18, 2007               [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol           April 2007
4650    
4651    
4652        "OK" -        "OK" -
4653    
4654           usually           usually
# Line 3796  Internet-Draft        LinuxSampler Contr Line 4659  Internet-Draft        LinuxSampler Contr
4659    
4660     Example:     Example:
4661    
4662        C: "UNMAP MIDI_INSTRUMENT 2 40 127"        C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4663    
4664        S: "OK"        S: "OK"
4665    
4666    6.7.11.  Get current settings of MIDI instrument map entry
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
 6.7.5.  Get current settings of MIDI instrument map entry  
4667    
4668     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
4669     instrument map entry by sending the following command:     instrument map entry by sending the following command:
4670    
4671        GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb>        GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
       <midi_prog>  
4672    
4673     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4674     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value,
4675     between 0..127 reflecting the MIDI bank LSB (fine) value and     <midi_bank> and <midi_prog> an integer value between 0..127
4676     <midi_prog> an integer value between 0..127 reflecting the MIDI     reflecting the MIDI program value of the map's entrie's key index
4677     program value of the map entrie's key index triple.     triple.
4678    
4679     Possible Answers:     Possible Answers:
4680    
# Line 3836  Internet-Draft        LinuxSampler Contr Line 4689  Internet-Draft        LinuxSampler Contr
4689           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4690           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4691           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4692           MIDI_INSTRUMENT" (Section 6.7.1) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4693           be unique.           be unique.
4694    
4695        "ENGINE_NAME" -        "ENGINE_NAME" -
4696    
4697           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck             Expires October 18, 2007               [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol           April 2007
4706    
4707    
4708        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4709    
4710           File name of the instrument.           File name of the instrument.
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4719  Internet-Draft        LinuxSampler Contr
4719           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4720           cannot be changed.           cannot be changed.
4721    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4722        "LOAD_MODE" -        "LOAD_MODE" -
4723    
4724           Life time of instrument (see "MAP MIDI_INSTRUMENT"           Life time of instrument (see "MAP MIDI_INSTRUMENT"
4725           (Section 6.7.1) for details about this setting).           (Section 6.7.7) for details about this setting).
4726    
4727        "VOLUME" -        "VOLUME" -
4728    
# Line 3880  Internet-Draft        LinuxSampler Contr Line 4734  Internet-Draft        LinuxSampler Contr
4734    
4735     Example:     Example:
4736    
4737        C: "GET MIDI_INSTRUMENT INFO 3 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4738    
4739        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
4740    
# Line 3898  Internet-Draft        LinuxSampler Contr Line 4752  Internet-Draft        LinuxSampler Contr
4752    
4753           "."           "."
4754    
 6.7.6.  Clear MIDI instrument map  
4755    
    The front-end can clear the whole MIDI instrument map, that is delete  
    all entries by sending the following command:  
4756    
4757        CLEAR MIDI_INSTRUMENTS  
4758    
4759    Schoenebeck             Expires October 18, 2007               [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol           April 2007
4762    
4763    
4764    6.7.12.  Clear MIDI instrument map
4765    
4766       The front-end can clear a whole MIDI instrument map, that is delete
4767       all its entries by sending the following command:
4768    
4769          CLEAR MIDI_INSTRUMENTS <map>
4770    
4771       Where <map> is the numeric ID of the map to clear.
4772    
4773       The front-end can clear all MIDI instrument maps, that is delete all
4774       entries of all maps by sending the following command:
4775    
4776          CLEAR MIDI_INSTRUMENTS ALL
4777    
4778       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4779       only their entries, thus the map's settings like custom name will be
4780       preservevd.
4781    
4782     Possible Answers:     Possible Answers:
4783    
# Line 3911  Internet-Draft        LinuxSampler Contr Line 4785  Internet-Draft        LinuxSampler Contr
4785    
4786           always           always
4787    
4788       Examples:
4789    
4790          C: "CLEAR MIDI_INSTRUMENTS 0"
4791    
4792          S: "OK"
4793    
4794          C: "CLEAR MIDI_INSTRUMENTS ALL"
4795    
4796          S: "OK"
4797    
4798    6.8.  Managing Instruments Database
4799    
4800       The following commands describe how to use and manage the instruments
4801       database.
4802    
4803    6.8.1.  Creating a new instrument directory
4804    
4805       The front-end can add a new instrument directory to the instruments
4806       database by sending the following command:
4807    
4808          ADD DB_INSTRUMENT_DIRECTORY <dir>
4809    
4810       Where <dir> is the absolute path name of the directory to be created
4811       (encapsulated into apostrophes).
4812    
4813    
4814    
4815    Schoenebeck             Expires October 18, 2007               [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol           April 2007
4818    
4819    
4820       Possible Answers:
4821    
4822          "OK" -
4823    
4824             on success
4825    
4826          "ERR:<error-code>:<error-message>" -
4827    
4828             when the directory could not be created, which can happen if
4829             the directory already exists or the name contains not allowed
4830             symbols
4831    
4832       Examples:
4833    
4834          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4835    
4836          S: "OK"
4837    
4838    6.8.2.  Deleting an instrument directory
4839    
4840       The front-end can delete a particular instrument directory from the
4841       instruments database by sending the following command:
4842    
4843          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4844    
4845       Where <dir> is the absolute path name of the directory to delete.
4846       The optional FORCE argument can be used to force the deletion of a
4847       non-empty directory and all its content.
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             if the directory is deleted successfully
4854    
4855          "ERR:<error-code>:<error-message>" -
4856    
4857             if the given directory does not exist, or if trying to delete a
4858             non-empty directory, without using the FORCE argument.
4859    
4860       Examples:
4861    
4862          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4863    
4864          S: "OK"
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck             Expires October 18, 2007               [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol           April 2007
4874    
4875    
4876    6.8.3.  Getting amount of instrument directories
4877    
4878       The front-end can retrieve the current amount of directories in a
4879       specific directory by sending the following command:
4880    
4881          GET DB_INSTRUMENT_DIRECTORIES <dir>
4882    
4883       Where <dir> should be replaced by the absolute path name of the
4884       directory.
4885    
4886       Possible Answers:
4887    
4888          The current number of instrument directories in the specified
4889          directory.
4890    
4891          "ERR:<error-code>:<error-message>" -
4892    
4893             if the given directory does not exist.
4894    
4895       Example:
4896    
4897          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4898    
4899          S: "2"
4900    
4901    6.8.4.  Listing all directories in specific directory
4902    
4903       The front-end can retrieve the current list of directories in
4904       specific directory by sending the following command:
4905    
4906          LIST DB_INSTRUMENT_DIRECTORIES <dir>
4907    
4908       Where <dir> should be replaced by the absolute path name of the
4909       directory.
4910    
4911       Possible Answers:
4912    
4913          A comma separated list of all instrument directories (encapsulated
4914          into apostrophes) in the specified directory.
4915    
4916          "ERR:<error-code>:<error-message>" -
4917    
4918             if the given directory does not exist.
4919    
4920       Example:
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck             Expires October 18, 2007               [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol           April 2007
4930    
4931    
4932          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4933    
4934          S: "'Piano Collection','Percussion Collection'"
4935    
4936    6.8.5.  Getting instrument directory information
4937    
4938       The front-end can ask for the current settings of an instrument
4939       directory by sending the following command:
4940    
4941          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4942    
4943       Where <dir> should be replaced by the absolute path name of the
4944       directory the front-end is interested in.
4945    
4946       Possible Answers:
4947    
4948          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4949          answer line begins with the settings category name followed by a
4950          colon and then a space character <SP> and finally the info
4951          character string to that setting category.  At the moment the
4952          following categories are defined:
4953    
4954    
4955    
4956             DESCRIPTION -
4957    
4958                A brief description of the directory content
4959    
4960             CREATED -
4961    
4962                The creation date and time of the directory, represented in
4963                "YYYY-MM-DD HH:MM:SS" format
4964    
4965             MODIFIED -
4966    
4967                The date and time of the last modification of the directory,
4968                represented in "YYYY-MM-DD HH:MM:SS" format
4969    
4970       The mentioned fields above don't have to be in particular order.
4971    
4972       Example:
4973    
4974          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
4975    
4976          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
4977          format."
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck             Expires October 18, 2007               [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol           April 2007
4986    
4987    
4988             "CREATED: 2007-02-05 10:23:12"
4989    
4990             "MODIFIED: 2007-04-07 12:50:21"
4991    
4992             "."
4993    
4994    6.8.6.  Renaming an instrument directory
4995    
4996       The front-end can alter the name of a specific instrument directory
4997       by sending the following command:
4998    
4999          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5000    
5001       Where <dir> is the absolute path name of the directory and <name> is
5002       the new name for that directory.
5003    
5004       Possible Answers:
5005    
5006          "OK" -
5007    
5008             on success
5009    
5010          "ERR:<error-code>:<error-message>" -
5011    
5012             in case the given directory does not exists, or if a directory
5013             with name equal to the new name already exists.
5014    
5015       Example:
5016    
5017          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5018          'Acoustic'"
5019    
5020          S: "OK"
5021    
5022    6.8.7.  Moving an instrument directory
5023    
5024       The front-end can move a specific instrument directory by sending the
5025       following command:
5026    
5027          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5028    
5029       Where <dir> is the absolute path name of the directory to move and
5030       <dst> is the location where the directory will be moved to.
5031    
5032       Possible Answers:
5033    
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck             Expires October 18, 2007               [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol           April 2007
5042    
5043    
5044          "OK" -
5045    
5046             on success
5047    
5048          "ERR:<error-code>:<error-message>" -
5049    
5050             in case a given directory does not exists, or if a directory
5051             with name equal to the name of the specified directory already
5052             exists in the destination directory.  Error is also thrown when
5053             trying to move a directory to a subdirectory of itself.
5054    
5055     Example:     Example:
5056    
5057          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5058          Acoustic'"
5059    
5060          S: "OK"
5061    
5062    6.8.8.  Changing the description of directory
5063    
5064       The front-end can alter the description of a specific instrument
5065       directory by sending the following command:
5066    
5067          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5068    
5069       Where <dir> is the absolute path name of the directory and <desc> is
5070       the new description for the directory.
5071    
5072       Possible Answers:
5073    
5074          "OK" -
5075    
5076             on success
5077    
5078          "ERR:<error-code>:<error-message>" -
5079    
5080             in case the given directory does not exists.
5081    
5082       Example:
5083    
5084          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5085          collection of piano instruments in various format.'"
5086    
5087          S: "OK"
5088    
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck             Expires October 18, 2007               [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol           April 2007
5098    
5099    
5100    6.8.9.  Adding instruments to the instruments database
5101    
5102       The front-end can add one or more instruments to the instruments
5103       database by sending the following command:
5104    
5105          ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]
5106    
5107       Where <db_dir> is the absolute path name of a directory (encapsulated
5108       into apostrophes) in the instruments database in which only the new
5109       instruments (that are not already in the database) will be added,
5110       <file_path> is the absolute path name of a file or directory in the
5111       file system (encapsulated into apostrophes).  In case an instrument
5112       file is supplied, only the instruments in the specified file will be
5113       added to the instruments database.  If the optional <instr_index>
5114       (the index of the instrument within the given file) is supplied too,
5115       then only the specified instrument will be added.  In case a
5116       directory is supplied, the instruments in that directory will be
5117       added.  The OPTIONAL <mode> argument is only applied when a directory
5118       is provided as <file_path> and specifies how the scanning will be
5119       done and has exactly the following possibilities:
5120    
5121          "NON_RECURSIVE" -
5122    
5123             Only the instruments in the specified directory will be added,
5124             the instruments in the subdirectories will not be processed.
5125    
5126          "FLAT" -
5127    
5128             All instruments will be processed, including those in the
5129             subdirectories, but the respective subdirectory structure will
5130             not be recreated in the instruments database.  All instruments
5131             will be added directly in the specified database directory.
5132    
5133  Schoenebeck               Expires May 30, 2007                 [Page 70]        not supplied -
5134    
5135             The subdirectory tree structure will be recreated in the
5136             instruments database and all instruments will be processed and
5137             added to the respective subdirectory in the instruments
5138             database.
5139    
5140       Possible Answers:
5141    
5142          "OK" -
5143    
5144             on success
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck             Expires October 18, 2007               [Page 92]
5152    
5153  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5154    
5155    
5156        C: "CLEAR MIDI_INSTRUMENTS"        "ERR:<error-code>:<error-message>" -
5157    
5158             if an invalid path is specified.
5159    
5160       Examples:
5161    
5162          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5163          Bosendorfer 290.gig' 0"
5164    
5165        S: "OK"        S: "OK"
5166    
5167    6.8.10.  Removing an instrument
5168    
5169       The front-end can remove a particular instrument from the instruments
5170       database by sending the following command:
5171    
5172          REMOVE DB_INSTRUMENT <instr_path>
5173    
5174       Where <instr_path> is the absolute path name (in the instruments
5175       database) of the instrument to remove.
5176    
5177       Possible Answers:
5178    
5179          "OK" -
5180    
5181             if the instrument is removed successfully
5182    
5183          "ERR:<error-code>:<error-message>" -
5184    
5185             if the given path does not exist or is a directory.
5186    
5187       Examples:
5188    
5189          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5190    
5191          S: "OK"
5192    
5193    6.8.11.  Getting amount of instruments
5194    
5195       The front-end can retrieve the current amount of instruments in a
5196       specific directory by sending the following command:
5197    
5198          GET DB_INSTRUMENTS <dir>
5199    
5200       Where <dir> should be replaced by the absolute path name of the
5201       directory.
5202    
5203       Possible Answers:
5204    
5205    
5206    
5207    Schoenebeck             Expires October 18, 2007               [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol           April 2007
5210    
5211    
5212          The current number of instruments in the specified directory.
5213    
5214          "ERR:<error-code>:<error-message>" -
5215    
5216             if the given directory does not exist.
5217    
5218       Example:
5219    
5220          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5221    
5222          S: "2"
5223    
5224    6.8.12.  Listing all instruments in specific directory
5225    
5226       The front-end can retrieve the current list of instruments in
5227       specific directory by sending the following command:
5228    
5229          LIST DB_INSTRUMENTS <dir>
5230    
5231       Where <dir> should be replaced by the absolute path name of the
5232       directory.
5233    
5234       Possible Answers:
5235    
5236          A comma separated list of all instruments (encapsulated into
5237          apostrophes) in the specified directory.
5238    
5239          "ERR:<error-code>:<error-message>" -
5240    
5241             if the given directory does not exist.
5242    
5243       Example:
5244    
5245          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5246    
5247          S: "'Bosendorfer 290','Steinway D'"
5248    
5249    6.8.13.  Getting instrument information
5250    
5251       The front-end can ask for the current settings of an instrument by
5252       sending the following command:
5253    
5254          GET DB_INSTRUMENT INFO <instr_path>
5255    
5256       Where <instr_path> should be replaced by the absolute path name of
5257       the instrument the front-end is interested in.
5258    
5259       Possible Answers:
5260    
5261    
5262    
5263    Schoenebeck             Expires October 18, 2007               [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol           April 2007
5266    
5267    
5268          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5269          answer line begins with the settings category name followed by a
5270          colon and then a space character <SP> and finally the info
5271          character string to that setting category.  At the moment the
5272          following categories are defined:
5273    
5274    
5275    
5276             INSTRUMENT_FILE -
5277    
5278                File name of the instrument.
5279    
5280             INSTRUMENT_NR -
5281    
5282                Index of the instrument within the file.
5283    
5284             FORMAT_FAMILY -
5285    
5286                The format family of the instrument.
5287    
5288             FORMAT_VERSION -
5289    
5290                The format version of the instrument.
5291    
5292             SIZE -
5293    
5294                The size of the instrument in bytes.
5295    
5296             CREATED -
5297    
5298                The date and time when the instrument is added in the
5299                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5300                format
5301    
5302             MODIFIED -
5303    
5304                The date and time of the last modification of the
5305                instrument's database settings, represented in "YYYY-MM-DD
5306                HH:MM:SS" format
5307    
5308             DESCRIPTION -
5309    
5310                A brief description of the instrument
5311    
5312             IS_DRUM -
5313    
5314                either true or false, determines whether the instrument is a
5315                drumkit or a chromatic instrument
5316    
5317    
5318    
5319    Schoenebeck             Expires October 18, 2007               [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol           April 2007
5322    
5323    
5324             PRODUCT -
5325    
5326                The product title of the instrument
5327    
5328             ARTISTS -
5329    
5330                Lists the artist names
5331    
5332             KEYWORDS -
5333    
5334                Provides a list of keywords that refer to the instrument.
5335                Keywords are separated with semicolon and blank.
5336    
5337       The mentioned fields above don't have to be in particular order.
5338    
5339       Example:
5340    
5341          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5342    
5343          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5344    
5345             "INSTRUMENT_NR: 0"
5346    
5347             "FORMAT_FAMILY: GIG"
5348    
5349             "FORMAT_VERSION: 2"
5350    
5351             "SIZE: 2050871870"
5352    
5353             "CREATED: 2007-02-05 10:23:12"
5354    
5355             "MODIFIED: 2007-04-07 12:50:21"
5356    
5357             "DESCRIPTION: "
5358    
5359             "IS_DRUM: false"
5360    
5361             "PRODUCT: GRANDIOSO Bosendorfer 290"
5362    
5363             "ARTISTS: Post Musical Instruments"
5364    
5365             "KEYWORDS: Bosendorfer"
5366    
5367             "."
5368    
5369    
5370    
# Line 3960  Internet-Draft        LinuxSampler Contr Line 5372  Internet-Draft        LinuxSampler Contr
5372    
5373    
5374    
5375    Schoenebeck             Expires October 18, 2007               [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol           April 2007
5378    
5379    
5380    6.8.14.  Renaming an instrument
5381    
5382       The front-end can alter the name of a specific instrument by sending
5383       the following command:
5384    
5385          SET DB_INSTRUMENT NAME <instr> <name>
5386    
5387       Where <instr> is the absolute path name of the instrument and <name>
5388       is the new name for that instrument.
5389    
5390       Possible Answers:
5391    
5392          "OK" -
5393    
5394             on success
5395    
5396          "ERR:<error-code>:<error-message>" -
5397    
5398             in case the given instrument does not exists, or if an
5399             instrument with name equal to the new name already exists.
5400    
5401       Example:
5402    
5403  Schoenebeck               Expires May 30, 2007                 [Page 71]        C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5404          'Bosendorfer 290'"
5405    
5406          S: "OK"
5407    
5408    6.8.15.  Moving an instrument
5409    
5410       The front-end can move a specific instrument to another directory by
5411       sending the following command:
5412    
5413          MOVE DB_INSTRUMENT <instr> <dst>
5414    
5415       Where <instr> is the absolute path name of the instrument to move and
5416       <dst> is the directory where the instrument will be moved to.
5417    
5418       Possible Answers:
5419    
5420          "OK" -
5421    
5422             on success
5423    
5424          "ERR:<error-code>:<error-message>" -
5425    
5426             in case the given instrument does not exists, or if an
5427             instrument with name equal to the name of the specified
5428    
5429    
5430    
5431    Schoenebeck             Expires October 18, 2007               [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5434    
5435    
5436             instrument already exists in the destination directory.
5437    
5438       Example:
5439    
5440          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5441          Collection/Acoustic'"
5442    
5443          S: "OK"
5444    
5445    6.8.16.  Changing the description of instrument
5446    
5447       The front-end can alter the description of a specific instrument by
5448       sending the following command:
5449    
5450          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5451    
5452       Where <instr> is the absolute path name of the instrument and <desc>
5453       is the new description for the instrument.
5454    
5455       Possible Answers:
5456    
5457          "OK" -
5458    
5459             on success
5460    
5461          "ERR:<error-code>:<error-message>" -
5462    
5463             in case the given instrument does not exists.
5464    
5465       Example:
5466    
5467          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5468          Bosendorfer 290' 'No comment :)'"
5469    
5470          S: "OK"
5471    
5472    
5473    
5474    
5475    
5476    
5477    
5478    
5479    
5480    
5481    
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires October 18, 2007               [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol           April 2007
5490    
5491    
5492  7.  Command Syntax  7.  Command Syntax
# Line 4013  Internet-Draft        LinuxSampler Contr Line 5525  Internet-Draft        LinuxSampler Contr
5525    
5526     command =     command =
5527    
5528        ADD SP CHANNEL        ADD SP add_instruction
5529    
5530        / MAP SP map_instruction        / MAP SP map_instruction
5531    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck               Expires May 30, 2007                 [Page 72]  Schoenebeck             Expires October 18, 2007               [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5546    
5547    
5548        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4045  Internet-Draft        LinuxSampler Contr Line 5557  Internet-Draft        LinuxSampler Contr
5557    
5558        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
5559    
       / SELECT SP text  
   
5560        / RESET SP reset_instruction        / RESET SP reset_instruction
5561    
5562        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
5563    
5564          / MOVE SP move_instruction
5565    
5566        / RESET        / RESET
5567    
5568        / QUIT        / QUIT
5569    
5570       add_instruction =
5571    
5572          CHANNEL
5573    
5574          / DB_INSTRUMENT_DIRECTORY SP pathname
5575    
5576          / DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5577    
5578          / DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5579    
5580          / DB_INSTRUMENTS SP pathname SP pathname
5581    
5582          / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5583    
5584          / MIDI_INSTRUMENT_MAP
5585    
5586          / MIDI_INSTRUMENT_MAP SP map_name
5587    
5588     subscribe_event =     subscribe_event =
5589    
5590        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
5591    
5592          / AUDIO_OUTPUT_DEVICE_INFO
5593    
5594          / MIDI_INPUT_DEVICE_COUNT
5595    
5596    
5597    
5598    
5599    Schoenebeck             Expires October 18, 2007              [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol           April 2007
5602    
5603    
5604          / MIDI_INPUT_DEVICE_INFO
5605    
5606          / CHANNEL_COUNT
5607    
5608        / VOICE_COUNT        / VOICE_COUNT
5609    
# Line 4067  Internet-Draft        LinuxSampler Contr Line 5613  Internet-Draft        LinuxSampler Contr
5613    
5614        / CHANNEL_INFO        / CHANNEL_INFO
5615    
5616          / FX_SEND_COUNT
5617    
5618          / FX_SEND_INFO
5619    
5620          / MIDI_INSTRUMENT_MAP_COUNT
5621    
5622          / MIDI_INSTRUMENT_MAP_INFO
5623    
5624          / MIDI_INSTRUMENT_COUNT
5625    
5626          / MIDI_INSTRUMENT_INFO
5627    
5628          / DB_INSTRUMENT_DIRECTORY_COUNT
5629    
5630          / DB_INSTRUMENT_DIRECTORY_INFO
5631    
5632          / DB_INSTRUMENT_COUNT
5633    
5634          / DB_INSTRUMENT_INFO
5635    
5636        / MISCELLANEOUS        / MISCELLANEOUS
5637    
5638        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
5639    
5640          / GLOBAL_INFO
5641    
5642     unsubscribe_event =     unsubscribe_event =
5643    
5644        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
5645    
5646          / AUDIO_OUTPUT_DEVICE_INFO
5647    
5648          / MIDI_INPUT_DEVICE_COUNT
5649    
5650          / MIDI_INPUT_DEVICE_INFO
5651    
5652    
5653    
5654    
5655    Schoenebeck             Expires October 18, 2007              [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol           April 2007
5658    
5659    
5660          / CHANNEL_COUNT
5661    
5662        / VOICE_COUNT        / VOICE_COUNT
5663    
# Line 4081  Internet-Draft        LinuxSampler Contr Line 5665  Internet-Draft        LinuxSampler Contr
5665    
5666        / BUFFER_FILL        / BUFFER_FILL
5667    
5668          / CHANNEL_INFO
5669    
5670          / FX_SEND_COUNT
5671    
5672          / FX_SEND_INFO
5673    
5674  Schoenebeck               Expires May 30, 2007                 [Page 73]        / MIDI_INSTRUMENT_MAP_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5675    
5676          / MIDI_INSTRUMENT_MAP_INFO
5677    
5678        / CHANNEL_INFO        / MIDI_INSTRUMENT_COUNT
5679    
5680          / MIDI_INSTRUMENT_INFO
5681    
5682          / DB_INSTRUMENT_DIRECTORY_COUNT
5683    
5684          / DB_INSTRUMENT_DIRECTORY_INFO
5685    
5686          / DB_INSTRUMENT_COUNT
5687    
5688          / DB_INSTRUMENT_INFO
5689    
5690        / MISCELLANEOUS        / MISCELLANEOUS
5691    
5692        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
5693    
5694          / GLOBAL_INFO
5695    
5696     map_instruction =     map_instruction =
5697    
5698        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
5699        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
5700    
5701        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5702        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5703        instr_load_mode        instr_load_mode
5704    
5705        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5706        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5707        entry_name        entry_name
5708    
5709        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog  
5710    
5711    Schoenebeck             Expires October 18, 2007              [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol           April 2007
5714    
5715    
5716          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5717        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5718        instr_load_mode SP entry_name        instr_load_mode SP entry_name
5719    
5720     unmap_instruction =     unmap_instruction =
5721    
5722        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
5723    
5724     remove_instruction =     remove_instruction =
5725    
5726        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
5727    
5728          / MIDI_INSTRUMENT_MAP SP midi_map
5729    
5730          / MIDI_INSTRUMENT_MAP SP ALL
5731    
5732          / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
5733    
5734          / DB_INSTRUMENT_DIRECTORY SP pathname
5735    
5736          / DB_INSTRUMENT SP pathname
5737    
5738     get_instruction =     get_instruction =
5739    
5740        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4137  Internet-Draft        LinuxSampler Contr Line 5752  Internet-Draft        LinuxSampler Contr
5752    
5753        / AUDIO_OUTPUT_DRIVER SP INFO SP string        / AUDIO_OUTPUT_DRIVER SP INFO SP string
5754    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5755        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
5756    
5757        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
# Line 4154  Internet-Draft        LinuxSampler Contr Line 5761  Internet-Draft        LinuxSampler Contr
5761    
5762        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
5763    
5764    
5765    
5766    
5767    Schoenebeck             Expires October 18, 2007              [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol           April 2007
5770    
5771    
5772        / AUDIO_OUTPUT_DEVICE SP INFO SP number        / AUDIO_OUTPUT_DEVICE SP INFO SP number
5773    
5774        / MIDI_INPUT_DEVICE SP INFO SP number        / MIDI_INPUT_DEVICE SP INFO SP number
# Line 4185  Internet-Draft        LinuxSampler Contr Line 5800  Internet-Draft        LinuxSampler Contr
5800    
5801        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
5802    
5803        / MIDI_INSTRUMENTS        / MIDI_INSTRUMENTS SP midi_map
5804    
5805        / MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP        / MIDI_INSTRUMENTS SP ALL
       midi_prog  
5806    
5807     set_instruction =        / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
5808    
5809          / MIDI_INSTRUMENT_MAPS
5810    
5811          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
5812    
5813          / FX_SENDS SP sampler_channel
5814    
5815          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
5816    
5817          / DB_INSTRUMENT_DIRECTORIES SP pathname
5818    
5819    
5820    
5821  Schoenebeck               Expires May 30, 2007                 [Page 75]  
5822    
5823    Schoenebeck             Expires October 18, 2007              [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5826    
5827    
5828          / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
5829    
5830          / DB_INSTRUMENTS SP pathname
5831    
5832          / DB_INSTRUMENT SP INFO SP pathname
5833    
5834          / VOLUME
5835    
5836       set_instruction =
5837    
5838        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
5839        param_val_list        param_val_list
# Line 4215  Internet-Draft        LinuxSampler Contr Line 5849  Internet-Draft        LinuxSampler Contr
5849    
5850        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
5851    
5852          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5853    
5854          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5855    
5856          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5857          SP audio_channel_index SP audio_channel_index
5858    
5859          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5860          midi_ctrl
5861    
5862          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5863          volume_value
5864    
5865          / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
5866    
5867          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
5868    
5869          / DB_INSTRUMENT SP NAME SP pathname SP dirname
5870    
5871          / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
5872    
5873        / ECHO SP boolean        / ECHO SP boolean
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires October 18, 2007              [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol           April 2007
5882    
5883    
5884          / VOLUME SP volume_value
5885    
5886     create_instruction =     create_instruction =
5887    
5888        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4227  Internet-Draft        LinuxSampler Contr Line 5893  Internet-Draft        LinuxSampler Contr
5893    
5894        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
5895    
5896          / FX_SEND SP sampler_channel SP midi_ctrl
5897    
5898          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5899    
5900     reset_instruction =     reset_instruction =
5901    
5902        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
5903    
5904     clear_instruction =     clear_instruction =
5905    
5906        MIDI_INSTRUMENTS        MIDI_INSTRUMENTS SP midi_map
5907    
5908          / MIDI_INSTRUMENTS SP ALL
5909    
5910       move_instruction =
5911    
5912          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
5913    
5914          / DB_INSTRUMENT SP pathname SP pathname
5915    
5916     destroy_instruction =     destroy_instruction =
5917    
# Line 4241  Internet-Draft        LinuxSampler Contr Line 5919  Internet-Draft        LinuxSampler Contr
5919    
5920        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
5921    
5922          / FX_SEND SP sampler_channel SP fx_send_id
5923    
5924     load_instruction =     load_instruction =
5925    
5926        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
# Line 4252  Internet-Draft        LinuxSampler Contr Line 5932  Internet-Draft        LinuxSampler Contr
5932    
5933    
5934    
5935  Schoenebeck               Expires May 30, 2007                 [Page 76]  Schoenebeck             Expires October 18, 2007              [Page 106]
5936    
5937  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
5938    
5939    
5940        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
# Line 4282  Internet-Draft        LinuxSampler Contr Line 5962  Internet-Draft        LinuxSampler Contr
5962    
5963        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
5964    
5965          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5966    
5967          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5968    
5969          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5970    
5971       modal_arg =
5972    
5973          /* epsilon (empty argument) */
5974    
5975          / NON_MODAL SP
5976    
5977     key_val_list =     key_val_list =
5978    
5979        string '=' param_val_list        string '=' param_val_list
# Line 4292  Internet-Draft        LinuxSampler Contr Line 5984  Internet-Draft        LinuxSampler Contr
5984    
5985        BYTES        BYTES
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck             Expires October 18, 2007              [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol           April 2007
5994    
5995    
5996        / PERCENTAGE        / PERCENTAGE
5997    
5998     list_instruction =     list_instruction =
# Line 4304  Internet-Draft        LinuxSampler Contr Line 6005  Internet-Draft        LinuxSampler Contr
6005    
6006        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
6007    
6008          / AVAILABLE_MIDI_INPUT_DRIVERS
6009    
6010          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6011    
6012          / MIDI_INSTRUMENTS SP midi_map
6013    
6014          / MIDI_INSTRUMENTS SP ALL
6015    
6016  Schoenebeck               Expires May 30, 2007                 [Page 77]        / MIDI_INSTRUMENT_MAPS
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
6017    
6018        / AVAILABLE_MIDI_INPUT_DRIVERS        / FX_SENDS SP sampler_channel
6019    
6020        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / DB_INSTRUMENT_DIRECTORIES SP pathname
6021    
6022        / MIDI_INSTRUMENTS        / DB_INSTRUMENTS SP pathname
6023    
6024     load_instr_args =     load_instr_args =
6025    
# Line 4339  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041    
6042     device_index =     device_index =
6043    
6044    
6045    
6046    
6047    Schoenebeck             Expires October 18, 2007              [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol           April 2007
6050    
6051    
6052        number        number
6053    
6054     audio_channel_index =     audio_channel_index =
# Line 4361  Internet-Draft        LinuxSampler Contr Line 6071  Internet-Draft        LinuxSampler Contr
6071    
6072     midi_input_type_name =     midi_input_type_name =
6073    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
6074        string        string
6075    
6076     midi_bank_msb =     midi_map =
6077    
6078        number        number
6079    
6080     midi_bank_lsb =     midi_bank =
6081    
6082        number        number
6083    
# Line 4383  Internet-Draft        LinuxSampler Contr Line 6085  Internet-Draft        LinuxSampler Contr
6085    
6086        number        number
6087    
6088       midi_ctrl =
6089    
6090          number
6091    
6092     volume_value =     volume_value =
6093    
6094        dotnum        dotnum
# Line 4391  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097    
6098     sampler_channel =     sampler_channel =
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires October 18, 2007              [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol           April 2007
6106    
6107    
6108        number        number
6109    
6110     instrument_index =     instrument_index =
6111    
6112        number        number
6113    
6114       fx_send_id =
6115    
6116          number
6117    
6118     engine_name =     engine_name =
6119    
6120        string        string
6121    
6122       pathname =
6123    
6124          stringval
6125    
6126       dirname =
6127    
6128          stringval
6129    
6130     filename =     filename =
6131    
6132        stringval        stringval
6133    
6134       map_name =
6135    
6136          stringval
6137    
6138     entry_name =     entry_name =
6139    
6140        stringval        stringval
6141    
6142       fx_send_name =
6143    
6144          stringval
6145    
6146     param_val_list =     param_val_list =
6147    
6148        param_val        param_val
# Line 4417  Internet-Draft        LinuxSampler Contr Line 6151  Internet-Draft        LinuxSampler Contr
6151    
6152     param_val =     param_val =
6153    
6154          string
6155    
6156    
6157    
6158    
6159  Schoenebeck               Expires May 30, 2007                 [Page 79]  Schoenebeck             Expires October 18, 2007              [Page 110]
6160    
6161  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6162    
6163    
       string  
   
6164        / stringval        / stringval
6165    
6166        / number        / number
# Line 4476  Internet-Draft        LinuxSampler Contr Line 6210  Internet-Draft        LinuxSampler Contr
6210    
6211    
6212    
6213  Schoenebeck               Expires May 30, 2007                 [Page 80]  
6214    
6215    Schoenebeck             Expires October 18, 2007              [Page 111]
6216    
6217  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6218    
6219    
6220  8.  Events  8.  Events
# Line 4486  Internet-Draft        LinuxSampler Contr Line 6222  Internet-Draft        LinuxSampler Contr
6222     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
6223     LinuxSampler.     LinuxSampler.
6224    
6225  8.1.  Number of sampler channels changed  8.1.  Number of audio output devices changed
6226    
6227       Client may want to be notified when the total number of audio output
6228       devices on the back-end changes by issuing the following command:
6229    
6230          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
6231    
6232       Server will start sending the following notification messages:
6233    
6234          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
6235    
6236       where <devices> will be replaced by the new number of audio output
6237       devices.
6238    
6239    8.2.  Audio output device's settings changed
6240    
6241       Client may want to be notified when changes were made to audio output
6242       devices on the back-end by issuing the following command:
6243    
6244          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
6245    
6246       Server will start sending the following notification messages:
6247    
6248          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
6249    
6250       where <device-id> will be replaced by the numerical ID of the audio
6251       output device, which settings has been changed.  The front-end will
6252       have to send the respective command to actually get the audio output
6253       device info.  Because these messages will be triggered by LSCP
6254       commands issued by other clients rather than real time events
6255       happening on the server, it is believed that an empty notification
6256       message is sufficient here.
6257    
6258    8.3.  Number of MIDI input devices changed
6259    
6260       Client may want to be notified when the total number of MIDI input
6261       devices on the back-end changes by issuing the following command:
6262    
6263          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
6264    
6265       Server will start sending the following notification messages:
6266    
6267    
6268    
6269    
6270    
6271    Schoenebeck             Expires October 18, 2007              [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol           April 2007
6274    
6275    
6276          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
6277    
6278       where <devices> will be replaced by the new number of MIDI input
6279       devices.
6280    
6281    8.4.  MIDI input device's settings changed
6282    
6283       Client may want to be notified when changes were made to MIDI input
6284       devices on the back-end by issuing the following command:
6285    
6286          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
6287    
6288       Server will start sending the following notification messages:
6289    
6290          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
6291    
6292       where <device-id> will be replaced by the numerical ID of the MIDI
6293       input device, which settings has been changed.  The front-end will
6294       have to send the respective command to actually get the MIDI input
6295       device info.  Because these messages will be triggered by LSCP
6296       commands issued by other clients rather than real time events
6297       happening on the server, it is believed that an empty notification
6298       message is sufficient here.
6299    
6300    8.5.  Number of sampler channels changed
6301    
6302     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
6303     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 4500  Internet-Draft        LinuxSampler Contr Line 6311  Internet-Draft        LinuxSampler Contr
6311     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
6312     channels.     channels.
6313    
6314  8.2.  Number of active voices changed  8.6.  Number of active voices changed
6315    
6316     Client may want to be notified when the number of voices on the back-     Client may want to be notified when the number of voices on the back-
6317     end changes by issuing the following command:     end changes by issuing the following command:
# Line 4509  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6322    
6323        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
6324    
6325    
6326    
6327    Schoenebeck             Expires October 18, 2007              [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol           April 2007
6330    
6331    
6332          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
6333    
6334     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6335     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
6336     voices on that channel.     voices on that channel.
6337    
6338  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
6339    
6340     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
6341     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 4529  Internet-Draft        LinuxSampler Contr Line 6349  Internet-Draft        LinuxSampler Contr
6349    
6350     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6351     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
6352     active disk streams on that channel.     active disk streams on that channel.
6353    
6354  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
6355    
6356     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
6357     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 4556  Internet-Draft        LinuxSampler Contr Line 6368  Internet-Draft        LinuxSampler Contr
6368     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
6369     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
6370    
6371  8.5.  Channel information changed  8.9.  Channel information changed
6372    
6373     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
6374     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4565  Internet-Draft        LinuxSampler Contr Line 6377  Internet-Draft        LinuxSampler Contr
6377    
6378     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6379    
6380    
6381    
6382    
6383    Schoenebeck             Expires October 18, 2007              [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol           April 2007
6386    
6387    
6388        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
6389    
6390     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4574  Internet-Draft        LinuxSampler Contr Line 6394  Internet-Draft        LinuxSampler Contr
6394     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
6395     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
6396    
6397  8.6.  Total number of active voices changed  8.10.  Number of effect sends changed
6398    
6399       Client may want to be notified when the number of effect sends on a
6400       particular sampler channel is changed by issuing the following
6401       command:
6402    
6403          SUBSCRIBE FX_SEND_COUNT
6404    
6405       Server will start sending the following notification messages:
6406    
6407          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
6408    
6409       where <channel-id> will be replaced by the numerical ID of the
6410       sampler channel, on which the effect sends number is changed and <fx-
6411       sends> will be replaced by the new number of effect sends on that
6412       channel.
6413    
6414    8.11.  Effect send information changed
6415    
6416       Client may want to be notified when changes were made to effect sends
6417       on a a particular sampler channel by issuing the following command:
6418    
6419          SUBSCRIBE FX_SEND_INFO
6420    
6421       Server will start sending the following notification messages:
6422    
6423          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
6424    
6425       where <channel-id> will be replaced by the numerical ID of the
6426       sampler channel, on which an effect send entity is changed and <fx-
6427       send-id> will be replaced by the numerical ID of the changed effect
6428       send.
6429    
6430    8.12.  Total number of active voices changed
6431    
6432     Client may want to be notified when the total number of voices on the     Client may want to be notified when the total number of voices on the
6433     back-end changes by issuing the following command:     back-end changes by issuing the following command:
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires October 18, 2007              [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol           April 2007
6442    
6443    
6444        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
6445    
6446     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6447    
6448          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
6449    
6450       where <voices> will be replaced by the new number of all currently
6451       active voices.
6452    
6453    8.13.  Number of MIDI instrument maps changed
6454    
6455       Client may want to be notified when the number of MIDI instrument
6456       maps on the back-end changes by issuing the following command:
6457    
6458          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
6459    
6460       Server will start sending the following notification messages:
6461    
6462          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
6463    
6464       where <maps> will be replaced by the new number of MIDI instrument
6465       maps.
6466    
6467    8.14.  MIDI instrument map information changed
6468    
6469       Client may want to be notified when changes were made to MIDI
6470       instrument maps on the back-end by issuing the following command:
6471    
6472          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
6473    
6474  Schoenebeck               Expires May 30, 2007                 [Page 82]     Server will start sending the following notification messages:
6475    
6476          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
6477    
6478       where <map-id> will be replaced by the numerical ID of the MIDI
6479       instrument map, for which information changes occurred.  The front-
6480       end will have to send the respective command to actually get the MIDI
6481       instrument map info.  Because these messages will be triggered by
6482       LSCP commands issued by other clients rather than real time events
6483       happening on the server, it is believed that an empty notification
6484       message is sufficient here.
6485    
6486    8.15.  Number of MIDI instruments changed
6487    
6488       Client may want to be notified when the number of MIDI instrument
6489       maps on the back-end changes by issuing the following command:
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires October 18, 2007              [Page 116]
6496    
6497  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6498    
6499    
6500        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        SUBSCRIBE MIDI_INSTRUMENT_COUNT
6501    
6502     where <voices> will be replaced by the new number of all currently     Server will start sending the following notification messages:
6503     active voices.  
6504          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
6505    
6506  8.7.  Miscellaneous and debugging events     where <map-id> is the numerical ID of the MIDI instrument map, in
6507       which the nuber of instruments has changed and <instruments> will be
6508       replaced by the new number of MIDI instruments in the specified map.
6509    
6510    8.16.  MIDI instrument information changed
6511    
6512       Client may want to be notified when changes were made to MIDI
6513       instruments on the back-end by issuing the following command:
6514    
6515          SUBSCRIBE MIDI_INSTRUMENT_INFO
6516    
6517       Server will start sending the following notification messages:
6518    
6519          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
6520    
6521       where <map-id> will be replaced by the numerical ID of the MIDI
6522       instrument map, in which a MIDI instrument is changed. <bank> and
6523       <program> specifies the location of the changed MIDI instrument in
6524       the map.  The front-end will have to send the respective command to
6525       actually get the MIDI instrument info.  Because these messages will
6526       be triggered by LSCP commands issued by other clients rather than
6527       real time events happening on the server, it is believed that an
6528       empty notification message is sufficient here.
6529    
6530    8.17.  Global settings changed
6531    
6532       Client may want to be notified when changes to the global settings of
6533       the sampler were made by issuing the following command:
6534    
6535          SUBSCRIBE GLOBAL_INFO
6536    
6537       Server will start sending the following types of notification
6538       messages:
6539    
6540          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
6541          volume of the sampler is changed, where <volume> will be replaced
6542          by the optional dotted floating point value, reflecting the new
6543          global volume parameter.
6544    
6545    
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck             Expires October 18, 2007              [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol           April 2007
6554    
6555    
6556    8.18.  Number of database instrument directories changed
6557    
6558       Client may want to be notified when the number of instrument
6559       directories in a particular directory in the instruments database is
6560       changed by issuing the following command:
6561    
6562          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
6563    
6564       Server will start sending the following notification messages:
6565    
6566          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
6567    
6568       where <dir-path> will be replaced by the absolute path name of the
6569       directory in the instruments database, in which the number of
6570       directories is changed.
6571    
6572       Note that when a non-empty directory is removed, this event is not
6573       sent for the subdirectories in that directory.
6574    
6575    8.19.  Database instrument directory information changed
6576    
6577       Client may want to be notified when changes were made to directories
6578       in the instruments database by issuing the following command:
6579    
6580          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
6581    
6582       Server will start sending the following notification messages:
6583    
6584          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
6585    
6586       where <dir-path> will be replaced by the absolute path name of the
6587       directory, for which information changes occurred.  The front-end
6588       will have to send the respective command to actually get the updated
6589       directory info.  Because these messages will be triggered by LSCP
6590       commands issued by other clients rather than real time events
6591       happening on the server, it is believed that an empty notification
6592       message is sufficient here.
6593    
6594          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
6595          name>"
6596    
6597       where <old-dir-path> is the old absolute path name of the directory
6598       (encapsulated into apostrophes), which name is changes and <new-name>
6599       is the new name of the directory, encapsulated into apostrophes.
6600    
6601    
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck             Expires October 18, 2007              [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol           April 2007
6610    
6611    
6612    8.20.  Number of database instruments changed
6613    
6614       Client may want to be notified when the number of instruments in a
6615       particular directory in the instruments database is changed by
6616       issuing the following command:
6617    
6618          SUBSCRIBE DB_INSTRUMENT_COUNT
6619    
6620       Server will start sending the following notification messages:
6621    
6622          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
6623    
6624       where <dir-path> will be replaced by the absolute path name of the
6625       directory in the instruments database, in which the number of
6626       instruments is changed.
6627    
6628       Note that when a non-empty directory is removed, this event is not
6629       sent for the instruments in that directory.
6630    
6631    8.21.  Database instrument information changed
6632    
6633       Client may want to be notified when changes were made to instruments
6634       in the instruments database by issuing the following command:
6635    
6636          SUBSCRIBE DB_INSTRUMENT_INFO
6637    
6638       Server will start sending the following notification messages:
6639    
6640          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
6641    
6642       where <instr-path> will be replaced by the absolute path name of the
6643       instrument, which settings are changed.  The front-end will have to
6644       send the respective command to actually get the updated directory
6645       info.  Because these messages will be triggered by LSCP commands
6646       issued by other clients rather than real time events happening on the
6647       server, it is believed that an empty notification message is
6648       sufficient here.
6649    
6650          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
6651    
6652       where <old-instr-path> is the old absolute path name of the
6653       instrument (encapsulated into apostrophes), which name is changes and
6654       <new-name> is the new name of the instrument, encapsulated into
6655       apostrophes.
6656    
6657    
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck             Expires October 18, 2007              [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol           April 2007
6666    
6667    
6668    8.22.  Miscellaneous and debugging events
6669    
6670     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
6671     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 4644  Internet-Draft        LinuxSampler Contr Line 6711  Internet-Draft        LinuxSampler Contr
6711    
6712    
6713    
6714  Schoenebeck               Expires May 30, 2007                 [Page 83]  
6715    
6716    
6717    
6718    
6719    Schoenebeck             Expires October 18, 2007              [Page 120]
6720    
6721  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6722    
6723    
6724  9.  Security Considerations  9.  Security Considerations
# Line 4700  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775  Schoenebeck               Expires May 30, 2007                 [Page 84]  Schoenebeck             Expires October 18, 2007              [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6778    
6779    
6780  10.  Acknowledgments  10.  Acknowledgments
# Line 4720  Internet-Draft        LinuxSampler Contr Line 6792  Internet-Draft        LinuxSampler Contr
6792        Grigor Iliev        Grigor Iliev
6793    
6794    
 11.  References  
6795    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", RFC 2119, 1997.  
6796    
    [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax  
               Specifications", RFC 2234, 1997.  
6797    
    [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION  
               CONTROL PROTOCOL", RFC 793, 1981.  
6798    
6799    
6800    
# Line 4756  Internet-Draft        LinuxSampler Contr Line 6821  Internet-Draft        LinuxSampler Contr
6821    
6822    
6823    
6824  Schoenebeck               Expires May 30, 2007                 [Page 85]  
6825    
6826    
6827    
6828    
6829    
6830    
6831    Schoenebeck             Expires October 18, 2007              [Page 122]
6832    
6833  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6834    
6835    
6836  Author's Address  11.  References
6837    
6838     C. Schoenebeck     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
6839     Interessengemeinschaft Software Engineering e. V.                Requirement Levels", RFC 2119, 1997.
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
6840    
6841     Email: schoenebeck at software minus engineering dot org     [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
6842                  Specifications", RFC 2234, 1997.
6843    
6844       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
6845                  CONTROL PROTOCOL", RFC 793, 1981.
6846    
6847    
6848    
# Line 4812  Author's Address Line 6884  Author's Address
6884    
6885    
6886    
6887  Schoenebeck               Expires May 30, 2007                 [Page 86]  Schoenebeck             Expires October 18, 2007              [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           April 2007
6890    
6891    
6892  Intellectual Property Statement  Author's Address
6893    
6894     The IETF takes no position regarding the validity or scope of any     C. Schoenebeck
6895     intellectual property or other rights that might be claimed to     Interessengemeinschaft Software Engineering e. V.
6896     pertain to the implementation or use of the technology described in     Max-Planck-Str. 39
6897     this document or the extent to which any license under such rights     74081 Heilbronn
6898     might or might not be available; neither does it represent that it     Germany
    has made any effort to identify any such rights.  Information on the  
    IETF's procedures with respect to rights in standards-track and  
    standards-related documentation can be found in BCP 11.  Copies of  
    claims of rights made available for publication and any assurances of  
    licenses to be made available, or the result of an attempt made to  
    obtain a general license or permission for the use of such  
    proprietary rights by implementors or users of this specification can  
    be obtained from the IETF Secretariat.  
6899    
6900     The IETF invites any interested party to bring to its attention any     Email: schoenebeck at software minus engineering dot org
    copyrights, patents or patent applications, or other proprietary  
    rights which may cover technology that may be required to practice  
    this standard.  Please address the information to the IETF Executive  
    Director.  
6901    
6902    
 Full Copyright Statement  
6903    
    Copyright (C) The Internet Society (2006).  All Rights Reserved.  
6904    
    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.  
6905    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
6906    
    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  
6907    
6908    
6909    
 Schoenebeck               Expires May 30, 2007                 [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
6910    
6911    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
6912    
6913    
 Acknowledgment  
6914    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
6915    
6916    
6917    
# Line 4909  Acknowledgment Line 6940  Acknowledgment
6940    
6941    
6942    
6943    Schoenebeck             Expires October 18, 2007              [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol           April 2007
6946    
6947    
6948    Full Copyright Statement
6949    
6950       Copyright (C) The IETF Trust (2007).
6951    
6952       This document is subject to the rights, licenses and restrictions
6953       contained in BCP 78, and except as set forth therein, the authors
6954       retain all their rights.
6955    
6956       This document and the information contained herein are provided on an
6957       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
6958       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
6959       THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
6960       OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
6961       THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
6962       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
6963    
6964    
6965    Intellectual Property
6966    
6967       The IETF takes no position regarding the validity or scope of any
6968       Intellectual Property Rights or other rights that might be claimed to
6969       pertain to the implementation or use of the technology described in
6970       this document or the extent to which any license under such rights
6971       might or might not be available; nor does it represent that it has
6972       made any independent effort to identify any such rights.  Information
6973       on the procedures with respect to rights in RFC documents can be
6974       found in BCP 78 and BCP 79.
6975    
6976       Copies of IPR disclosures made to the IETF Secretariat and any
6977       assurances of licenses to be made available, or the result of an
6978       attempt made to obtain a general license or permission for the use of
6979       such proprietary rights by implementers or users of this
6980       specification can be obtained from the IETF on-line IPR repository at
6981       http://www.ietf.org/ipr.
6982    
6983       The IETF invites any interested party to bring to its attention any
6984       copyrights, patents or patent applications, or other proprietary
6985       rights that may cover technology that may be required to implement
6986       this standard.  Please address the information to the IETF at
6987       ietf-ipr@ietf.org.
6988    
6989    
6990    Acknowledgment
6991    
6992       Funding for the RFC Editor function is provided by the IETF
6993       Administrative Support Activity (IASA).
6994    
6995    
6996    
6997    
6998    
6999  Schoenebeck               Expires May 30, 2007                 [Page 88]  Schoenebeck             Expires October 18, 2007              [Page 125]
7000    
Legend:
Removed from v.945  
changed lines
  Added in v.1162
  ViewVC Help
Powered by ViewVC