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

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

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

revision 1006 by schoenebeck, Fri Dec 29 20:27:15 2006 UTC revision 1801 by schoenebeck, Sun Dec 7 01:31:29 2008 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: July 2, 2007                                  December 29, 2006  Expires: June 9, 2009                                   December 6, 2008
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  LSCP 1.4
12    
13  Status of this Memo  Status of this Memo
14    
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on July 2, 2007.     This Internet-Draft will expire on June 9, 2009.
37    
 Copyright Notice  
38    
    Copyright (C) The Internet Society (2006).  
39    
40    
41    
# Line 52  Copyright Notice Line 50  Copyright Notice
50    
51    
52    
53  Schoenebeck               Expires July 2, 2007                  [Page 1]  
54    
55    Schoenebeck               Expires June 9, 2009                  [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
58    
59    
60  Abstract  Abstract
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72     2.  Versioning of this specification  . . . . . . . . . . . . . .   6     2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76       5.1.  Request/response communication method . . . . . . . . . .   9       5.1.  Request/response communication method . . . . . . . . . .  10
77         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78       5.2.  Subscribe/notify communication method . . . . . . . . . .  12       5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79     6.  Description for control commands  . . . . . . . . . . . . . .  14     6.  Description for control commands  . . . . . . . . . . . . . .  15
80       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82         6.2.1.  Getting amount of available audio output drivers  . .  15         6.2.1.  Getting amount of available audio output drivers  . .  16
83         6.2.2.  Getting all available audio output drivers  . . . . .  15         6.2.2.  Getting all available audio output drivers  . . . . .  16
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver  . . . . . . . . . . . . . . . . . . . . . . .  15                 driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter  . . . . . . . . . . . . . . . . . .  16                 driver parameter  . . . . . . . . . . . . . . . . . .  17
88         6.2.5.  Creating an audio output device . . . . . . . . . . .  20         6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89         6.2.6.  Destroying an audio output device . . . . . . . . . .  21         6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90         6.2.7.  Getting all created audio output device count . . . .  22         6.2.7.  Getting all created audio output device count . . . .  23
91         6.2.8.  Getting all created audio output device list  . . . .  22         6.2.8.  Getting all created audio output device list  . . . .  23
92         6.2.9.  Getting current settings of an audio output device  .  22         6.2.9.  Getting current settings of an audio output device  .  23
93         6.2.10. Changing settings of audio output devices . . . . . .  24         6.2.10. Changing settings of audio output devices . . . . . .  25
94         6.2.11. Getting information about an audio channel  . . . . .  25         6.2.11. Getting information about an audio channel  . . . . .  26
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter . . . . . . . . . . . . . . . . . . . . . .  26                 parameter . . . . . . . . . . . . . . . . . . . . . .  27
97         6.2.13. Changing settings of audio output channels  . . . . .  28         6.2.13. Changing settings of audio output channels  . . . . .  29
98       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99         6.3.1.  Getting amount of available MIDI input drivers  . . .  30         6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver  . . . . . . . . . . . . . . . . . . . . . . .  31                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter  . . . . . . . . . . . . . . . . . .  32                 driver parameter  . . . . . . . . . . . . . . . . . .  33
105         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107         6.3.7.  Getting all created MIDI input device count . . . . .  36         6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111  Schoenebeck               Expires July 2, 2007                  [Page 2]  Schoenebeck               Expires June 9, 2009                  [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  36         6.3.8.  Getting all created MIDI input device list  . . . . .  37
117         6.3.9.  Getting current settings of a MIDI input device . . .  37         6.3.9.  Getting current settings of a MIDI input device . . .  38
118         6.3.10. Changing settings of MIDI input devices . . . . . . .  38         6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119         6.3.11. Getting information about a MIDI port . . . . . . . .  38         6.3.11. Getting information about a MIDI port . . . . . . . .  39
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
121                 parameter . . . . . . . . . . . . . . . . . . . . . .  39                 parameter . . . . . . . . . . . . . . . . . . . . . .  40
122         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  44         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  44         6.4.4.  Getting all created sampler channel list  . . . . . .  46
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  46         6.4.7.  Getting amount of available engines . . . . . . . . .  48
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  46         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  47         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  48         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  51         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  51         6.4.12. Current number of active disk streams . . . . . . . .  53
136         6.4.13. Current fill state of disk stream buffers . . . . . .  52         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  53         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  61
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  60                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  61         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  62         6.4.26. Removing an effect send from a sampler channel  . . .  64
151         6.4.27. Getting amount of effect sends on a sampler channel .  63         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  63         6.4.28. Listing all effect sends on a sampler channel . . . .  65
153         6.4.29. Getting effect send information . . . . . . . . . . .  64         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Altering effect send's audio routing  . . . . . . . .  65         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67
155         6.4.31. Resetting a sampler channel . . . . . . . . . . . . .  66         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  66         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.5.1.  Register front-end for receiving event messages . . .  66         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158           6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70
159           6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71
160         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  72
161           6.5.1.  Register front-end for receiving event messages . . .  72
162         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
163                 messages  . . . . . . . . . . . . . . . . . . . . . .  67                 messages  . . . . . . . . . . . . . . . . . . . . . .  72
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  68  
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  68  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  69  
        6.6.1.  Current number of active voices . . . . . . . . . . .  69  
   
   
   
 Schoenebeck               Expires July 2, 2007                  [Page 3]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
        6.6.2.  Maximum amount of active voices . . . . . . . . . . .  69  
        6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  69  
        6.6.4.  General sampler informations  . . . . . . . . . . . .  70  
        6.6.5.  Getting global volume attenuation . . . . . . . . . .  70  
        6.6.6.  Setting global volume attenuation . . . . . . . . . .  71  
      6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  71  
        6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  72  
        6.7.2.  Delete one particular or all MIDI instrument maps . .  73  
        6.7.3.  Get amount of existing MIDI instrument maps . . . . .  73  
        6.7.4.  Getting all created MIDI instrument maps  . . . . . .  74  
        6.7.5.  Getting MIDI instrument map information . . . . . . .  74  
        6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  75  
        6.7.7.  Create or replace a MIDI instrument map entry . . . .  75  
        6.7.8.  Getting ammount of MIDI instrument map entries  . . .  78  
        6.7.9.  Getting indeces of all entries of a MIDI  
                instrument map  . . . . . . . . . . . . . . . . . . .  79  
        6.7.10. Remove an entry from the MIDI instrument map  . . . .  79  
        6.7.11. Get current settings of MIDI instrument map entry . .  80  
        6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  82  
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  83  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  94  
      8.1.  Number of audio output devices changed  . . . . . . . . .  94  
      8.2.  Audio output device's settings changed  . . . . . . . . .  94  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . .  94  
      8.4.  MIDI input device's settings changed  . . . . . . . . . .  95  
      8.5.  Number of sampler channels changed  . . . . . . . . . . .  95  
      8.6.  Number of active voices changed . . . . . . . . . . . . .  95  
      8.7.  Number of active disk streams changed . . . . . . . . . .  96  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . .  96  
      8.9.  Channel information changed . . . . . . . . . . . . . . .  96  
      8.10. Total number of active voices changed . . . . . . . . . .  97  
      8.11. Number of MIDI instrument maps changed  . . . . . . . . .  97  
      8.12. MIDI instrument map information changed . . . . . . . . .  97  
      8.13. Number of MIDI instruments changed  . . . . . . . . . . .  98  
      8.14. MIDI instrument information changed . . . . . . . . . . .  98  
      8.15. Miscellaneous and debugging events  . . . . . . . . . . .  99  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 100  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 101  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 102  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 103  
    Intellectual Property and Copyright Statements  . . . . . . . . . 104  
   
164    
165    
166    
167    Schoenebeck               Expires June 9, 2009                  [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol        December 2008
170    
171    
172           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73
173           6.5.4.  Close client connection . . . . . . . . . . . . . . .  74
174         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  74
175           6.6.1.  Current number of active voices . . . . . . . . . . .  74
176           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  74
177           6.6.3.  Current number of active disk streams . . . . . . . .  74
178           6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  75
179           6.6.5.  General sampler informations  . . . . . . . . . . . .  75
180           6.6.6.  Getting global volume attenuation . . . . . . . . . .  76
181           6.6.7.  Setting global volume attenuation . . . . . . . . . .  76
182           6.6.8.  Getting global voice limit  . . . . . . . . . . . . .  77
183           6.6.9.  Setting global voice limit  . . . . . . . . . . . . .  77
184           6.6.10. Getting global disk stream limit  . . . . . . . . . .  78
185           6.6.11. Setting global disk stream limit  . . . . . . . . . .  78
186         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  79
187           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  80
188           6.7.2.  Delete one particular or all MIDI instrument maps . .  81
189           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  81
190           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  82
191           6.7.5.  Getting MIDI instrument map information . . . . . . .  82
192           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  83
193           6.7.7.  Create or replace a MIDI instrument map entry . . . .  84
194           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  86
195           6.7.9.  Getting indeces of all entries of a MIDI
196                   instrument map  . . . . . . . . . . . . . . . . . . .  87
197           6.7.10. Remove an entry from the MIDI instrument map  . . . .  88
198           6.7.11. Get current settings of MIDI instrument map entry . .  88
199           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  90
200         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  91
201           6.8.1.  Creating a new instrument directory . . . . . . . . .  91
202           6.8.2.  Deleting an instrument directory  . . . . . . . . . .  92
203           6.8.3.  Getting amount of instrument directories  . . . . . .  92
204           6.8.4.  Listing all directories in specific directory . . . .  93
205           6.8.5.  Getting instrument directory information  . . . . . .  94
206           6.8.6.  Renaming an instrument directory  . . . . . . . . . .  95
207           6.8.7.  Moving an instrument directory  . . . . . . . . . . .  95
208           6.8.8.  Copying instrument directories  . . . . . . . . . . .  96
209           6.8.9.  Changing the description of directory . . . . . . . .  97
210           6.8.10. Finding directories . . . . . . . . . . . . . . . . .  97
211           6.8.11. Adding instruments to the instruments database  . . .  99
212           6.8.12. Removing an instrument  . . . . . . . . . . . . . . . 100
213           6.8.13. Getting amount of instruments . . . . . . . . . . . . 101
214           6.8.14. Listing all instruments in specific directory . . . . 101
215           6.8.15. Getting instrument information  . . . . . . . . . . . 102
216           6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 104
217           6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 105
218           6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 106
219           6.8.19. Changing the description of instrument  . . . . . . . 106
220    
221    
222    
223    Schoenebeck               Expires June 9, 2009                  [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol        December 2008
226    
227    
228           6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 107
229           6.8.21. Getting job status information  . . . . . . . . . . . 109
230           6.8.22. Formatting the instruments database . . . . . . . . . 110
231           6.8.23. Checking for lost instrument files  . . . . . . . . . 111
232           6.8.24. Replacing an instrument file  . . . . . . . . . . . . 111
233         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 112
234           6.9.1.  Opening an appropriate instrument editor
235                   application . . . . . . . . . . . . . . . . . . . . . 112
236         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 113
237           6.10.1. Retrieving amount of instruments of a file  . . . . . 113
238           6.10.2. Retrieving all instruments of a file  . . . . . . . . 114
239           6.10.3. Retrieving informations about one instrument in a
240                   file  . . . . . . . . . . . . . . . . . . . . . . . . 114
241       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 117
242         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 131
243       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
244         8.1.  Number of audio output devices changed  . . . . . . . . . 136
245         8.2.  Audio output device's settings changed  . . . . . . . . . 136
246         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 136
247         8.4.  MIDI input device's settings changed  . . . . . . . . . . 137
248         8.5.  Number of sampler channels changed  . . . . . . . . . . . 137
249         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 137
250         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 138
251         8.8.  Number of active voices changed . . . . . . . . . . . . . 138
252         8.9.  Number of active disk streams changed . . . . . . . . . . 139
253         8.10. Disk stream buffer fill state changed . . . . . . . . . . 139
254         8.11. Channel information changed . . . . . . . . . . . . . . . 139
255         8.12. Number of effect sends changed  . . . . . . . . . . . . . 140
256         8.13. Effect send information changed . . . . . . . . . . . . . 140
257         8.14. Total number of active voices changed . . . . . . . . . . 141
258         8.15. Total number of active disk streams changed . . . . . . . 141
259         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 141
260         8.17. MIDI instrument map information changed . . . . . . . . . 141
261         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 142
262         8.19. MIDI instrument information changed . . . . . . . . . . . 142
263         8.20. Global settings changed . . . . . . . . . . . . . . . . . 143
264         8.21. Number of database instrument directories changed . . . . 143
265         8.22. Database instrument directory information changed . . . . 143
266         8.23. Number of database instruments changed  . . . . . . . . . 144
267         8.24. Database instrument information changed . . . . . . . . . 144
268         8.25. Database job status information changed . . . . . . . . . 145
269         8.26. Miscellaneous and debugging events  . . . . . . . . . . . 145
270       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 147
271       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 148
272       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 149
273       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 150
274       Intellectual Property and Copyright Statements  . . . . . . . . . 151
275    
276    
277    
278    
279  Schoenebeck               Expires July 2, 2007                  [Page 4]  Schoenebeck               Expires June 9, 2009                  [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 238  Internet-Draft        LinuxSampler Contr Line 294  Internet-Draft        LinuxSampler Contr
294     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
295     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
296     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
297     standard), thus the following example:     standard [RFC20]), thus the following example:
298    
299        C: "some line"        C: "some line"
300    
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires July 2, 2007                  [Page 5]  Schoenebeck               Expires June 9, 2009                  [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 307  Internet-Draft        LinuxSampler Contr Line 363  Internet-Draft        LinuxSampler Contr
363         sampler's LSCP minor version.         sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
366     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
367     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
368    
369    
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires July 2, 2007                  [Page 6]  Schoenebeck               Expires June 9, 2009                  [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
394    
395    
396  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires July 2, 2007                  [Page 7]  Schoenebeck               Expires June 9, 2009                  [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires July 2, 2007                  [Page 8]  Schoenebeck               Expires June 9, 2009                  [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires July 2, 2007                  [Page 9]  Schoenebeck               Expires June 9, 2009                 [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires July 2, 2007                 [Page 10]  Schoenebeck               Expires June 9, 2009                 [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
618    
619    
620     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires July 2, 2007                 [Page 11]  Schoenebeck               Expires June 9, 2009                 [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires July 2, 2007                 [Page 12]  Schoenebeck               Expires June 9, 2009                 [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires July 2, 2007                 [Page 13]  Schoenebeck               Expires June 9, 2009                 [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires July 2, 2007                 [Page 14]  Schoenebeck               Expires June 9, 2009                 [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires July 2, 2007                 [Page 15]  Schoenebeck               Expires June 9, 2009                 [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires July 2, 2007                 [Page 16]  Schoenebeck               Expires June 9, 2009                 [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires July 2, 2007                 [Page 17]  Schoenebeck               Expires June 9, 2009                 [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires July 2, 2007                 [Page 18]  Schoenebeck               Expires June 9, 2009                 [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires July 2, 2007                 [Page 19]  Schoenebeck               Expires June 9, 2009                 [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires July 2, 2007                 [Page 20]  Schoenebeck               Expires June 9, 2009                 [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires July 2, 2007                 [Page 21]  Schoenebeck               Expires June 9, 2009                 [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires July 2, 2007                 [Page 22]  Schoenebeck               Expires June 9, 2009                 [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires July 2, 2007                 [Page 23]  Schoenebeck               Expires June 9, 2009                 [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires July 2, 2007                 [Page 24]  Schoenebeck               Expires June 9, 2009                 [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires July 2, 2007                 [Page 25]  Schoenebeck               Expires June 9, 2009                 [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1458    
1459    
1460     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires July 2, 2007                 [Page 26]  Schoenebeck               Expires June 9, 2009                 [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires July 2, 2007                 [Page 27]  Schoenebeck               Expires June 9, 2009                 [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires July 2, 2007                 [Page 28]  Schoenebeck               Expires June 9, 2009                 [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1626    
1627    
1628        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires July 2, 2007                 [Page 29]  Schoenebeck               Expires June 9, 2009                 [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires July 2, 2007                 [Page 30]  Schoenebeck               Expires June 9, 2009                 [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires July 2, 2007                 [Page 31]  Schoenebeck               Expires June 9, 2009                 [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires July 2, 2007                 [Page 32]  Schoenebeck               Expires June 9, 2009                 [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1850    
1851    
1852        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires July 2, 2007                 [Page 33]  Schoenebeck               Expires June 9, 2009                 [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires July 2, 2007                 [Page 34]  Schoenebeck               Expires June 9, 2009                 [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires July 2, 2007                 [Page 35]  Schoenebeck               Expires June 9, 2009                 [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires July 2, 2007                 [Page 36]  Schoenebeck               Expires June 9, 2009                 [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires July 2, 2007                 [Page 37]  Schoenebeck               Expires June 9, 2009                 [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires July 2, 2007                 [Page 38]  Schoenebeck               Expires June 9, 2009                 [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires July 2, 2007                 [Page 39]  Schoenebeck               Expires June 9, 2009                 [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires July 2, 2007                 [Page 40]  Schoenebeck               Expires June 9, 2009                 [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2272  Internet-Draft        LinuxSampler Contr Line 2328  Internet-Draft        LinuxSampler Contr
2328     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2331     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2332       apostrophes) or NONE (not encapsulated into apostrophes) for
2333       specifying no value for parameters allowing a list of values.
2334    
2335     Possible Answers:     Possible Answers:
2336    
# Line 2286  Internet-Draft        LinuxSampler Contr Line 2344  Internet-Draft        LinuxSampler Contr
2344           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2345           code and warning message           code and warning message
2346    
       "ERR:<error-code>:<error-message>" -  
   
2347    
2348    
2349    
2350    
2351  Schoenebeck               Expires July 2, 2007                 [Page 41]  Schoenebeck               Expires June 9, 2009                 [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
2354    
2355    
2356          "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2359           error message           error message
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369          S: "OK"
2370    
2371  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2372    
# Line 2324  Internet-Draft        LinuxSampler Contr Line 2388  Internet-Draft        LinuxSampler Contr
2388     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2389     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2390    
2391       Notice: since LSCP 1.2 the <filename> argument supports escape
2392       characters for special characters (see chapter "Character Set and
2393       Escape Sequences (Section 7.1)" for details) and accordingly
2394       backslash characters in the filename MUST now be escaped as well!
2395    
2396     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2397     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2398     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
# Line 2332  Internet-Draft        LinuxSampler Contr Line 2401  Internet-Draft        LinuxSampler Contr
2401     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2402     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2403     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2404    
2405    
2406    
2407    Schoenebeck               Expires June 9, 2009                 [Page 43]
2408    
2409    Internet-Draft        LinuxSampler Control Protocol        December 2008
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
2413     process should any errors be detected at that point.     process should any errors be detected at that point.
2414    
# Line 2345  Internet-Draft        LinuxSampler Contr Line 2422  Internet-Draft        LinuxSampler Contr
2422    
2423           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2424           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 42]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2425           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2426           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2427           message           message
# Line 2362  Internet-Draft        LinuxSampler Contr Line 2431  Internet-Draft        LinuxSampler Contr
2431           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2432           error message           error message
2433    
2434     Example:     Example (Unix):
2435    
2436          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2437    
2438          S: OK
2439    
2440       Example (Windows):
2441    
2442          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2443    
2444          S: OK
2445    
2446  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2447    
# Line 2380  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
2457     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2458     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2459     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
2460    
2461    
2462    
2463    Schoenebeck               Expires June 9, 2009                 [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol        December 2008
2466    
2467    
2468     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2469     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2470     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
# Line 2402  Internet-Draft        LinuxSampler Contr Line 2487  Internet-Draft        LinuxSampler Contr
2487           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2488           error message           error message
2489    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2490     Example:     Example:
2491    
2492    
# Line 2432  Internet-Draft        LinuxSampler Contr Line 2510  Internet-Draft        LinuxSampler Contr
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck               Expires June 9, 2009                 [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol        December 2008
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2525    
2526     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2456  Internet-Draft        LinuxSampler Contr Line 2545  Internet-Draft        LinuxSampler Contr
2545     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
2546     list by sending the following command:     list by sending the following command:
2547    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2548        ADD CHANNEL        ADD CHANNEL
2549    
2550     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2488  Internet-Draft        LinuxSampler Contr Line 2568  Internet-Draft        LinuxSampler Contr
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires June 9, 2009                 [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol        December 2008
2578    
2579    
2580           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2581           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2582           code and warning message           code and warning message
# Line 2514  Internet-Draft        LinuxSampler Contr Line 2603  Internet-Draft        LinuxSampler Contr
2603    
2604     Possible Answers:     Possible Answers:
2605    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2606        "OK" -        "OK" -
2607    
2608           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2540  Internet-Draft        LinuxSampler Contr Line 2622  Internet-Draft        LinuxSampler Contr
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires June 9, 2009                 [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol        December 2008
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2637    
2638     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2567  Internet-Draft        LinuxSampler Contr Line 2660  Internet-Draft        LinuxSampler Contr
2660    
2661     Possible Answers:     Possible Answers:
2662    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2663        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2664        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2665        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2598  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2682     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires June 9, 2009                 [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol        December 2008
2690    
2691    
2692     Possible Answers:     Possible Answers:
2693    
2694        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2610  Internet-Draft        LinuxSampler Contr Line 2701  Internet-Draft        LinuxSampler Contr
2701    
2702           DESCRIPTION -           DESCRIPTION -
2703    
2704              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2705                character string may contain escape sequences (Section 7.1))
2706    
2707           VERSION -           VERSION -
2708    
# Line 2624  Internet-Draft        LinuxSampler Contr Line 2716  Internet-Draft        LinuxSampler Contr
2716    
2717        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2718    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2719           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2720    
2721           "."           "."
# Line 2654  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2738        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2739        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2740    
2741    
2742    
2743    Schoenebeck               Expires June 9, 2009                 [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol        December 2008
2746    
2747    
2748        following categories are defined:        following categories are defined:
2749    
2750    
# Line 2681  Internet-Draft        LinuxSampler Contr Line 2772  Internet-Draft        LinuxSampler Contr
2772              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2773              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2774              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2775              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2776              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2777              channel 3 of the audio output device              channel 3 of the audio output device
# Line 2696  Internet-Draft        LinuxSampler Contr Line 2779  Internet-Draft        LinuxSampler Contr
2779           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2780    
2781              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2782              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel (note: since
2783                LSCP 1.2 this path may contain escape sequences
2784                (Section 7.1))
2785    
2786           INSTRUMENT_NR -           INSTRUMENT_NR -
2787    
# Line 2704  Internet-Draft        LinuxSampler Contr Line 2789  Internet-Draft        LinuxSampler Contr
2789    
2790           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2791    
2792              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2793                LSCP 1.2 this character string may contain escape sequences
2794                (Section 7.1))
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires June 9, 2009                 [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2008
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
# Line 2735  Internet-Draft        LinuxSampler Contr Line 2830  Internet-Draft        LinuxSampler Contr
2830              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2831              means amplification)              means amplification)
2832    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2833           MUTE -           MUTE -
2834    
2835              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2765  Internet-Draft        LinuxSampler Contr Line 2850  Internet-Draft        LinuxSampler Contr
2850              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2851              values.              values.
2852    
2853    
2854    
2855    Schoenebeck               Expires June 9, 2009                 [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2008
2858    
2859    
2860     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2861    
2862     Example:     Example:
# Line 2793  Internet-Draft        LinuxSampler Contr Line 2885  Internet-Draft        LinuxSampler Contr
2885    
2886           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2887    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2888           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2889    
2890           "VOLUME: 1.0"           "VOLUME: 1.0"
# Line 2821  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2906    
2907     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2908    
2909    
2910    
2911    Schoenebeck               Expires June 9, 2009                 [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2008
2914    
2915    
2916     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2917     "LIST CHANNELS" (Section 6.4.4) command.     "LIST CHANNELS" (Section 6.4.4) command.
2918    
# Line 2849  Internet-Draft        LinuxSampler Contr Line 2941  Internet-Draft        LinuxSampler Contr
2941        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2942        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2943        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2944        return "NA" for not available.        return "NA" for not available.
2945    
2946     Example:     Example:
# Line 2877  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2962     sampler channel number the front-end is interested in as returned by     sampler channel number the front-end is interested in as returned by
2963     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2964    
2965    
2966    
2967    Schoenebeck               Expires June 9, 2009                 [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol        December 2008
2970    
2971    
2972     command.     command.
2973    
2974     Possible Answers:     Possible Answers:
# Line 2904  Internet-Draft        LinuxSampler Contr Line 2996  Internet-Draft        LinuxSampler Contr
2996    
2997        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2998    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2999        S: ""        S: ""
3000    
3001  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2932  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     Possible Answers:     Possible Answers:
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires June 9, 2009                 [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2008
3026    
3027    
3028        "OK" -        "OK" -
3029    
3030           on success           on success
# Line 2961  Internet-Draft        LinuxSampler Contr Line 3054  Internet-Draft        LinuxSampler Contr
3054        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3055        type>        type>
3056    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3057     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3058     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3059    
# Line 2989  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3075           error message           error message
3076    
3077    
3078    
3079    Schoenebeck               Expires June 9, 2009                 [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2008
3082    
3083    
3084     Examples:     Examples:
3085    
3086    
# Line 3016  Internet-Draft        LinuxSampler Contr Line 3108  Internet-Draft        LinuxSampler Contr
3108    
3109        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3110    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3111           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3112           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3113           warning message           warning message
# Line 3046  Internet-Draft        LinuxSampler Contr Line 3129  Internet-Draft        LinuxSampler Contr
3129        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3130    
3131     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3132    
3133    
3134    
3135    Schoenebeck               Expires June 9, 2009                 [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol        December 2008
3138    
3139    
3140     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3141     command and <midi-device-id> is the numerical ID of the MIDI input     command and <midi-device-id> is the numerical ID of the MIDI input
3142     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
# Line 3072  Internet-Draft        LinuxSampler Contr Line 3163  Internet-Draft        LinuxSampler Contr
3163    
3164    
3165    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3166  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3167    
3168     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3103  Internet-Draft        LinuxSampler Contr Line 3185  Internet-Draft        LinuxSampler Contr
3185    
3186           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3187           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3188    
3189    
3190    
3191    Schoenebeck               Expires June 9, 2009                 [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2008
3194    
3195    
3196           message           message
3197    
3198        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3128  Internet-Draft        LinuxSampler Contr Line 3218  Internet-Draft        LinuxSampler Contr
3218    
3219        "OK" -        "OK" -
3220    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3221           on success           on success
3222    
3223        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3159  Internet-Draft        LinuxSampler Contr Line 3240  Internet-Draft        LinuxSampler Contr
3240     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3241     listen to by sending the following command:     listen to by sending the following command:
3242    
3243    
3244    
3245    
3246    
3247    Schoenebeck               Expires June 9, 2009                 [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2008
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3253    
3254     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
# Line 3186  Internet-Draft        LinuxSampler Contr Line 3276  Internet-Draft        LinuxSampler Contr
3276    
3277    
3278    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
   
   
3279  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3280    
3281     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 3215  Internet-Draft        LinuxSampler Contr Line 3296  Internet-Draft        LinuxSampler Contr
3296    
3297        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires June 9, 2009                 [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol        December 2008
3306    
3307    
3308           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3309           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3310           message           message
# Line 3242  Internet-Draft        LinuxSampler Contr Line 3332  Internet-Draft        LinuxSampler Contr
3332    
3333     Possible Answers:     Possible Answers:
3334    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3335        "OK" -        "OK" -
3336    
3337           on success           on success
# Line 3268  Internet-Draft        LinuxSampler Contr Line 3351  Internet-Draft        LinuxSampler Contr
3351    
3352    
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck               Expires June 9, 2009                 [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol        December 2008
3362    
3363    
3364  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
3365    
3366     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
# Line 3297  Internet-Draft        LinuxSampler Contr Line 3390  Internet-Draft        LinuxSampler Contr
3390           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3391           error message           error message
3392    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3393     Examples:     Examples:
3394    
3395    
# Line 3323  Internet-Draft        LinuxSampler Contr Line 3408  Internet-Draft        LinuxSampler Contr
3408    
3409        "NONE" -        "NONE" -
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires June 9, 2009                 [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2008
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3421           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3422           all MIDI program change messages.           all MIDI program change messages.
# Line 3354  Internet-Draft        LinuxSampler Contr Line 3448  Internet-Draft        LinuxSampler Contr
3448           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3449           error message           error message
3450    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3451     Examples:     Examples:
3452    
3453    
# Line 3378  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3466     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3467     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3468     effect send entity.  The name does not have to be unique.  
3469    
3470    
3471    Schoenebeck               Expires June 9, 2009                 [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2008
3474    
3475    
3476       effect send entity.  The name does not have to be unique, but MUST be
3477       encapsulated into apostrophes and supports escape sequences as
3478       described in chapter "Character Set and Escape Sequences
3479       (Section 7.1)".
3480    
3481     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3482     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3387  Internet-Draft        LinuxSampler Contr Line 3485  Internet-Draft        LinuxSampler Contr
3485     having dedicated effect send output channels and when "CREATE     having dedicated effect send output channels and when "CREATE
3486     FX_SEND" is called, those channels will automatically be picked.  You     FX_SEND" is called, those channels will automatically be picked.  You
3487     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3488     AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3489    
3490     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3491     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
# Line 3407  Internet-Draft        LinuxSampler Contr Line 3505  Internet-Draft        LinuxSampler Contr
3505           channel, where <fx-send-id> reflects the unique ID of the newly           channel, where <fx-send-id> reflects the unique ID of the newly
3506           created effect send entity           created effect send entity
3507    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3508        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3509    
3510           when a new effect send could not be added, i.e. due to invalid           when a new effect send could not be added, i.e. due to invalid
# Line 3432  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
3520    
3521        S: "OK[1]"        S: "OK[1]"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires June 9, 2009                 [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2008
3530    
3531    
3532  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
3533    
3534     The front-end can remove an existing effect send on a specific     The front-end can remove an existing effect send on a specific
# Line 3463  Internet-Draft        LinuxSampler Contr Line 3560  Internet-Draft        LinuxSampler Contr
3560    
3561        S: "OK"        S: "OK"
3562    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3563  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
3564    
3565     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
# Line 3491  Internet-Draft        LinuxSampler Contr Line 3578  Internet-Draft        LinuxSampler Contr
3578    
3579     Example:     Example:
3580    
3581    
3582    
3583    Schoenebeck               Expires June 9, 2009                 [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2008
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
3589    
3590        S: "2"        S: "2"
# Line 3521  Internet-Draft        LinuxSampler Contr Line 3615  Internet-Draft        LinuxSampler Contr
3615    
3616        S: ""        S: ""
3617    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3618  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
3619    
3620     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
# Line 3547  Internet-Draft        LinuxSampler Contr Line 3633  Internet-Draft        LinuxSampler Contr
3633        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
3634        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
3635        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
3636    
3637    
3638    
3639    Schoenebeck               Expires June 9, 2009                 [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2008
3642    
3643    
3644        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
3645        following categories are defined:        following categories are defined:
3646    
# Line 3554  Internet-Draft        LinuxSampler Contr Line 3648  Internet-Draft        LinuxSampler Contr
3648    
3649           NAME -           NAME -
3650    
3651              name of the effect send entity              name of the effect send entity (note that this character
3652                string may contain escape sequences (Section 7.1))
3653    
3654             MIDI_CONTROLLER -
3655    
3656                a value between 0 and 127 reflecting the MIDI controller
3657                which is able to modify the effect send's send level
3658    
3659             LEVEL -
3660    
3661                optionally dotted number reflecting the effect send's
3662                current send level (where a value < 1.0 means attenuation
3663                and a value > 1.0 means amplification)
3664    
3665           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3666    
# Line 3564  Internet-Draft        LinuxSampler Contr Line 3670  Internet-Draft        LinuxSampler Contr
3670              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3671              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3672              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3673              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3674    
3675     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3676    
# Line 3574  Internet-Draft        LinuxSampler Contr Line 3680  Internet-Draft        LinuxSampler Contr
3680    
3681        S: "NAME: Reverb Send"        S: "NAME: Reverb Send"
3682    
3683             "MIDI_CONTROLLER: 91"
3684    
3685             "LEVEL: 0.3"
3686    
3687           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3688    
3689             "."
3690    
3691    
3692    
3693    
3694    
3695  Schoenebeck               Expires July 2, 2007                 [Page 64]  Schoenebeck               Expires June 9, 2009                 [Page 66]
3696    
3697  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
3698    
3699    
3700           "."  6.4.30.  Changing effect send's name
3701    
3702       The front-end can alter the current name of an effect send entity by
3703       sending the following command:
3704    
3705          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3706    
3707  6.4.30.  Altering effect send's audio routing     Where <sampler-chan> is the sampler channel number as returned by the
3708       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3709       command, <fx-send-id> reflects the numerical ID of the effect send
3710       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3711       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3712       effect send entity, which does not have to be unique (name MUST be
3713       encapsulated into apostrophes and supports escape sequences as
3714       described in chapter "Character Set and Escape Sequences
3715       (Section 7.1)").
3716    
3717       Possible Answers:
3718    
3719          "OK" -
3720    
3721             on success
3722    
3723          "ERR:<error-code>:<error-message>" -
3724    
3725             in case it failed, providing an appropriate error code and
3726             error message
3727    
3728       Example:
3729    
3730          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3731    
3732          S: "OK"
3733    
3734    6.4.31.  Altering effect send's audio routing
3735    
3736     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
3737     channel on a specific sampler channel by sending the following     channel on a specific sampler channel by sending the following
# Line 3601  Internet-Draft        LinuxSampler Contr Line 3745  Internet-Draft        LinuxSampler Contr
3745     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3746     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3747     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3748    
3749    
3750    
3751    Schoenebeck               Expires June 9, 2009                 [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2008
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3757     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3758     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.
# Line 3634  Internet-Draft        LinuxSampler Contr Line 3786  Internet-Draft        LinuxSampler Contr
3786           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3787           error message           error message
3788    
3789       Example:
3790    
3791          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3792    
3793          S: "OK"
3794    
3795    6.4.32.  Altering effect send's MIDI controller
3796    
3797       The front-end can alter the MIDI controller of an effect send entity
3798       by sending the following command:
3799    
3800  Schoenebeck               Expires July 2, 2007                 [Page 65]        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3801          ctrl>
3802    
3803       Where <sampler-chan> is the sampler channel number as returned by the
3804    
3805    
3806    
3807    Schoenebeck               Expires June 9, 2009                 [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
3810    
3811    
3812       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3813       command, <fx-send-id> reflects the numerical ID of the effect send
3814       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3815       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3816       controller which shall be able to modify the effect send's send
3817       level.
3818    
3819       Possible Answers:
3820    
3821          "OK" -
3822    
3823             on success
3824    
3825          "WRN:<warning-code>:<warning-message>" -
3826    
3827             if MIDI controller was set, but there are noteworthy issue(s)
3828             related, providing an appropriate warning code and warning
3829             message
3830    
3831          "ERR:<error-code>:<error-message>" -
3832    
3833             in case it failed, providing an appropriate error code and
3834             error message
3835    
3836     Example:     Example:
3837    
3838        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3839    
3840          S: "OK"
3841    
3842    6.4.33.  Altering effect send's send level
3843    
3844       The front-end can alter the current send level of an effect send
3845       entity by sending the following command:
3846    
3847          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3848    
3849       Where <sampler-chan> is the sampler channel number as returned by the
3850       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3851       command, <fx-send-id> reflects the numerical ID of the effect send
3852       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3853       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3854       dotted positive number (a value smaller than 1.0 means attenuation,
3855       whereas a value greater than 1.0 means amplification) reflecting the
3856       new send level.
3857    
3858       Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires June 9, 2009                 [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol        December 2008
3866    
3867    
3868          "OK" -
3869    
3870             on success
3871    
3872          "WRN:<warning-code>:<warning-message>" -
3873    
3874             if new send level was set, but there are noteworthy issue(s)
3875             related, providing an appropriate warning code and warning
3876             message
3877    
3878          "ERR:<error-code>:<error-message>" -
3879    
3880             in case it failed, providing an appropriate error code and
3881             error message
3882    
3883       Example:
3884    
3885          C: "SET FX_SEND LEVEL 0 0 0.15"
3886    
3887          S: "OK"
3888    
3889    6.4.34.  Sending MIDI messages to sampler channel
3890    
3891       The front-end can send MIDI events to specific sampler channel by
3892       sending the following command:
3893    
3894          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
3895    
3896       Where <sampler-chan> is the sampler channel number as returned by the
3897       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3898       command, <arg1> and <arg2> arguments depend on the <midi-msg>
3899       argument, which specifies the MIDI message type.  Currently, the
3900       following MIDI messages are supported:
3901    
3902          "NOTE_ON" -
3903    
3904             For turning on MIDI notes, where <arg1> specifies the key
3905             number and <arg2> the velocity as described in the MIDI
3906             specification.
3907    
3908          "NOTE_OFF" -
3909    
3910             For turning a currently playing MIDI note off, where <arg1>
3911             specifies the key number and <arg2> the velocity as described
3912             in the MIDI specification.
3913    
3914       CAUTION: This command is provided for implementations of virtual MIDI
3915       keyboards and no realtime guarantee whatsoever will be made!
3916    
3917    
3918    
3919    Schoenebeck               Expires June 9, 2009                 [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2008
3922    
3923    
3924       Possible Answers:
3925    
3926          "OK" -
3927    
3928             on success
3929    
3930          "ERR:<error-code>:<error-message>" -
3931    
3932             in case it failed, providing an appropriate error code and
3933             error message
3934    
3935       Example:
3936    
3937          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
3938    
3939        S: "OK"        S: "OK"
3940    
3941  6.4.31.  Resetting a sampler channel  6.4.35.  Resetting a sampler channel
3942    
3943     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3944     following command:     following command:
# Line 3680  Internet-Draft        LinuxSampler Contr Line 3971  Internet-Draft        LinuxSampler Contr
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires June 9, 2009                 [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol        December 2008
3978    
3979    
3980    
3981    
3982  6.5.  Controlling connection  6.5.  Controlling connection
3983    
3984     The following commands are used to control the connection to     The following commands are used to control the connection to
# Line 3690  Internet-Draft        LinuxSampler Contr Line 3989  Internet-Draft        LinuxSampler Contr
3989     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3990     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3991    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3992        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3993    
3994     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3733  Internet-Draft        LinuxSampler Contr Line 4025  Internet-Draft        LinuxSampler Contr
4025     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
4026     doesn't want to receive anymore.     doesn't want to receive anymore.
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires June 9, 2009                 [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2008
4034    
4035    
4036     Possible Answers:     Possible Answers:
4037    
4038        "OK" -        "OK" -
# Line 3745  Internet-Draft        LinuxSampler Contr Line 4045  Internet-Draft        LinuxSampler Contr
4045           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4046           message           message
4047    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4048        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4049    
4050           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3790  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082    
4083    
4084    
 6.5.4.  Close client connection  
4085    
    The client can close its network connection to LinuxSampler by  
    sending the following command:  
4086    
4087        QUIT  Schoenebeck               Expires June 9, 2009                 [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol        December 2008
4090    
    This is probably more interesting for manual telnet connections to  
    LinuxSampler than really useful for a front-end implementation.  
4091    
4092    
4093    
4094    6.5.4.  Close client connection
4095    
4096       The client can close its network connection to LinuxSampler by
4097       sending the following command:
4098    
4099  Schoenebeck               Expires July 2, 2007                 [Page 68]        QUIT
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4100    
4101       This is probably more interesting for manual telnet connections to
4102       LinuxSampler than really useful for a front-end implementation.
4103    
4104  6.6.  Global commands  6.6.  Global commands
4105    
# Line 3837  Internet-Draft        LinuxSampler Contr Line 4129  Internet-Draft        LinuxSampler Contr
4129        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4130        voices.        voices.
4131    
4132  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4133    
4134     The front-end can reset the whole sampler by sending the following     The front-end can ask for the current number of active disk streams
4135     command:     on the sampler by sending the following command:
4136    
4137        RESET        GET TOTAL_STREAM_COUNT
4138    
4139     Possible Answers:     Possible Answers:
4140    
       "OK" -  
4141    
          always  
4142    
4143     Examples:  Schoenebeck               Expires June 9, 2009                 [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2008
4146    
4147    
4148          LinuxSampler will answer by returning the number of all active
4149          disk streams on the sampler.
4150    
4151    6.6.4.  Reset sampler
4152    
4153       The front-end can reset the whole sampler by sending the following
4154       command:
4155    
4156          RESET
4157    
4158       Possible Answers:
4159    
4160          "OK" -
4161    
4162             always
4163    
4164  Schoenebeck               Expires July 2, 2007                 [Page 69]     Examples:
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4165    
4166    
4167  6.6.4.  General sampler informations  
4168    6.6.5.  General sampler informations
4169    
4170     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4171     instance by sending the following command:     instance by sending the following command:
# Line 3884  Internet-Draft        LinuxSampler Contr Line 4184  Internet-Draft        LinuxSampler Contr
4184    
4185           DESCRIPTION -           DESCRIPTION -
4186    
4187              arbitrary textual description about the sampler              arbitrary textual description about the sampler (note that
4188                the character string may contain escape sequences
4189                (Section 7.1))
4190    
4191           VERSION -           VERSION -
4192    
4193              version of the sampler              version of the sampler
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires June 9, 2009                 [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol        December 2008
4202    
4203    
4204           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4205    
4206              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4207              (see Section 2 for details)              (see Section 2 for details)
4208    
4209             INSTRUMENTS_DB_SUPPORT -
4210    
4211                either yes or no, specifies whether the sampler is build
4212                with instruments database support.
4213    
4214     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4215     Other fields might be added in future.     Other fields might be added in future.
4216    
4217  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4218    
4219     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4220     attenuation by sending the following command:     attenuation by sending the following command:
# Line 3913  Internet-Draft        LinuxSampler Contr Line 4229  Internet-Draft        LinuxSampler Contr
4229    
4230     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4231     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4232     this parameter.     this parameter.
4233    
4234  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4235    
4236     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4237     attenuation by sending the following command:     attenuation by sending the following command:
# Line 3941  Internet-Draft        LinuxSampler Contr Line 4249  Internet-Draft        LinuxSampler Contr
4249    
4250           on success           on success
4251    
4252    
4253    
4254    
4255    Schoenebeck               Expires June 9, 2009                 [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol        December 2008
4258    
4259    
4260        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4261    
4262           if the global volume was set, but there are noteworthy issue(s)           if the global volume was set, but there are noteworthy issue(s)
# Line 3952  Internet-Draft        LinuxSampler Contr Line 4268  Internet-Draft        LinuxSampler Contr
4268           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4269           error message           error message
4270    
4271    6.6.8.  Getting global voice limit
4272    
4273       The client can ask for the current global sampler-wide limit for
4274       maximum voices by sending the following command:
4275    
4276          GET VOICES
4277    
4278       Possible Answers:
4279    
4280          LinuxSampler will answer by returning the number for the current
4281          limit of maximum voices.
4282    
4283       The voice limit setting defines how many voices should maximum be
4284       processed by the sampler at the same time.  If the user triggers new
4285       notes which would exceed that voice limit, the sampler engine will
4286       react by stealing old voices for those newly triggered notes.  Note
4287       that the amount of voices triggered by a new note can be larger than
4288       one and is dependent to the respective instrument and probably
4289       further criterias.
4290    
4291    6.6.9.  Setting global voice limit
4292    
4293       The client can alter the current global sampler-wide limit for
4294       maximum voices by sending the following command:
4295    
4296          SET VOICES <max-voices>
4297    
4298       Where <max-voices> should be replaced by the integer value,
4299       reflecting the new global amount limit of maximum voices.  This value
4300       has to be larger than 0.
4301    
4302       Possible Answers:
4303    
4304          "OK" -
4305    
4306             on success
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires June 9, 2009                 [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2008
4314    
4315    
4316          "WRN:<warning-code>:<warning-message>" -
4317    
4318             if the voice limit was set, but there are noteworthy issue(s)
4319             related, providing an appropriate warning code and warning
4320             message
4321    
4322          "ERR:<error-code>:<error-message>" -
4323    
4324             in case it failed, providing an appropriate error code and
4325             error message
4326    
4327       Note: the given value will be passed to all sampler engine instances.
4328       The total amount of maximum voices on the running system might thus
4329       be as big as the given value multiplied by the current amount of
4330       engine instances.
4331    
4332       Caution: when adjusting the voice limit, you SHOULD also adjust the
4333       disk stream limit respectively and vice versa.
4334    
4335    6.6.10.  Getting global disk stream limit
4336    
4337       The client can ask for the current global sampler-wide limit for
4338       maximum disk streams by sending the following command:
4339    
4340          GET STREAMS
4341    
4342       Possible Answers:
4343    
4344          LinuxSampler will answer by returning the number for the current
4345          limit of maximum disk streams.
4346    
4347       The disk stream limit setting defines how many disk streams should
4348       maximum be processed by a sampler engine at the same time.  The
4349       higher this value, the more memory (RAM) will be occupied, since
4350       every disk streams allocates a certain buffer size for being able to
4351       perform its streaming operations.
4352    
4353    6.6.11.  Setting global disk stream limit
4354    
4355       The client can alter the current global sampler-wide limit for
4356       maximum disk streams by sending the following command:
4357    
4358          SET STREAMS <max-streams>
4359    
4360       Where <max-streams> should be replaced by the integer value,
4361       reflecting the new global amount limit of maximum disk streams.  This
4362       value has to be positive.
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires June 9, 2009                 [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2008
4370    
4371    
4372       Possible Answers:
4373    
4374          "OK" -
4375    
4376             on success
4377    
4378          "WRN:<warning-code>:<warning-message>" -
4379    
4380             if the disk stream limit was set, but there are noteworthy
4381             issue(s) related, providing an appropriate warning code and
4382             warning message
4383    
4384          "ERR:<error-code>:<error-message>" -
4385    
4386             in case it failed, providing an appropriate error code and
4387             error message
4388    
4389       Note: the given value will be passed to all sampler engine instances.
4390       The total amount of maximum disk streams on the running system might
4391       thus be as big as the given value multiplied by the current amount of
4392       engine instances.
4393    
4394       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4395       the voice limit respectively and vice versa.
4396    
4397  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4398    
4399     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4411  Internet-Draft        LinuxSampler Contr
4411     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
4412     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4413     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4414     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4415     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4416     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4417     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4418     channel.     channel.
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires June 9, 2009                 [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2008
4426    
4427    
4428     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4429     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
4430     select message the bank value will be stored and a subsequent program     select message the bank value will be stored and a subsequent program
# Line 3998  Internet-Draft        LinuxSampler Contr Line 4440  Internet-Draft        LinuxSampler Contr
4440        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4441    
4442     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4443     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4444       but MUST be encapsulated into apostrophes and support escape
4445       sequences as described in chapter "Character Set and Escape Sequences
4446       (Section 7.1)".
4447    
4448     Possible Answers:     Possible Answers:
4449    
# Line 4024  Internet-Draft        LinuxSampler Contr Line 4469  Internet-Draft        LinuxSampler Contr
4469    
4470        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4471    
4472          S: "OK[5]"
4473    
4474    
4475    
4476    
 Schoenebeck               Expires July 2, 2007                 [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4477    
4478    
4479        S: "OK[5]"  Schoenebeck               Expires June 9, 2009                 [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2008
4482    
4483    
4484  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
4485    
# Line 4079  Internet-Draft        LinuxSampler Contr Line 4525  Internet-Draft        LinuxSampler Contr
4525    
4526     Possible Answers:     Possible Answers:
4527    
4528          The sampler will answer by returning the current number of MIDI
4529          instrument maps.
4530    
4531       Example:
4532    
4533    
4534    
4535    Schoenebeck               Expires June 9, 2009                 [Page 81]
 Schoenebeck               Expires July 2, 2007                 [Page 73]  
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
   
   
       The sampler will answer by returning the current number of MIDI  
       instrument maps.  
4538    
    Example:  
4539    
4540        C: "GET MIDI_INSTRUMENT_MAPS"        C: "GET MIDI_INSTRUMENT_MAPS"
4541    
# Line 4138  Internet-Draft        LinuxSampler Contr Line 4581  Internet-Draft        LinuxSampler Contr
4581    
4582    
4583    
4584             NAME -
4585    
4586                custom name of the given map, which does not have to be
4587                unique (note that this character string may contain escape
4588    
 Schoenebeck               Expires July 2, 2007                 [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4589    
4590    
4591    Schoenebeck               Expires June 9, 2009                 [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2008
4594    
4595    
4596           NAME -              sequences (Section 7.1))
4597    
4598              custom name of the given map, which does not have to be           DEFAULT -
4599              unique  
4600                either true or false, defines whether this map is the
4601                default map
4602    
4603     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4604    
# Line 4160  Internet-Draft        LinuxSampler Contr Line 4608  Internet-Draft        LinuxSampler Contr
4608    
4609        S: "NAME: Standard Map"        S: "NAME: Standard Map"
4610    
4611             "DEFAULT: true"
4612    
4613           "."           "."
4614    
4615  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
# Line 4170  Internet-Draft        LinuxSampler Contr Line 4620  Internet-Draft        LinuxSampler Contr
4620        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4621    
4622     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4623     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4624       encapsulated into apostrophes and supports escape sequences as
4625       described in chapter "Character Set and Escape Sequences
4626       (Section 7.1)").
4627    
4628     Possible Answers:     Possible Answers:
4629    
# Line 4188  Internet-Draft        LinuxSampler Contr Line 4641  Internet-Draft        LinuxSampler Contr
4641    
4642        S: "OK"        S: "OK"
4643    
 6.7.7.  Create or replace a MIDI instrument map entry  
4644    
    The front-end can create a new or replace an existing entry in a  
    sampler's MIDI instrument map by sending the following command:  
4645    
4646    
4647    Schoenebeck               Expires June 9, 2009                 [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2008
4650    
4651    
4652  Schoenebeck               Expires July 2, 2007                 [Page 75]  6.7.7.  Create or replace a MIDI instrument map entry
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4653    
4654       The front-end can create a new or replace an existing entry in a
4655       sampler's MIDI instrument map by sending the following command:
4656    
4657        MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>        MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4658        <filename> <instrument_index> <volume_value> [<instr_load_mode>]        <engine_name> <filename> <instrument_index> <volume_value>
4659        [<name>]        [<instr_load_mode>] [<name>]
4660    
4661     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4662     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
# Line 4211  Internet-Draft        LinuxSampler Contr Line 4664  Internet-Draft        LinuxSampler Contr
4664     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4665     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4666     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4667     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes,
4668     <instrument_index> the index (integer value) of the instrument within     supporting escape sequences as described in chapter "Character Set
4669     the given file, <volume_value> reflects the master volume of the     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4670     instrument as optionally dotted number (where a value < 1.0 means     (integer value) of the instrument within the given file,
4671     attenuation and a value > 1.0 means amplification).  This parameter     <volume_value> reflects the master volume of the instrument as
4672     easily allows to adjust the volume of all intruments within a custom     optionally dotted number (where a value < 1.0 means attenuation and a
4673     instrument map without having to adjust their instrument files.  The     value > 1.0 means amplification).  This parameter easily allows to
4674     OPTIONAL <instr_load_mode> argument defines the life time of the     adjust the volume of all intruments within a custom instrument map
4675     instrument, that is when the instrument should be loaded, when freed     without having to adjust their instrument files.  The OPTIONAL
4676     and has exactly the following possibilities:     <instr_load_mode> argument defines the life time of the instrument,
4677       that is when the instrument should be loaded, when freed and has
4678       exactly the following possibilities:
4679    
4680        "ON_DEMAND" -        "ON_DEMAND" -
4681    
# Line 4241  Internet-Draft        LinuxSampler Contr Line 4696  Internet-Draft        LinuxSampler Contr
4696    
4697        "PERSISTENT" -        "PERSISTENT" -
4698    
          The instrument will immediately be loaded into memory in the  
          background when this mapping command is sent and the instrument  
          is kept all the time.  Instruments with this mode are only  
          freed when the sampler is reset or all mapping entries with  
          this mode (and respective instrument) are explicitly changed to  
          "ON_DEMAND" and no sampler channel is using the instrument  
          anymore.  
4699    
4700    
4701    
4702    
4703  Schoenebeck               Expires July 2, 2007                 [Page 76]  Schoenebeck               Expires June 9, 2009                 [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
4706    
4707    
4708             The instrument will immediately be loaded into memory when this
4709             mapping command is sent and the instrument is kept all the
4710             time.  Instruments with this mode are only freed when the
4711             sampler is reset or all mapping entries with this mode (and
4712             respective instrument) are explicitly changed to "ON_DEMAND"
4713             and no sampler channel is using the instrument anymore.
4714    
4715        not supplied -        not supplied -
4716    
4717           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
# Line 4282  Internet-Draft        LinuxSampler Contr Line 4737  Internet-Draft        LinuxSampler Contr
4737     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4738     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4739     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4740     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4741     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4742     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4743       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4744     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     (Section 6.7.11)).
4745     will not block when an instrument is to be loaded due to a  
4746     "PERSISTENT" type entry as instruments are loaded in the background.     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4747     As a consequence this command may not necessarily return an error     completely established in the sampler.  The OPTIONAL "NON_MODAL"
4748     i.e. when the given instrument file does not exist or may turn out to     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4749     be corrupt.     to return immediately, that is to let the sampler establish the
4750       mapping in the background.  So this argument might be especially
4751       useful for mappings with a "PERSISTENT" type, because these have to
4752       load the respective instruments immediately and might thus block for
4753       a very long time.  It is recommended however to use the OPTIONAL
4754       "NON_MODAL" argument only if really necessary, because it has the
4755       following drawbacks: as "NON_MODAL" instructions return immediately,
4756    
4757    
4758    
4759    Schoenebeck               Expires June 9, 2009                 [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2008
4762    
4763    
4764       they may not necessarily return an error i.e. when the given
4765       instrument file turns out to be corrupt, beside that subsequent
4766       commands in a LSCP instruction sequence might fail, because mandatory
4767       mappings are not yet completed.
4768    
4769     Possible Answers:     Possible Answers:
4770    
# Line 4306  Internet-Draft        LinuxSampler Contr Line 4779  Internet-Draft        LinuxSampler Contr
4779    
4780     Examples:     Examples:
4781    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4782        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4783        0.8 PERSISTENT"        0.8 PERSISTENT"
4784    
# Line 4333  Internet-Draft        LinuxSampler Contr Line 4799  Internet-Draft        LinuxSampler Contr
4799    
4800        S: "OK"        S: "OK"
4801    
4802        C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4803        PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4804    
4805        S: "OK"        S: "OK"
4806    
# Line 4343  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
4810     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires June 9, 2009                 [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2008
4818    
4819    
4820        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4821    
4822     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4835  Internet-Draft        LinuxSampler Contr
4835    
4836        S: "234"        S: "234"
4837    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4838        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
4839    
4840        S: "954"        S: "954"
# Line 4399  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865    
4866     Example:     Example:
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires June 9, 2009                 [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol        December 2008
4874    
4875    
4876        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4877    
4878        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4891  Internet-Draft        LinuxSampler Contr
4891    
4892     Possible Answers:     Possible Answers:
4893    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4894        "OK" -        "OK" -
4895    
4896           usually           usually
# Line 4454  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921     Possible Answers:     Possible Answers:
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 9, 2009                 [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2008
4930    
4931    
4932        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4933        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4934        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 4466  Internet-Draft        LinuxSampler Contr Line 4941  Internet-Draft        LinuxSampler Contr
4941           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4942           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4943           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4944           be unique.           be unique. (note that this character string may contain escape
4945             sequences (Section 7.1))
4946    
4947        "ENGINE_NAME" -        "ENGINE_NAME" -
4948    
4949           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
4950    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4951        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4952    
4953           File name of the instrument.           File name of the instrument (note that this path may contain
4954             escape sequences (Section 7.1)).
4955    
4956        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
4957    
# Line 4493  Internet-Draft        LinuxSampler Contr Line 4961  Internet-Draft        LinuxSampler Contr
4961    
4962           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
4963           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4964           cannot be changed.           cannot be changed (note that this character string may contain
4965             escape sequences (Section 7.1)).
4966    
4967        "LOAD_MODE" -        "LOAD_MODE" -
4968    
# Line 4506  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975           (where a value < 1.0 means attenuation and a value > 1.0 means           (where a value < 1.0 means attenuation and a value > 1.0 means
4976           amplification)           amplification)
4977    
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 9, 2009                 [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2008
4986    
4987    
4988        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
4989    
4990     Example:     Example:
# Line 4528  Internet-Draft        LinuxSampler Contr Line 5007  Internet-Draft        LinuxSampler Contr
5007    
5008           "."           "."
5009    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
5010  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
5011    
5012     The front-end can clear a whole MIDI instrument map, that is delete     The front-end can clear a whole MIDI instrument map, that is delete
# Line 4563  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034     Examples:     Examples:
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires June 9, 2009                 [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol        December 2008
5042    
5043    
5044        C: "CLEAR MIDI_INSTRUMENTS 0"        C: "CLEAR MIDI_INSTRUMENTS 0"
5045    
5046        S: "OK"        S: "OK"
# Line 4571  Internet-Draft        LinuxSampler Contr Line 5049  Internet-Draft        LinuxSampler Contr
5049    
5050        S: "OK"        S: "OK"
5051    
5052    6.8.  Managing Instruments Database
5053    
5054       The following commands describe how to use and manage the instruments
5055       database.
5056    
5057       Notice:
5058    
5059          All command arguments representing a path or instrument/directory
5060          name support escape sequences as described in chapter "Character
5061          Set and Escape Sequences (Section 7.1)".
5062    
5063          All occurrences of a forward slash in instrument and directory
5064          names are escaped with its hex (\x2f) or octal (\057) escape
5065          sequence.
5066    
5067    6.8.1.  Creating a new instrument directory
5068    
5069       The front-end can add a new instrument directory to the instruments
5070       database by sending the following command:
5071    
5072          ADD DB_INSTRUMENT_DIRECTORY <dir>
5073    
5074       Where <dir> is the absolute path name of the directory to be created
5075       (encapsulated into apostrophes).
5076    
5077       Possible Answers:
5078    
5079          "OK" -
5080    
5081             on success
5082    
5083          "ERR:<error-code>:<error-message>" -
5084    
5085             when the directory could not be created, which can happen if
5086             the directory already exists or the name contains not allowed
5087             symbols
5088    
5089       Examples:
5090    
5091    
5092    
5093    
5094    
5095  Schoenebeck               Expires July 2, 2007                 [Page 82]  Schoenebeck               Expires June 9, 2009                 [Page 91]
5096    
5097  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
5098    
5099    
5100          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5101    
5102          S: "OK"
5103    
5104    6.8.2.  Deleting an instrument directory
5105    
5106       The front-end can delete a particular instrument directory from the
5107       instruments database by sending the following command:
5108    
5109          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
5110    
5111       Where <dir> is the absolute path name of the directory to delete.
5112       The optional FORCE argument can be used to force the deletion of a
5113       non-empty directory and all its content.
5114    
5115       Possible Answers:
5116    
5117          "OK" -
5118    
5119             if the directory is deleted successfully
5120    
5121          "ERR:<error-code>:<error-message>" -
5122    
5123             if the given directory does not exist, or if trying to delete a
5124             non-empty directory, without using the FORCE argument.
5125    
5126       Examples:
5127    
5128          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
5129    
5130          S: "OK"
5131    
5132    6.8.3.  Getting amount of instrument directories
5133    
5134       The front-end can retrieve the current amount of directories in a
5135       specific directory by sending the following command:
5136    
5137          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5138    
5139       Where <dir> should be replaced by the absolute path name of the
5140       directory.  If RECURSIVE is specified, the number of all directories,
5141       including those located in subdirectories of the specified directory,
5142       will be returned.
5143    
5144       Possible Answers:
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires June 9, 2009                 [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2008
5154    
5155    
5156          The current number of instrument directories in the specified
5157          directory.
5158    
5159          "ERR:<error-code>:<error-message>" -
5160    
5161             if the given directory does not exist.
5162    
5163       Example:
5164    
5165          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
5166    
5167          S: "2"
5168    
5169    6.8.4.  Listing all directories in specific directory
5170    
5171       The front-end can retrieve the current list of directories in
5172       specific directory by sending the following command:
5173    
5174          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5175    
5176       Where <dir> should be replaced by the absolute path name of the
5177       directory.  If RECURSIVE is specified, the absolute path names of all
5178       directories, including those located in subdirectories of the
5179       specified directory, will be returned.
5180    
5181       Possible Answers:
5182    
5183          A comma separated list of all instrument directories (encapsulated
5184          into apostrophes) in the specified directory.
5185    
5186          "ERR:<error-code>:<error-message>" -
5187    
5188             if the given directory does not exist.
5189    
5190       Example:
5191    
5192          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
5193    
5194          S: "'Piano Collection','Percussion Collection'"
5195    
5196          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
5197    
5198          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5199          Collection/Acoustic/New','/Percussion Collection'"
5200    
5201    
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires June 9, 2009                 [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2008
5210    
5211    
5212    6.8.5.  Getting instrument directory information
5213    
5214       The front-end can ask for the current settings of an instrument
5215       directory by sending the following command:
5216    
5217          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
5218    
5219       Where <dir> should be replaced by the absolute path name of the
5220       directory the front-end is interested in.
5221    
5222       Possible Answers:
5223    
5224          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5225          answer line begins with the settings category name followed by a
5226          colon and then a space character <SP> and finally the info
5227          character string to that setting category.  At the moment the
5228          following categories are defined:
5229    
5230    
5231    
5232             DESCRIPTION -
5233    
5234                A brief description of the directory content.  Note that the
5235                character string may contain escape sequences (Section 7.1).
5236    
5237             CREATED -
5238    
5239                The creation date and time of the directory, represented in
5240                "YYYY-MM-DD HH:MM:SS" format
5241    
5242             MODIFIED -
5243    
5244                The date and time of the last modification of the directory,
5245                represented in "YYYY-MM-DD HH:MM:SS" format
5246    
5247       The mentioned fields above don't have to be in particular order.
5248    
5249       Example:
5250    
5251          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5252    
5253          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5254          format."
5255    
5256             "CREATED: 2007-02-05 10:23:12"
5257    
5258             "MODIFIED: 2007-04-07 12:50:21"
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires June 9, 2009                 [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2008
5266    
5267    
5268             "."
5269    
5270    6.8.6.  Renaming an instrument directory
5271    
5272       The front-end can alter the name of a specific instrument directory
5273       by sending the following command:
5274    
5275          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5276    
5277       Where <dir> is the absolute path name of the directory and <name> is
5278       the new name for that directory.
5279    
5280       Possible Answers:
5281    
5282          "OK" -
5283    
5284             on success
5285    
5286          "ERR:<error-code>:<error-message>" -
5287    
5288             in case the given directory does not exists, or if a directory
5289             with name equal to the new name already exists.
5290    
5291       Example:
5292    
5293          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5294          'Acoustic'"
5295    
5296          S: "OK"
5297    
5298    6.8.7.  Moving an instrument directory
5299    
5300       The front-end can move a specific instrument directory by sending the
5301       following command:
5302    
5303          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5304    
5305       Where <dir> is the absolute path name of the directory to move and
5306       <dst> is the location where the directory will be moved to.
5307    
5308       Possible Answers:
5309    
5310          "OK" -
5311    
5312             on success
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires June 9, 2009                 [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2008
5322    
5323    
5324          "ERR:<error-code>:<error-message>" -
5325    
5326             in case a given directory does not exists, or if a directory
5327             with name equal to the name of the specified directory already
5328             exists in the destination directory.  Error is also thrown when
5329             trying to move a directory to a subdirectory of itself.
5330    
5331       Example:
5332    
5333          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5334          Acoustic'"
5335    
5336          S: "OK"
5337    
5338    6.8.8.  Copying instrument directories
5339    
5340       The front-end can copy a specific instrument directory by sending the
5341       following command:
5342    
5343          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5344    
5345       Where <dir> is the absolute path name of the directory to copy and
5346       <dst> is the location where the directory will be copied to.
5347    
5348       Possible Answers:
5349    
5350          "OK" -
5351    
5352             on success
5353    
5354          "ERR:<error-code>:<error-message>" -
5355    
5356             in case a given directory does not exists, or if a directory
5357             with name equal to the name of the specified directory already
5358             exists in the destination directory.  Error is also thrown when
5359             trying to copy a directory to a subdirectory of itself.
5360    
5361       Example:
5362    
5363          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5364          '/Acoustic/Pianos'"
5365    
5366          S: "OK"
5367    
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires June 9, 2009                 [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2008
5378    
5379    
5380    6.8.9.  Changing the description of directory
5381    
5382       The front-end can alter the description of a specific instrument
5383       directory by sending the following command:
5384    
5385          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5386    
5387       Where <dir> is the absolute path name of the directory and <desc> is
5388       the new description for the directory (encapsulated into apostrophes,
5389       supporting escape sequences as described in chapter "Character Set
5390       and Escape Sequences (Section 7.1)").
5391    
5392       Possible Answers:
5393    
5394          "OK" -
5395    
5396             on success
5397    
5398          "ERR:<error-code>:<error-message>" -
5399    
5400             in case the given directory does not exists.
5401    
5402       Example:
5403    
5404          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5405          collection of piano instruments in various format.'"
5406    
5407          S: "OK"
5408    
5409    6.8.10.  Finding directories
5410    
5411       The front-end can search for directories in specific directory by
5412       sending the following command:
5413    
5414          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5415          list>
5416    
5417       Where <dir> should be replaced by the absolute path name of the
5418       directory to search in.  If NON_RECURSIVE is specified, the
5419       directories located in subdirectories of the specified directory will
5420       not be searched. <criteria-list> is a list of search criterias in
5421       form of "key1=val1 key2=val2 ...".  The following criterias are
5422       allowed:
5423    
5424       NAME='<search-string>'
5425    
5426          Restricts the search to directories, which names satisfy the
5427          supplied search string (encapsulated into apostrophes, supporting
5428    
5429    
5430    
5431    Schoenebeck               Expires June 9, 2009                 [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2008
5434    
5435    
5436          escape sequences as described in chapter "Character Set and Escape
5437          Sequences (Section 7.1)").
5438    
5439       CREATED='[<date-after>]..[<date-before>]'
5440    
5441          Restricts the search to directories, which creation date satisfies
5442          the specified period, where <date-after> and <date-before> are in
5443          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5444          search is restricted to directories created before <date-before>.
5445          If <date-before> is omitted, the search is restricted to
5446          directories created after <date-after>.
5447    
5448       MODIFIED='[<date-after>]..[<date-before>]'
5449    
5450          Restricts the search to directories, which date of last
5451          modification satisfies the specified period, where <date-after>
5452          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5453          after> is omitted the search is restricted to directories, which
5454          are last modified before <date-before>.  If <date-before> is
5455          omitted, the search is restricted to directories, which are last
5456          modified after <date-after>.
5457    
5458       DESCRIPTION='<search-string>'
5459    
5460          Restricts the search to directories with description that
5461          satisfies the supplied search string (encapsulated into
5462          apostrophes, supporting escape sequences as described in chapter
5463          "Character Set and Escape Sequences (Section 7.1)").
5464    
5465       Where <search-string> is either a regular expression, or a word list
5466       separated with spaces for OR search and with '+' for AND search.
5467    
5468       Possible Answers:
5469    
5470          A comma separated list with the absolute path names (encapsulated
5471          into apostrophes) of all directories in the specified directory
5472          that satisfy the supplied search criterias.
5473    
5474          "ERR:<error-code>:<error-message>" -
5475    
5476             if the given directory does not exist.
5477    
5478       Example:
5479    
5480          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5481    
5482          S: "'/Piano Collection'"
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires June 9, 2009                 [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol        December 2008
5490    
5491    
5492          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5493          30:13'"
5494    
5495          S: "'/Piano Collection','/Percussions'"
5496    
5497    6.8.11.  Adding instruments to the instruments database
5498    
5499       The front-end can add one or more instruments to the instruments
5500       database by sending the following command:
5501    
5502          ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5503          <file_path> [<instr_index>]
5504    
5505       Where <db_dir> is the absolute path name of a directory (encapsulated
5506       into apostrophes) in the instruments database in which only the new
5507       instruments (that are not already in the database) will be added,
5508       <file_path> is the absolute path name of a file or directory in the
5509       file system (encapsulated into apostrophes).  In case an instrument
5510       file is supplied, only the instruments in the specified file will be
5511       added to the instruments database.  If the optional <instr_index>
5512       (the index of the instrument within the given file) is supplied too,
5513       then only the specified instrument will be added.  In case a
5514       directory is supplied, the instruments in that directory will be
5515       added.  The OPTIONAL <mode> argument is only applied when a directory
5516       is provided as <file_path> and specifies how the scanning will be
5517       done and has exactly the following possibilities:
5518    
5519          "RECURSIVE" -
5520    
5521             All instruments will be processed, including those in the
5522             subdirectories, and the respective subdirectory tree structure
5523             will be recreated in the instruments database
5524    
5525          "NON_RECURSIVE" -
5526    
5527             Only the instruments in the specified directory will be added,
5528             the instruments in the subdirectories will not be processed.
5529    
5530          "FLAT" -
5531    
5532             All instruments will be processed, including those in the
5533             subdirectories, but the respective subdirectory structure will
5534             not be recreated in the instruments database.  All instruments
5535             will be added directly in the specified database directory.
5536    
5537       If FILE_AS_DIR argument is supplied, all instruments in an instrument
5538       file will be added to a separate directory in the instruments
5539       database, which name will be the name of the instrument file with the
5540    
5541    
5542    
5543    Schoenebeck               Expires June 9, 2009                 [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol        December 2008
5546    
5547    
5548       file extension stripped off.
5549    
5550       The difference between regular and NON_MODAL versions of the command
5551       is that the regular command returns when the scanning is finished
5552       while NON_MODAL version returns immediately and a background process
5553       is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5554       command can be used to monitor the scanning progress.
5555    
5556       Possible Answers:
5557    
5558          "OK" -
5559    
5560             on success when NON_MODAL is not supplied
5561    
5562          "OK[<job-id>]" -
5563    
5564             on success when NON_MODAL is supplied, where <job-id> is a
5565             numerical ID used to obtain status information about the job
5566             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5567    
5568          "ERR:<error-code>:<error-message>" -
5569    
5570             if an invalid path is specified.
5571    
5572       Examples:
5573    
5574          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5575          Bosendorfer 290.gig' 0"
5576    
5577          S: "OK"
5578    
5579    6.8.12.  Removing an instrument
5580    
5581       The front-end can remove a particular instrument from the instruments
5582       database by sending the following command:
5583    
5584          REMOVE DB_INSTRUMENT <instr_path>
5585    
5586       Where <instr_path> is the absolute path name (in the instruments
5587       database) of the instrument to remove.
5588    
5589       Possible Answers:
5590    
5591          "OK" -
5592    
5593             if the instrument is removed successfully
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires June 9, 2009                [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol        December 2008
5602    
5603    
5604          "ERR:<error-code>:<error-message>" -
5605    
5606             if the given path does not exist or is a directory.
5607    
5608       Examples:
5609    
5610          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5611    
5612          S: "OK"
5613    
5614    6.8.13.  Getting amount of instruments
5615    
5616       The front-end can retrieve the current amount of instruments in a
5617       specific directory by sending the following command:
5618    
5619          GET DB_INSTRUMENTS [RECURSIVE] <dir>
5620    
5621       Where <dir> should be replaced by the absolute path name of the
5622       directory.  If RECURSIVE is specified, the number of all instruments,
5623       including those located in subdirectories of the specified directory,
5624       will be returned.
5625    
5626       Possible Answers:
5627    
5628          The current number of instruments in the specified directory.
5629    
5630          "ERR:<error-code>:<error-message>" -
5631    
5632             if the given directory does not exist.
5633    
5634       Example:
5635    
5636          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5637    
5638          S: "2"
5639    
5640    6.8.14.  Listing all instruments in specific directory
5641    
5642       The front-end can retrieve the current list of instruments in
5643       specific directory by sending the following command:
5644    
5645          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5646    
5647       Where <dir> should be replaced by the absolute path name of the
5648       directory.  If RECURSIVE is specified, the absolute path names of all
5649       instruments, including those located in subdirectories of the
5650       specified directory, will be returned.
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires June 9, 2009                [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol        December 2008
5658    
5659    
5660       Possible Answers:
5661    
5662          A comma separated list of all instruments (encapsulated into
5663          apostrophes) in the specified directory.
5664    
5665          "ERR:<error-code>:<error-message>" -
5666    
5667             if the given directory does not exist.
5668    
5669       Example:
5670    
5671          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5672    
5673          S: "'Bosendorfer 290','Steinway D'"
5674    
5675          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5676    
5677          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5678          Steinway D','/Piano Collection/Lite/Free Piano'"
5679    
5680    6.8.15.  Getting instrument information
5681    
5682       The front-end can ask for the current settings of an instrument by
5683       sending the following command:
5684    
5685          GET DB_INSTRUMENT INFO <instr_path>
5686    
5687       Where <instr_path> should be replaced by the absolute path name of
5688       the instrument the front-end is interested in.
5689    
5690       Possible Answers:
5691    
5692          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5693          answer line begins with the settings category name followed by a
5694          colon and then a space character <SP> and finally the info
5695          character string to that setting category.  At the moment the
5696          following categories are defined:
5697    
5698    
5699    
5700             INSTRUMENT_FILE -
5701    
5702                File name of the instrument.  Note that the character string
5703                may contain escape sequences (Section 7.1).
5704    
5705             INSTRUMENT_NR -
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck               Expires June 9, 2009                [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol        December 2008
5714    
5715    
5716                Index of the instrument within the file.
5717    
5718             FORMAT_FAMILY -
5719    
5720                The format family of the instrument.
5721    
5722             FORMAT_VERSION -
5723    
5724                The format version of the instrument.
5725    
5726             SIZE -
5727    
5728                The size of the instrument in bytes.
5729    
5730             CREATED -
5731    
5732                The date and time when the instrument is added in the
5733                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5734                format
5735    
5736             MODIFIED -
5737    
5738                The date and time of the last modification of the
5739                instrument's database settings, represented in "YYYY-MM-DD
5740                HH:MM:SS" format
5741    
5742             DESCRIPTION -
5743    
5744                A brief description of the instrument.  Note that the
5745                character string may contain escape sequences (Section 7.1).
5746    
5747             IS_DRUM -
5748    
5749                either true or false, determines whether the instrument is a
5750                drumkit or a chromatic instrument
5751    
5752             PRODUCT -
5753    
5754                The product title of the instrument.  Note that the
5755                character string may contain escape sequences (Section 7.1).
5756    
5757             ARTISTS -
5758    
5759                Lists the artist names.  Note that the character string may
5760                contain escape sequences (Section 7.1).
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires June 9, 2009                [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol        December 2008
5770    
5771    
5772             KEYWORDS -
5773    
5774                Provides a list of keywords that refer to the instrument.
5775                Keywords are separated with semicolon and blank.  Note that
5776                the character string may contain escape sequences
5777                (Section 7.1).
5778    
5779       The mentioned fields above don't have to be in particular order.
5780    
5781       Example:
5782    
5783          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5784    
5785          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5786    
5787             "INSTRUMENT_NR: 0"
5788    
5789             "FORMAT_FAMILY: GIG"
5790    
5791             "FORMAT_VERSION: 2"
5792    
5793             "SIZE: 2050871870"
5794    
5795             "CREATED: 2007-02-05 10:23:12"
5796    
5797             "MODIFIED: 2007-04-07 12:50:21"
5798    
5799             "DESCRIPTION: "
5800    
5801             "IS_DRUM: false"
5802    
5803             "PRODUCT: GRANDIOSO Bosendorfer 290"
5804    
5805             "ARTISTS: Post Musical Instruments"
5806    
5807             "KEYWORDS: Bosendorfer"
5808    
5809             "."
5810    
5811    6.8.16.  Renaming an instrument
5812    
5813       The front-end can alter the name of a specific instrument by sending
5814       the following command:
5815    
5816          SET DB_INSTRUMENT NAME <instr> <name>
5817    
5818       Where <instr> is the absolute path name of the instrument and <name>
5819       is the new name for that instrument.
5820    
5821    
5822    
5823    Schoenebeck               Expires June 9, 2009                [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol        December 2008
5826    
5827    
5828       Possible Answers:
5829    
5830          "OK" -
5831    
5832             on success
5833    
5834          "ERR:<error-code>:<error-message>" -
5835    
5836             in case the given instrument does not exists, or if an
5837             instrument with name equal to the new name already exists.
5838    
5839       Example:
5840    
5841          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5842          'Bosendorfer 290'"
5843    
5844          S: "OK"
5845    
5846    6.8.17.  Moving an instrument
5847    
5848       The front-end can move a specific instrument to another directory by
5849       sending the following command:
5850    
5851          MOVE DB_INSTRUMENT <instr> <dst>
5852    
5853       Where <instr> is the absolute path name of the instrument to move and
5854       <dst> is the directory where the instrument will be moved to.
5855    
5856       Possible Answers:
5857    
5858          "OK" -
5859    
5860             on success
5861    
5862          "ERR:<error-code>:<error-message>" -
5863    
5864             in case the given instrument does not exists, or if an
5865             instrument with name equal to the name of the specified
5866             instrument already exists in the destination directory.
5867    
5868       Example:
5869    
5870          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5871          Collection/Acoustic'"
5872    
5873          S: "OK"
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires June 9, 2009                [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol        December 2008
5882    
5883    
5884    6.8.18.  Copying instruments
5885    
5886       The front-end can copy a specific instrument to another directory by
5887       sending the following command:
5888    
5889          COPY DB_INSTRUMENT <instr> <dst>
5890    
5891       Where <instr> is the absolute path name of the instrument to copy and
5892       <dst> is the directory where the instrument will be copied to.
5893    
5894       Possible Answers:
5895    
5896          "OK" -
5897    
5898             on success
5899    
5900          "ERR:<error-code>:<error-message>" -
5901    
5902             in case the given instrument does not exists, or if an
5903             instrument with name equal to the name of the specified
5904             instrument already exists in the destination directory.
5905    
5906       Example:
5907    
5908          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5909          '/Acoustic/Pianos/'"
5910    
5911          S: "OK"
5912    
5913    6.8.19.  Changing the description of instrument
5914    
5915       The front-end can alter the description of a specific instrument by
5916       sending the following command:
5917    
5918          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5919    
5920       Where <instr> is the absolute path name of the instrument and <desc>
5921       is the new description for the instrument (encapsulated into
5922       apostrophes, supporting escape sequences as described in chapter
5923       "Character Set and Escape Sequences (Section 7.1)").
5924    
5925       Possible Answers:
5926    
5927          "OK" -
5928    
5929             on success
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires June 9, 2009                [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol        December 2008
5938    
5939    
5940          "ERR:<error-code>:<error-message>" -
5941    
5942             in case the given instrument does not exists.
5943    
5944       Example:
5945    
5946          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5947          Bosendorfer 290' 'No comment :)'"
5948    
5949          S: "OK"
5950    
5951    6.8.20.  Finding instruments
5952    
5953       The front-end can search for instruments in specific directory by
5954       sending the following command:
5955    
5956          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5957    
5958       Where <dir> should be replaced by the absolute path name of the
5959       directory to search in.  If NON_RECURSIVE is specified, the
5960       directories located in subdirectories of the specified directory will
5961       not be searched. <criteria-list> is a list of search criterias in
5962       form of "key1=val1 key2=val2 ...".  The following criterias are
5963       allowed:
5964    
5965       NAME='<search-string>'
5966    
5967          Restricts the search to instruments, which names satisfy the
5968          supplied search string (encapsulated into apostrophes, supporting
5969          escape sequences as described in chapter "Character Set and Escape
5970          Sequences (Section 7.1)").
5971    
5972       SIZE=[<min>]..[<max>]
5973    
5974          Restricts the search to instruments, which size is in the
5975          specified range.  If <min> is omitted, the search results are
5976          restricted to instruments with size less then or equal to <max>.
5977          If <max> is omitted, the search is restricted to instruments with
5978          size greater then or equal to <min>.
5979    
5980       CREATED='[<date-after>]..[<date-before>]'
5981    
5982          Restricts the search to instruments, which creation date satisfies
5983          the specified period, where <date-after> and <date-before> are in
5984          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5985          search is restricted to instruments created before <date-before>.
5986          If <date-before> is omitted, the search is restricted to
5987          instruments created after <date-after>.
5988    
5989    
5990    
5991    Schoenebeck               Expires June 9, 2009                [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol        December 2008
5994    
5995    
5996       MODIFIED='[<date-after>]..[<date-before>]'
5997    
5998          Restricts the search to instruments, which date of last
5999          modification satisfies the specified period, where <date-after>
6000          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
6001          after> is omitted the search is restricted to instruments, which
6002          are last modified before <date-before>.  If <date-before> is
6003          omitted, the search is restricted to instruments, which are last
6004          modified after <date-after>.
6005    
6006       DESCRIPTION='<search-string>'
6007    
6008          Restricts the search to instruments with description that
6009          satisfies the supplied search string (encapsulated into
6010          apostrophes, supporting escape sequences as described in chapter
6011          "Character Set and Escape Sequences (Section 7.1)").
6012    
6013       PRODUCT='<search-string>'
6014    
6015          Restricts the search to instruments with product info that
6016          satisfies the supplied search string (encapsulated into
6017          apostrophes, supporting escape sequences as described in chapter
6018          "Character Set and Escape Sequences (Section 7.1)").
6019    
6020       ARTISTS='<search-string>'
6021    
6022          Restricts the search to instruments with artists info that
6023          satisfies the supplied search string (encapsulated into
6024          apostrophes, supporting escape sequences as described in chapter
6025          "Character Set and Escape Sequences (Section 7.1)").
6026    
6027       KEYWORDS='<search-string>'
6028    
6029          Restricts the search to instruments with keyword list that
6030          satisfies the supplied search string (encapsulated into
6031          apostrophes, supporting escape sequences as described in chapter
6032          "Character Set and Escape Sequences (Section 7.1)").
6033    
6034       IS_DRUM=true | false
6035    
6036          Either true or false.  Restricts the search to drum kits or
6037          chromatic instruments.
6038    
6039       FORMAT_FAMILIES='<format-list>'
6040    
6041          Restricts the search to instruments of the supplied format
6042          families, where <format-list> is a comma separated list of format
6043          families.
6044    
6045    
6046    
6047    Schoenebeck               Expires June 9, 2009                [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol        December 2008
6050    
6051    
6052       Where <search-string> is either a regular expression, or a word list
6053       separated with spaces for OR search and with '+' for AND search.
6054    
6055       Possible Answers:
6056    
6057          A comma separated list with the absolute path names (encapsulated
6058          into apostrophes) of all instruments in the specified directory
6059          that satisfy the supplied search criterias.
6060    
6061          "ERR:<error-code>:<error-message>" -
6062    
6063             if the given directory does not exist.
6064    
6065       Example:
6066    
6067          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
6068          290'"
6069    
6070          S: "'/Piano Collection/Bosendorfer 290'"
6071    
6072          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
6073          09:30:13..'"
6074    
6075          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6076          Steinway D'"
6077    
6078    6.8.21.  Getting job status information
6079    
6080       The front-end can ask for the current status of a particular database
6081       instruments job by sending the following command:
6082    
6083          GET DB_INSTRUMENTS_JOB INFO <job-id>
6084    
6085       Where <job-id> should be replaced by the numerical ID of the job the
6086       front-end is interested in.
6087    
6088       Possible Answers:
6089    
6090          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6091          answer line begins with the settings category name followed by a
6092          colon and then a space character <SP> and finally the info
6093          character string to that setting category.  At the moment the
6094          following categories are defined:
6095    
6096    
6097    
6098             FILES_TOTAL -
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires June 9, 2009                [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol        December 2008
6106    
6107    
6108                The total number of files scheduled for scanning
6109    
6110             FILES_SCANNED -
6111    
6112                The current number of scanned files
6113    
6114             SCANNING -
6115    
6116                The absolute path name of the file which is currently being
6117                scanned
6118    
6119             STATUS -
6120    
6121                An integer value between 0 and 100 indicating the scanning
6122                progress percentage of the file which is currently being
6123                scanned
6124    
6125       The mentioned fields above don't have to be in particular order.
6126    
6127       Example:
6128    
6129          C: "GET DB_INSTRUMENTS_JOB INFO 2"
6130    
6131          S: "FILES_TOTAL: 12"
6132    
6133             "FILES_SCANNED: 7"
6134    
6135             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
6136    
6137             "STATUS: 42"
6138    
6139             "."
6140    
6141    6.8.22.  Formatting the instruments database
6142    
6143       The front-end can remove all instruments and directories and re-
6144       create the instruments database structure (e.g., in case of a
6145       database corruption) by sending the following command:
6146    
6147          FORMAT INSTRUMENTS_DB
6148    
6149       Possible Answers:
6150    
6151          "OK" -
6152    
6153             on success
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires June 9, 2009                [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol        December 2008
6162    
6163    
6164          "ERR:<error-code>:<error-message>" -
6165    
6166             If the formatting of the instruments database failed.
6167    
6168    6.8.23.  Checking for lost instrument files
6169    
6170       The front-end can retrieve the list of all instrument files in the
6171       instruments database that don't exist in the filesystem by sending
6172       the following command:
6173    
6174          FIND LOST DB_INSTRUMENT_FILES
6175    
6176       Possible Answers:
6177    
6178          A comma separated list with the absolute path names (encapsulated
6179          into apostrophes) of all lost instrument files.
6180    
6181          "ERR:<error-code>:<error-message>" -
6182    
6183             in case it failed, providing an appropriate error code and
6184             error message.
6185    
6186       Example:
6187    
6188          C: "FIND LOST DB_INSTRUMENT_FILES"
6189    
6190          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6191          Piano.gig'"
6192    
6193    6.8.24.  Replacing an instrument file
6194    
6195       The front-end can substitute all occurrences of an instrument file in
6196       the instruments database with a new one by sending the following
6197       command:
6198    
6199          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6200    
6201       Where <old_path> is the absolute path name of the instrument file to
6202       substitute with <new_path>.
6203    
6204       Possible Answers:
6205    
6206          "OK" -
6207    
6208             on success
6209    
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires June 9, 2009                [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol        December 2008
6218    
6219    
6220          "ERR:<error-code>:<error-message>" -
6221    
6222             in case it failed, providing an appropriate error code and
6223             error message.
6224    
6225       Example:
6226    
6227          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6228          '/gigs/pianos/Bosendorfer 290.gig'"
6229    
6230          S: "OK"
6231    
6232    6.9.  Editing Instruments
6233    
6234       The sampler allows to edit instruments while playing with the sampler
6235       by spawning an external (3rd party) instrument editor application for
6236       a given instrument.  The 3rd party instrument editor applications
6237       have to place a respective plugin DLL file into the sampler's plugins
6238       directory.  The sampler will automatically try to load all plugin
6239       DLLs in that directory on startup and only on startup!
6240    
6241       At the moment there is only one command for this feature set, but
6242       this will most probably change in future.
6243    
6244    6.9.1.  Opening an appropriate instrument editor application
6245    
6246       The front-end can request to open an appropriate instrument editor
6247       application by sending the following command:
6248    
6249          EDIT CHANNEL INSTRUMENT <sampler-channel>
6250    
6251       Where <sampler-channel> should be replaced by the number of the
6252       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
6253       "LIST CHANNELS" (Section 6.4.4) command.
6254    
6255       The sampler will try to ask all registered instrument editors (or to
6256       be more specific: their sampler plugins) whether they are capable to
6257       handle the instrument on the given sampler channel.  The sampler will
6258       simply use the first instrument editor application which replied with
6259       a positive answer and spawn that instrument editor application within
6260       the sampler's process and provide that application access to the
6261       instrument's data structures, so both applications can share and
6262       access the same instruments data at the same time, thus allowing to
6263       immediately hear changes with the sampler made by the instrument
6264       editor.
6265    
6266       Note: consequently instrument editors are always spawned locally on
6267       the same machine where the sampler is running on!
6268    
6269    
6270    
6271    Schoenebeck               Expires June 9, 2009                [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol        December 2008
6274    
6275    
6276       Possible Answers:
6277    
6278          "OK" -
6279    
6280             when an appropriate instrument editor was launched
6281    
6282          "WRN:<warning-code>:<warning-message>" -
6283    
6284             when an appropriate instrument editor was launched, but there
6285             are noteworthy issues
6286    
6287          "ERR:<error-code>:<error-message>" -
6288    
6289             when an appropriate instrument editor could not be launched
6290    
6291       Examples:
6292    
6293          C: "EDIT CHANNEL INSTRUMENT 0"
6294    
6295          S: "OK"
6296    
6297    6.10.  Managing Files
6298    
6299       You can query detailed informations about files located at the same
6300       system where the sampler instance is running on.  Using this command
6301       set allows to retrieve file informations even remotely from another
6302       machine.
6303    
6304    6.10.1.  Retrieving amount of instruments of a file
6305    
6306       The front-end can retrieve the amount of instruments within a given
6307       instrument file by sending the following command:
6308    
6309          GET FILE INSTRUMENTS <filename>
6310    
6311       Where <filename> is the name of the instrument file (encapsulated
6312       into apostrophes, supporting escape sequences as described in chapter
6313       "Character Set and Escape Sequences (Section 7.1)").
6314    
6315       The sampler will try to ask all sampler engines, whether they support
6316       the given file and ask the first engine with a positive answer for
6317       the amount of instruments.
6318    
6319       Possible Answers:
6320    
6321          On success, the sampler will answer by returning the amount of
6322          instruments.
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires June 9, 2009                [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol        December 2008
6330    
6331    
6332          "ERR:<error-code>:<error-message>" -
6333    
6334             if the file could not be handled
6335    
6336       Examples:
6337    
6338          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6339    
6340          S: "10"
6341    
6342    6.10.2.  Retrieving all instruments of a file
6343    
6344       The front-end can retrieve a list of all instruments within a given
6345       instrument file by sending the following command:
6346    
6347          LIST FILE INSTRUMENTS <filename>
6348    
6349       Where <filename> is the name of the instrument file (encapsulated
6350       into apostrophes, supporting escape sequences as described in chapter
6351       "Character Set and Escape Sequences (Section 7.1)").
6352    
6353       The sampler will try to ask all sampler engines, whether they support
6354       the given file and ask the first engine with a positive answer for a
6355       list of IDs for the instruments in the given file.
6356    
6357       Possible Answers:
6358    
6359          On success, the sampler will answer by returning a comma separated
6360          list of instrument IDs.
6361    
6362          "ERR:<error-code>:<error-message>" -
6363    
6364             if the file could not be handled
6365    
6366       Examples:
6367    
6368          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6369    
6370          S: "0,1,2,3,4,5,6,7,8,9"
6371    
6372    6.10.3.  Retrieving informations about one instrument in a file
6373    
6374       The front-end can retrieve detailed informations about a specific
6375       instrument within a given instrument file by sending the following
6376       command:
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires June 9, 2009                [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol        December 2008
6386    
6387    
6388          GET FILE INSTRUMENT INFO <filename> <instr-id>
6389    
6390       Where <filename> is the name of the instrument file (encapsulated
6391       into apostrophes, supporting escape sequences as described in chapter
6392       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6393       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6394       (Section 6.10.2) command.
6395    
6396       The sampler will try to ask all sampler engines, whether they support
6397       the given file and ask the first engine with a positive answer for
6398       informations about the specific instrument in the given file.
6399    
6400       Possible Answers:
6401    
6402          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6403          answer line begins with the settings category name followed by a
6404          colon and then a space character <SP> and finally the info
6405          character string to that setting category.  At the moment the
6406          following categories are defined:
6407    
6408    
6409    
6410             NAME -
6411    
6412                name of the instrument as stored in the instrument file
6413    
6414             FORMAT_FAMILY -
6415    
6416                name of the sampler format of the given instrument
6417    
6418             FORMAT_VERSION -
6419    
6420                version of the sampler format the instrumen is stored as
6421    
6422             PRODUCT -
6423    
6424                official product name of the instrument as stored in the
6425                file
6426    
6427             ARTISTS -
6428    
6429                artists / sample library vendor of the instrument
6430    
6431             KEY_BINDINGS -
6432    
6433                comma separated list of integer values representing the
6434                instrument's key mapping in the range between 0 .. 127,
6435                reflecting the analog meaning of the MIDI specification.
6436    
6437    
6438    
6439    Schoenebeck               Expires June 9, 2009                [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol        December 2008
6442    
6443    
6444             KEYSWITCH_BINDINGS -
6445    
6446                comma separated list of integer values representing the
6447                instrument's keyswitch mapping in the range between 0 ..
6448                127, reflecting the analog meaning of the MIDI
6449                specification.
6450    
6451       The mentioned fields above don't have to be in particular order.
6452    
6453       Example:
6454    
6455          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6456    
6457          S: "NAME: Lunatic Loops"
6458    
6459             "FORMAT_FAMILY: GIG"
6460    
6461             "FORMAT_VERSION: 3"
6462    
6463             "PRODUCT: The Backbone Bongo Beats"
6464    
6465             "ARTISTS: Jimmy the Fish"
6466    
6467             "."
6468    
6469    
6470    
6471    
6472    
6473    
6474    
6475    
6476    
6477    
6478    
6479    
6480    
6481    
6482    
6483    
6484    
6485    
6486    
6487    
6488    
6489    
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires June 9, 2009                [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol        December 2008
6498    
6499    
6500  7.  Command Syntax  7.  Command Syntax
# Line 4644  Internet-Draft        LinuxSampler Contr Line 6548  Internet-Draft        LinuxSampler Contr
6548    
6549    
6550    
6551  Schoenebeck               Expires July 2, 2007                 [Page 83]  Schoenebeck               Expires June 9, 2009                [Page 117]
6552    
6553  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
6554    
6555    
6556        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4661  Internet-Draft        LinuxSampler Contr Line 6565  Internet-Draft        LinuxSampler Contr
6565    
6566        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
6567    
       / SELECT SP text  
   
6568        / RESET SP reset_instruction        / RESET SP reset_instruction
6569    
6570        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
6571    
6572          / FIND SP find_instruction
6573    
6574          / MOVE SP move_instruction
6575    
6576          / COPY SP copy_instruction
6577    
6578          / EDIT SP edit_instruction
6579    
6580          / FORMAT SP format_instruction
6581    
6582          / SEND SP send_instruction
6583    
6584        / RESET        / RESET
6585    
6586        / QUIT        / QUIT
# Line 4675  Internet-Draft        LinuxSampler Contr Line 6589  Internet-Draft        LinuxSampler Contr
6589    
6590        CHANNEL        CHANNEL
6591    
6592          / DB_INSTRUMENT_DIRECTORY SP db_path
6593    
6594          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6595    
6596          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
6597          db_path SP filename
6598    
6599          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6600    
6601          / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
6602          filename
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires June 9, 2009                [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol        December 2008
6610    
6611    
6612          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6613    
6614          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6615          instrument_index
6616    
6617          / DB_INSTRUMENTS SP db_path SP filename
6618    
6619          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6620    
6621        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
6622    
6623        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 4691  Internet-Draft        LinuxSampler Contr Line 6634  Internet-Draft        LinuxSampler Contr
6634    
6635        / CHANNEL_COUNT        / CHANNEL_COUNT
6636    
6637          / CHANNEL_MIDI
6638    
6639          / DEVICE_MIDI
6640    
6641        / VOICE_COUNT        / VOICE_COUNT
6642    
6643        / STREAM_COUNT        / STREAM_COUNT
6644    
6645        / BUFFER_FILL        / BUFFER_FILL
6646    
6647          / CHANNEL_INFO
6648    
6649          / FX_SEND_COUNT
6650    
6651          / FX_SEND_INFO
 Schoenebeck               Expires July 2, 2007                 [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       / CHANNEL_INFO  
6652    
6653        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
6654    
# Line 4713  Internet-Draft        LinuxSampler Contr Line 6656  Internet-Draft        LinuxSampler Contr
6656    
6657        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires June 9, 2009                [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol        December 2008
6666    
6667    
6668        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
6669    
6670          / DB_INSTRUMENT_DIRECTORY_COUNT
6671    
6672          / DB_INSTRUMENT_DIRECTORY_INFO
6673    
6674          / DB_INSTRUMENT_COUNT
6675    
6676          / DB_INSTRUMENT_INFO
6677    
6678          / DB_INSTRUMENTS_JOB_INFO
6679    
6680        / MISCELLANEOUS        / MISCELLANEOUS
6681    
6682          / TOTAL_STREAM_COUNT
6683    
6684        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6685    
6686          / GLOBAL_INFO
6687    
6688     unsubscribe_event =     unsubscribe_event =
6689    
6690        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 4731  Internet-Draft        LinuxSampler Contr Line 6697  Internet-Draft        LinuxSampler Contr
6697    
6698        / CHANNEL_COUNT        / CHANNEL_COUNT
6699    
6700          / CHANNEL_MIDI
6701    
6702          / DEVICE_MIDI
6703    
6704        / VOICE_COUNT        / VOICE_COUNT
6705    
6706        / STREAM_COUNT        / STREAM_COUNT
# Line 4739  Internet-Draft        LinuxSampler Contr Line 6709  Internet-Draft        LinuxSampler Contr
6709    
6710        / CHANNEL_INFO        / CHANNEL_INFO
6711    
6712          / FX_SEND_COUNT
6713    
6714          / FX_SEND_INFO
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires June 9, 2009                [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol        December 2008
6722    
6723    
6724        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
6725    
6726        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 4747  Internet-Draft        LinuxSampler Contr Line 6729  Internet-Draft        LinuxSampler Contr
6729    
6730        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
6731    
6732        / MISCELLANEOUS        / DB_INSTRUMENT_DIRECTORY_COUNT
6733    
6734        / TOTAL_VOICE_COUNT        / DB_INSTRUMENT_DIRECTORY_INFO
6735    
6736     map_instruction =        / DB_INSTRUMENT_COUNT
6737    
6738          / DB_INSTRUMENT_INFO
6739    
6740          / DB_INSTRUMENTS_JOB_INFO
6741    
6742          / MISCELLANEOUS
6743    
6744  Schoenebeck               Expires July 2, 2007                 [Page 85]        / TOTAL_STREAM_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6745    
6746          / TOTAL_VOICE_COUNT
6747    
6748          / GLOBAL_INFO
6749    
6750        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP     map_instruction =
6751    
6752          MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
6753        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
6754    
6755        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6756        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6757        instr_load_mode        instr_load_mode
6758    
6759        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6760        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6761        entry_name        entry_name
6762    
6763        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6764        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6765        instr_load_mode SP entry_name        instr_load_mode SP entry_name
6766    
6767     unmap_instruction =     unmap_instruction =
# Line 4782  Internet-Draft        LinuxSampler Contr Line 6770  Internet-Draft        LinuxSampler Contr
6770    
6771     remove_instruction =     remove_instruction =
6772    
6773    
6774    
6775    Schoenebeck               Expires June 9, 2009                [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol        December 2008
6778    
6779    
6780        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6781    
6782        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
6783    
6784        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6785    
6786          / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6787    
6788          / DB_INSTRUMENT_DIRECTORY SP db_path
6789    
6790          / DB_INSTRUMENT SP db_path
6791    
6792     get_instruction =     get_instruction =
6793    
6794        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4810  Internet-Draft        LinuxSampler Contr Line 6811  Internet-Draft        LinuxSampler Contr
6811        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6812        key_val_list        key_val_list
6813    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6814        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
6815    
6816        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 4831  Internet-Draft        LinuxSampler Contr Line 6825  Internet-Draft        LinuxSampler Contr
6825    
6826        / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number        / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6827    
6828    
6829    
6830    
6831    Schoenebeck               Expires June 9, 2009                [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol        December 2008
6834    
6835    
6836        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6837        string        string
6838    
# Line 4848  Internet-Draft        LinuxSampler Contr Line 6850  Internet-Draft        LinuxSampler Contr
6850    
6851        / SERVER SP INFO        / SERVER SP INFO
6852    
6853          / TOTAL_STREAM_COUNT
6854    
6855        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6856    
6857        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
# Line 4864  Internet-Draft        LinuxSampler Contr Line 6868  Internet-Draft        LinuxSampler Contr
6868    
6869        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6870    
6871          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6872    
6873          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6874    
6875          / DB_INSTRUMENT_DIRECTORIES SP db_path
6876    
6877          / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6878    
6879          / DB_INSTRUMENTS SP RECURSIVE SP db_path
6880    
6881          / DB_INSTRUMENTS SP db_path
6882    
6883  Schoenebeck               Expires July 2, 2007                 [Page 87]  
6884    
6885    
6886    
6887    Schoenebeck               Expires June 9, 2009                [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
6890    
6891    
6892        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / DB_INSTRUMENT SP INFO SP db_path
6893    
6894          / DB_INSTRUMENTS_JOB SP INFO SP number
6895    
6896        / VOLUME        / VOLUME
6897    
6898          / VOICES
6899    
6900          / STREAMS
6901    
6902          / FILE SP INSTRUMENTS SP filename
6903    
6904          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6905    
6906     set_instruction =     set_instruction =
6907    
6908        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 4888  Internet-Draft        LinuxSampler Contr Line 6914  Internet-Draft        LinuxSampler Contr
6914        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6915        param_val_list        param_val_list
6916    
6917          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6918    
6919        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6920        param_val_list        param_val_list
6921    
# Line 4895  Internet-Draft        LinuxSampler Contr Line 6923  Internet-Draft        LinuxSampler Contr
6923    
6924        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6925    
6926          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6927    
6928        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6929        SP audio_channel_index SP audio_channel_index        SP audio_channel_index SP audio_channel_index
6930    
6931          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
6932          midi_ctrl
6933    
6934          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6935          volume_value
6936    
6937          / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires June 9, 2009                [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol        December 2008
6946    
6947    
6948          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6949          stringval_escaped
6950    
6951          / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6952    
6953          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6954    
6955          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6956    
6957        / ECHO SP boolean        / ECHO SP boolean
6958    
6959        / VOLUME SP volume_value        / VOLUME SP volume_value
6960    
6961          / VOICES SP number
6962    
6963          / STREAMS SP number
6964    
6965     create_instruction =     create_instruction =
6966    
6967        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4922  Internet-Draft        LinuxSampler Contr Line 6982  Internet-Draft        LinuxSampler Contr
6982    
6983     clear_instruction =     clear_instruction =
6984    
6985          MIDI_INSTRUMENTS SP midi_map
6986    
6987          / MIDI_INSTRUMENTS SP ALL
6988    
6989       find_instruction =
6990    
6991          DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6992    
6993          / DB_INSTRUMENTS SP db_path SP query_val_list
6994    
6995    
6996    
6997    
6998    
6999  Schoenebeck               Expires July 2, 2007                 [Page 88]  Schoenebeck               Expires June 9, 2009                [Page 125]
7000    
7001  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
7002    
7003    
7004        MIDI_INSTRUMENTS SP midi_map        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
7005          query_val_list
7006    
7007        / MIDI_INSTRUMENTS SP ALL        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
7008    
7009          / LOST SP DB_INSTRUMENT_FILES
7010    
7011       move_instruction =
7012    
7013          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
7014    
7015          / DB_INSTRUMENT SP db_path SP db_path
7016    
7017       copy_instruction =
7018    
7019          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
7020    
7021          / DB_INSTRUMENT SP db_path SP db_path
7022    
7023     destroy_instruction =     destroy_instruction =
7024    
# Line 4961  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires June 9, 2009                [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol        December 2008
7058    
7059    
7060        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
7061    
7062        / MIDI_INPUT_CHANNEL SP sampler_channel SP        / MIDI_INPUT_CHANNEL SP sampler_channel SP
# Line 4976  Internet-Draft        LinuxSampler Contr Line 7072  Internet-Draft        LinuxSampler Contr
7072    
7073        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7074    
7075          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7076    
7077          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
7078    
7079       edit_instruction =
7080    
7081          CHANNEL SP INSTRUMENT SP sampler_channel
7082    
7083  Schoenebeck               Expires July 2, 2007                 [Page 89]     format_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
7084    
7085          INSTRUMENTS_DB
7086    
7087        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE     modal_arg =
7088    
7089        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        /* epsilon (empty argument) */
7090    
7091          / NON_MODAL SP
7092    
7093     key_val_list =     key_val_list =
7094    
# Line 5003  Internet-Draft        LinuxSampler Contr Line 7104  Internet-Draft        LinuxSampler Contr
7104    
7105     list_instruction =     list_instruction =
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires June 9, 2009                [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol        December 2008
7114    
7115    
7116        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
7117    
7118        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 5023  Internet-Draft        LinuxSampler Contr Line 7133  Internet-Draft        LinuxSampler Contr
7133    
7134        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
7135    
7136          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
7137    
7138          / DB_INSTRUMENT_DIRECTORIES SP db_path
7139    
7140          / DB_INSTRUMENTS SP RECURSIVE SP db_path
7141    
7142          / DB_INSTRUMENTS SP db_path
7143    
7144          / FILE SP INSTRUMENTS SP filename
7145    
7146       send_instruction =
7147    
7148          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
7149          number
7150    
7151     load_instr_args =     load_instr_args =
7152    
7153        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 5033  Internet-Draft        LinuxSampler Contr Line 7158  Internet-Draft        LinuxSampler Contr
7158    
7159        engine_name SP sampler_channel        engine_name SP sampler_channel
7160    
7161       instr_load_mode =
7162    
7163    
7164    
 Schoenebeck               Expires July 2, 2007                 [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
7165    
7166    
7167     instr_load_mode =  Schoenebeck               Expires June 9, 2009                [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol        December 2008
7170    
7171    
7172        ON_DEMAND        ON_DEMAND
7173    
# Line 5089  Internet-Draft        LinuxSampler Contr Line 7215  Internet-Draft        LinuxSampler Contr
7215    
7216     midi_ctrl =     midi_ctrl =
7217    
7218          number
7219    
7220    
7221    
 Schoenebeck               Expires July 2, 2007                 [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
7222    
7223    Schoenebeck               Expires June 9, 2009                [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol        December 2008
7226    
       number  
7227    
7228     volume_value =     volume_value =
7229    
# Line 5123  Internet-Draft        LinuxSampler Contr Line 7249  Internet-Draft        LinuxSampler Contr
7249    
7250     filename =     filename =
7251    
7252        stringval        path
7253    
7254       db_path =
7255    
7256          path
7257    
7258     map_name =     map_name =
7259    
7260        stringval        stringval_escaped
7261    
7262     entry_name =     entry_name =
7263    
7264        stringval        stringval_escaped
7265    
7266     fx_send_name =     fx_send_name =
7267    
7268        stringval        stringval_escaped
7269    
7270     param_val_list =     param_val_list =
7271    
# Line 5143  Internet-Draft        LinuxSampler Contr Line 7273  Internet-Draft        LinuxSampler Contr
7273    
7274        / param_val_list','param_val        / param_val_list','param_val
7275    
    param_val =  
   
7276    
7277    
7278    
7279  Schoenebeck               Expires July 2, 2007                 [Page 92]  Schoenebeck               Expires June 9, 2009                [Page 130]
7280    
7281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
7282    
7283    
7284       param_val =
7285    
7286        string        string
7287    
7288        / stringval        / stringval
# Line 5161  Internet-Draft        LinuxSampler Contr Line 7291  Internet-Draft        LinuxSampler Contr
7291    
7292        / dotnum        / dotnum
7293    
7294       query_val_list =
7295    
7296          string '=' query_val
7297    
7298          / query_val_list SP string '=' query_val
7299    
7300       query_val =
7301    
7302          text_escaped
7303    
7304          / stringval_escaped
7305    
7306       scan_mode =
7307    
7308          RECURSIVE
7309    
7310          / NON_RECURSIVE
7311    
7312          / FLAT
7313    
7314    7.1.  Character Set and Escape Sequences
7315    
7316       Older versions of this protocol up to and including v1.1 only
7317       supported the standard ASCII character set (ASCII code 0 - 127)
7318       [RFC20], all younger versions of this protocol however support the
7319       Extended ASCII character set (ASCII code 0 - 255).  The same group of
7320       younger protocols also support escape sequences, but only for
7321       certain, explicitly declared parts of the protocol.  The supported
7322       escape sequences are defined as follows:
7323    
7324    
7325    
# Line 5184  Internet-Draft        LinuxSampler Contr Line 7332  Internet-Draft        LinuxSampler Contr
7332    
7333    
7334    
7335    Schoenebeck               Expires June 9, 2009                [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol        December 2008
7338    
7339    
7340       +------------------------+------------------------------------------+
7341       | ASCII Character        | Translated into (Name)                   |
7342       | Sequence               |                                          |
7343       +------------------------+------------------------------------------+
7344       | \n                     | new line                                 |
7345       |                        |                                          |
7346       | \r                     | carriage return                          |
7347       |                        |                                          |
7348       | \f                     | form feed                                |
7349       |                        |                                          |
7350       | \t                     | horizontal tab                           |
7351       |                        |                                          |
7352       | \v                     | vertical tab                             |
7353       |                        |                                          |
7354       | \'                     | apostrophe                               |
7355       |                        |                                          |
7356       | \"                     | quotation mark                           |
7357       |                        |                                          |
7358       | \\                     | backslash                                |
7359       |                        |                                          |
7360       | \OOO                   | three digit octal ASCII code of the      |
7361       |                        | character                                |
7362       |                        |                                          |
7363       | \xHH                   | two digit hex ASCII code of the          |
7364       |                        | character                                |
7365       +------------------------+------------------------------------------+
7366    
7367       Notice: due to the transition of certain parts of the protocol which
7368       now support escape sequences, a slight backward incompatibility to
7369       protocols version v1.1 and younger has been introduced.  The only
7370       difference is that in parts of the protocol where escape characters
7371       are now supported, a backslash characters MUST be escaped as well
7372       (that is as double backslash), whereas in the old versions a single
7373       backslash was sufficient.
7374    
7375       The following LSCP commands support escape sequences as part of their
7376       filename / path based arguments and / or may contain a filename /
7377       path with escape sequences in their response:
7378    
7379          "LOAD INSTRUMENT" (Section 6.4.1)
7380    
7381          "GET CHANNEL INFO" (Section 6.4.10)
7382    
7383          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7384    
7385          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires June 9, 2009                [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol        December 2008
7394    
7395    
7396          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7397    
7398          "ADD DB_INSTRUMENTS" (Section 6.8.11)
7399    
7400          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
7401    
7402          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
7403    
7404          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
7405    
7406          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
7407    
7408          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7409    
7410          "GET DB_INSTRUMENTS" (Section 6.8.13)
7411    
7412          "LIST DB_INSTRUMENTS" (Section 6.8.14)
7413    
7414          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7415    
7416          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7417    
7418          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7419    
7420  Schoenebeck               Expires July 2, 2007                 [Page 93]        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7421    
7422          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7423    
7424          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7425    
7426          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7427    
7428          "MOVE DB_INSTRUMENT" (Section 6.8.17)
7429    
7430          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
7431    
7432          "COPY DB_INSTRUMENT" (Section 6.8.18)
7433    
7434          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
7435    
7436          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
7437    
7438          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
7439    
7440          "GET FILE INSTRUMENTS" (Section 6.10.1)
7441    
7442          "LIST FILE INSTRUMENTS" (Section 6.10.2)
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires June 9, 2009                [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol        December 2008
7450    
7451    
7452          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7453    
7454       Note that the forward slash character ('/') has a special meaning in
7455       filename / path based arguments: it acts as separator of the nodes in
7456       the path, thus if a directory- or filename includes a forward slash
7457       (not intended as path node separator), you MUST escape that slash
7458       either with the respective hex escape sequence ("\x2f") or with the
7459       respective octal escape sequence ("\057").
7460    
7461       Note for Windows: file path arguments in LSCP are expected to use
7462       forward slashes as directory node separator similar to Unix based
7463       operating systems.  In contrast to Unix however a Windows typical
7464       drive character is expected to be prefixed to the path.  That is an
7465       original Windows file path like "D:\Sounds\My.gig" would become in
7466       LSCP: "D:/Sounds/My.gig".
7467    
7468       The following LSCP commands even support escape sequences as part of
7469       at least one of their text-based arguments (i.e. entity name,
7470       description) and / or may contain escape sequences in at least one of
7471       their text-based fields in their response:
7472    
7473          "GET SERVER INFO" (Section 6.6.5)
7474    
7475          "GET ENGINE INFO" (Section 6.4.9)
7476    
7477          "GET CHANNEL INFO" (Section 6.4.10)
7478    
7479          "CREATE FX_SEND" (Section 6.4.25)
7480    
7481          "GET FX_SEND INFO" (Section 6.4.29)
7482    
7483          "SET FX_SEND NAME" (Section 6.4.30)
7484    
7485          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7486    
7487          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
7488    
7489          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
7490    
7491          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7492    
7493          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
7494    
7495          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7496    
7497          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7498    
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires June 9, 2009                [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol        December 2008
7506    
7507    
7508          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7509    
7510          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7511    
7512          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7513    
7514          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7515    
7516          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7517    
7518          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7519    
7520       Please note that these lists are manually maintained.  If you find a
7521       command that also supports escape sequences we forgot to mention
7522       here, please report it!
7523    
7524    
7525    
7526    
7527    
7528    
7529    
7530    
7531    
7532    
7533    
7534    
7535    
7536    
7537    
7538    
7539    
7540    
7541    
7542    
7543    
7544    
7545    
7546    
7547    
7548    
7549    
7550    
7551    
7552    
7553    
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck               Expires June 9, 2009                [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
7562    
7563    
7564  8.  Events  8.  Events
# Line 5260  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck               Expires July 2, 2007                 [Page 94]  Schoenebeck               Expires June 9, 2009                [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
7618    
7619    
7620        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 5303  Internet-Draft        LinuxSampler Contr Line 7655  Internet-Draft        LinuxSampler Contr
7655     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
7656     channels.     channels.
7657    
7658  8.6.  Number of active voices changed  8.6.  MIDI data on a sampler channel arrived
7659    
7660     Client may want to be notified when the number of voices on the back-     Client may want to be notified when MIDI data arrive on sampler
7661     end changes by issuing the following command:     channels on back-end side, by issuing the following command:
7662    
7663        SUBSCRIBE VOICE_COUNT        SUBSCRIBE CHANNEL_MIDI
7664    
7665       Server will start sending one of the the following notification
7666       messages:
7667    
    Server will start sending the following notification messages:  
7668    
7669    
7670    
7671    Schoenebeck               Expires June 9, 2009                [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol        December 2008
7674    
7675    
7676          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
7677    
7678          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"
7679    
7680  Schoenebeck               Expires July 2, 2007                 [Page 95]     where <channel-id> will be replaced by the ID of the sampler channel
7681       where the MIDI data arrived. <note> and <velocity> are integer values
7682       in the range between 0 .. 127, reflecting the analog meaning of the
7683       MIDI specification.
7684    
7685       CAUTION: no guarantee whatsoever will be made that MIDI events are
7686       actually all delivered by this mechanism!  With other words: events
7687       could be lost at any time!  This restriction was made to keep the RT-
7688       safeness of the backend's MIDI and audio thread unaffected by this
7689       feature.
7690    
7691    8.7.  MIDI data on a MIDI input device arrived
7692    
7693       Client may want to be notified when MIDI data arrive on MIDI input
7694       devices by issuing the following command:
7695    
7696          SUBSCRIBE DEVICE_MIDI
7697    
7698       Server will start sending one of the the following notification
7699       messages:
7700    
7701          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
7702          <velocity>"
7703    
7704          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
7705          <velocity>"
7706    
7707       where <device-id> <port-id> will be replaced by the IDs of the
7708       respective MIDI input device and the device's MIDI port where the
7709       MIDI data arrived. <note> and <velocity> are integer values in the
7710       range between 0 .. 127, reflecting the analog meaning of the MIDI
7711       specification.
7712    
7713       CAUTION: no guarantee whatsoever will be made that MIDI events are
7714       actually all delivered by this mechanism!  With other words: events
7715       could be lost at any time!  This restriction was made to keep the RT-
7716       safeness of the backend's MIDI and audio thread unaffected by this
7717       feature.
7718    
7719    8.8.  Number of active voices changed
7720    
7721       Client may want to be notified when the number of voices on the back-
7722       end changes by issuing the following command:
7723    
7724    
7725    
7726    
7727    Schoenebeck               Expires June 9, 2009                [Page 138]
7728    
7729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
7730    
7731    
7732          SUBSCRIBE VOICE_COUNT
7733    
7734       Server will start sending the following notification messages:
7735    
7736        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
7737    
7738     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
7739     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
7740     voices on that channel.     voices on that channel.
7741    
7742  8.7.  Number of active disk streams changed  8.9.  Number of active disk streams changed
7743    
7744     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
7745     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 5343  Internet-Draft        LinuxSampler Contr Line 7755  Internet-Draft        LinuxSampler Contr
7755     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
7756     active disk streams on that channel.     active disk streams on that channel.
7757    
7758  8.8.  Disk stream buffer fill state changed  8.10.  Disk stream buffer fill state changed
7759    
7760     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
7761     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 5360  Internet-Draft        LinuxSampler Contr Line 7772  Internet-Draft        LinuxSampler Contr
7772     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
7773     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
7774    
7775  8.9.  Channel information changed  8.11.  Channel information changed
7776    
7777     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
7778     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
7779    
       SUBSCRIBE CHANNEL_INFO  
7780    
    Server will start sending the following notification messages:  
7781    
7782    
7783    Schoenebeck               Expires June 9, 2009                [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol        December 2008
7786    
7787    
7788  Schoenebeck               Expires July 2, 2007                 [Page 96]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
7789    
7790       Server will start sending the following notification messages:
7791    
7792        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
7793    
# Line 5386  Internet-Draft        LinuxSampler Contr Line 7798  Internet-Draft        LinuxSampler Contr
7798     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
7799     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
7800    
7801  8.10.  Total number of active voices changed  8.12.  Number of effect sends changed
7802    
7803       Client may want to be notified when the number of effect sends on a
7804       particular sampler channel is changed by issuing the following
7805       command:
7806    
7807          SUBSCRIBE FX_SEND_COUNT
7808    
7809       Server will start sending the following notification messages:
7810    
7811          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
7812    
7813       where <channel-id> will be replaced by the numerical ID of the
7814       sampler channel, on which the effect sends number is changed and <fx-
7815       sends> will be replaced by the new number of effect sends on that
7816       channel.
7817    
7818    8.13.  Effect send information changed
7819    
7820       Client may want to be notified when changes were made to effect sends
7821       on a a particular sampler channel by issuing the following command:
7822    
7823          SUBSCRIBE FX_SEND_INFO
7824    
7825       Server will start sending the following notification messages:
7826    
7827          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
7828    
7829       where <channel-id> will be replaced by the numerical ID of the
7830       sampler channel, on which an effect send entity is changed and <fx-
7831       send-id> will be replaced by the numerical ID of the changed effect
7832       send.
7833    
7834    
7835    
7836    
7837    
7838    
7839    Schoenebeck               Expires June 9, 2009                [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol        December 2008
7842    
7843    
7844    8.14.  Total number of active voices changed
7845    
7846     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
7847     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 5395  Internet-Draft        LinuxSampler Contr Line 7850  Internet-Draft        LinuxSampler Contr
7850    
7851     Server will start sending the following notification messages:     Server will start sending the following notification messages:
7852    
7853        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
7854    
7855     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
7856     active voices.     active voices.
7857    
7858  8.11.  Number of MIDI instrument maps changed  8.15.  Total number of active disk streams changed
7859    
7860       Client may want to be notified when the total number of disk streams
7861       on the back-end changes by issuing the following command:
7862    
7863          SUBSCRIBE TOTAL_STREAM_COUNT
7864    
7865       Server will start sending the following notification messages:
7866    
7867          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
7868    
7869       where <streams> will be replaced by the new number of all currently
7870       active disk streams.
7871    
7872    8.16.  Number of MIDI instrument maps changed
7873    
7874     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7875     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 5414  Internet-Draft        LinuxSampler Contr Line 7883  Internet-Draft        LinuxSampler Contr
7883     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
7884     maps.     maps.
7885    
7886  8.12.  MIDI instrument map information changed  8.17.  MIDI instrument map information changed
7887    
7888     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7889     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
7890    
       SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO  
   
    Server will start sending the following notification messages:  
7891    
7892    
7893    
7894    
7895    Schoenebeck               Expires June 9, 2009                [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol        December 2008
7898    
7899    
7900  Schoenebeck               Expires July 2, 2007                 [Page 97]        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
7901    
7902       Server will start sending the following notification messages:
7903    
7904        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
7905    
# Line 5443  Internet-Draft        LinuxSampler Contr Line 7911  Internet-Draft        LinuxSampler Contr
7911     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
7912     message is sufficient here.     message is sufficient here.
7913    
7914  8.13.  Number of MIDI instruments changed  8.18.  Number of MIDI instruments changed
7915    
7916     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7917     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 5458  Internet-Draft        LinuxSampler Contr Line 7926  Internet-Draft        LinuxSampler Contr
7926     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
7927     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
7928    
7929  8.14.  MIDI instrument information changed  8.19.  MIDI instrument information changed
7930    
7931     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7932     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 5480  Internet-Draft        LinuxSampler Contr Line 7948  Internet-Draft        LinuxSampler Contr
7948    
7949    
7950    
7951    Schoenebeck               Expires June 9, 2009                [Page 142]
7952    
7953    Internet-Draft        LinuxSampler Control Protocol        December 2008
7954    
7955    
7956    8.20.  Global settings changed
7957    
7958       Client may want to be notified when changes to the global settings of
7959       the sampler were made by issuing the following command:
7960    
7961          SUBSCRIBE GLOBAL_INFO
7962    
7963       Server will start sending the following types of notification
7964       messages:
7965    
7966          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
7967          volume of the sampler is changed, where <volume> will be replaced
7968          by the optional dotted floating point value, reflecting the new
7969          global volume parameter.
7970    
7971          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
7972          golbal limit of the sampler for maximum voices is changed, where
7973          <max-voices> will be an integer value, reflecting the new global
7974          voice limit parameter.
7975    
7976          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
7977          golbal limit of the sampler for maximum disk streams is changed,
7978          where <max-streams> will be an integer value, reflecting the new
7979          global disk streams limit parameter.
7980    
7981    8.21.  Number of database instrument directories changed
7982    
7983       Client may want to be notified when the number of instrument
7984       directories in a particular directory in the instruments database is
7985       changed by issuing the following command:
7986    
7987          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
7988    
7989       Server will start sending the following notification messages:
7990    
7991          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
7992    
7993       where <dir-path> will be replaced by the absolute path name of the
7994       directory in the instruments database, in which the number of
7995       directories is changed.
7996    
7997       Note that when a non-empty directory is removed, this event is not
7998       sent for the subdirectories in that directory.
7999    
8000    8.22.  Database instrument directory information changed
8001    
8002       Client may want to be notified when changes were made to directories
8003       in the instruments database by issuing the following command:
8004    
8005    
8006    
8007    Schoenebeck               Expires June 9, 2009                [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol        December 2008
8010    
8011    
8012          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
8013    
8014       Server will start sending the following notification messages:
8015    
8016          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
8017    
8018       where <dir-path> will be replaced by the absolute path name of the
8019       directory, for which information changes occurred.  The front-end
8020       will have to send the respective command to actually get the updated
8021       directory info.  Because these messages will be triggered by LSCP
8022       commands issued by other clients rather than real time events
8023       happening on the server, it is believed that an empty notification
8024       message is sufficient here.
8025    
8026          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
8027          name>"
8028    
8029       where <old-dir-path> is the old absolute path name of the directory
8030       (encapsulated into apostrophes), which name is changes and <new-name>
8031       is the new name of the directory, encapsulated into apostrophes.
8032    
8033    8.23.  Number of database instruments changed
8034    
8035       Client may want to be notified when the number of instruments in a
8036       particular directory in the instruments database is changed by
8037       issuing the following command:
8038    
8039          SUBSCRIBE DB_INSTRUMENT_COUNT
8040    
8041       Server will start sending the following notification messages:
8042    
8043          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
8044    
8045       where <dir-path> will be replaced by the absolute path name of the
8046       directory in the instruments database, in which the number of
8047       instruments is changed.
8048    
8049       Note that when a non-empty directory is removed, this event is not
8050       sent for the instruments in that directory.
8051    
8052    8.24.  Database instrument information changed
8053    
8054       Client may want to be notified when changes were made to instruments
8055       in the instruments database by issuing the following command:
8056    
8057          SUBSCRIBE DB_INSTRUMENT_INFO
8058    
8059  Schoenebeck               Expires July 2, 2007                 [Page 98]     Server will start sending the following notification messages:
8060    
8061    
8062    
8063    Schoenebeck               Expires June 9, 2009                [Page 144]
8064    
8065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8066    
8067    
8068          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
8069    
8070       where <instr-path> will be replaced by the absolute path name of the
8071       instrument, which settings are changed.  The front-end will have to
8072       send the respective command to actually get the updated directory
8073       info.  Because these messages will be triggered by LSCP commands
8074       issued by other clients rather than real time events happening on the
8075       server, it is believed that an empty notification message is
8076       sufficient here.
8077    
8078          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
8079    
8080       where <old-instr-path> is the old absolute path name of the
8081       instrument (encapsulated into apostrophes), which name is changes and
8082       <new-name> is the new name of the instrument, encapsulated into
8083       apostrophes.
8084    
8085  8.15.  Miscellaneous and debugging events  8.25.  Database job status information changed
8086    
8087       Client may want to be notified when the status of particular database
8088       instruments job is changed by issuing the following command:
8089    
8090          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
8091    
8092       Server will start sending the following notification messages:
8093    
8094          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
8095    
8096       where <job-id> will be replaced by the numerical ID of the job, which
8097       status is changed.  The front-end will have to send the respective
8098       command to actually get the status info.  Because these messages will
8099       be triggered by LSCP commands issued by other clients rather than
8100       real time events happening on the server, it is believed that an
8101       empty notification message is sufficient here.
8102    
8103    8.26.  Miscellaneous and debugging events
8104    
8105     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
8106     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 5502  Internet-Draft        LinuxSampler Contr Line 8113  Internet-Draft        LinuxSampler Contr
8113    
8114     where <string> will be replaced by whatever data server wants to send     where <string> will be replaced by whatever data server wants to send
8115     to the client.  Client MAY display this data to the user AS IS to     to the client.  Client MAY display this data to the user AS IS to
8116    
8117    
8118    
8119    Schoenebeck               Expires June 9, 2009                [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol        December 2008
8122    
8123    
8124     facilitate debugging.     facilitate debugging.
8125    
8126    
# Line 5540  Internet-Draft        LinuxSampler Contr Line 8159  Internet-Draft        LinuxSampler Contr
8159    
8160    
8161    
8162  Schoenebeck               Expires July 2, 2007                 [Page 99]  
8163    
8164    
8165    
8166    
8167    
8168    
8169    
8170    
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires June 9, 2009                [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8178    
8179    
8180  9.  Security Considerations  9.  Security Considerations
# Line 5596  Internet-Draft        LinuxSampler Contr Line 8228  Internet-Draft        LinuxSampler Contr
8228    
8229    
8230    
8231  Schoenebeck               Expires July 2, 2007                [Page 100]  Schoenebeck               Expires June 9, 2009                [Page 147]
8232    
8233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8234    
8235    
8236  10.  Acknowledgments  10.  Acknowledgments
# Line 5652  Internet-Draft        LinuxSampler Contr Line 8284  Internet-Draft        LinuxSampler Contr
8284    
8285    
8286    
8287  Schoenebeck               Expires July 2, 2007                [Page 101]  Schoenebeck               Expires June 9, 2009                [Page 148]
8288    
8289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8290    
8291    
8292  11.  References  11.  References
8293    
8294       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
8295                  1969.
8296    
8297     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
8298                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
8299    
# Line 5705  Internet-Draft        LinuxSampler Contr Line 8340  Internet-Draft        LinuxSampler Contr
8340    
8341    
8342    
8343    Schoenebeck               Expires June 9, 2009                [Page 149]
   
   
 Schoenebeck               Expires July 2, 2007                [Page 102]  
8344    
8345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8346    
8347    
8348  Author's Address  Author's Address
# Line 5764  Author's Address Line 8396  Author's Address
8396    
8397    
8398    
8399  Schoenebeck               Expires July 2, 2007                [Page 103]  Schoenebeck               Expires June 9, 2009                [Page 150]
8400    
8401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2008
8402    
8403    
8404  Full Copyright Statement  Full Copyright Statement
8405    
8406     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2008).
8407    
8408     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
8409     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 5779  Full Copyright Statement Line 8411  Full Copyright Statement
8411    
8412     This document and the information contained herein are provided on an     This document and the information contained herein are provided on an
8413     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
8414     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
8415     ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,     THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
8416     INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE     OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
8417     INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED     THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
8418     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
8419    
8420    
# Line 5811  Intellectual Property Line 8443  Intellectual Property
8443     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
8444    
8445    
 Acknowledgment  
8446    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
8447    
8448    
8449    
8450    
8451    
8452  Schoenebeck               Expires July 2, 2007                [Page 104]  
8453    
8454    
8455    Schoenebeck               Expires June 9, 2009                [Page 151]
8456    
8457    
Legend:
Removed from v.1006  
changed lines
  Added in v.1801
  ViewVC Help
Powered by ViewVC