/[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 1390 by schoenebeck, Sun Oct 7 14:07:48 2007 UTC revision 1960 by schoenebeck, Fri Jul 31 10:20:16 2009 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: April 9, 2008                                   October 7, 2007  Expires: February 1, 2010                                  July 31, 2009
8    
9    
10                   LinuxSampler Control Protocol (draft)                       LinuxSampler Control Protocol
11                                LSCP 1.2cvs                                  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 April 9, 2008.     This Internet-Draft will expire on February 1, 2010.
37    
 Copyright Notice  
38    
    Copyright (C) The IETF Trust (2007).  
39    
40    
41    
# Line 52  Copyright Notice Line 50  Copyright Notice
50    
51    
52    
53  Schoenebeck               Expires April 9, 2008                 [Page 1]  
54    
55  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Schoenebeck             Expires February 1, 2010                [Page 1]
56    
57    Internet-Draft        LinuxSampler Control Protocol            July 2009
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck               Expires April 9, 2008                 [Page 2]  Schoenebeck             Expires February 1, 2010                [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 124  Internet-Draft    LinuxSampler Control P Line 124  Internet-Draft    LinuxSampler Control P
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  45         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  45         6.4.4.  Getting all created sampler channel list  . . . . . .  46
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.  Getting amount of available engines . . . . . . . . .  48
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  48         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10. Getting sampler channel information . . . . . . . . .  49
# Line 136  Internet-Draft    LinuxSampler Control P Line 136  Internet-Draft    LinuxSampler Control P
136         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  57
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  59
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60         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 . . . . . . . . . . . . . . . . . . . . . . .  61                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  62         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  63         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 .  64         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  64         6.4.28. Listing all effect sends on a sampler channel . . . .  65
153         6.4.29. Getting effect send information . . . . . . . . . . .  65         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67
155         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Altering effect send's send level . . . . . . . . . .  69         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70         6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70
159       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70         6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71
160         6.5.1.  Register front-end for receiving event messages . . .  70       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  . . . . . . . . . . . . . . . . . . . . . .  71                 messages  . . . . . . . . . . . . . . . . . . . . . .  73
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72  
   
   
   
 Schoenebeck               Expires April 9, 2008                 [Page 3]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  72  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73  
        6.6.1.  Current number of active voices . . . . . . . . . . .  73  
        6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73  
        6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73  
        6.6.4.  General sampler informations  . . . . . . . . . . . .  74  
        6.6.5.  Getting global volume attenuation . . . . . . . . . .  74  
        6.6.6.  Setting global volume attenuation . . . . . . . . . .  75  
      6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75  
        6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76  
        6.7.2.  Delete one particular or all MIDI instrument maps . .  77  
        6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78  
        6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78  
        6.7.5.  Getting MIDI instrument map information . . . . . . .  78  
        6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79  
        6.7.7.  Create or replace a MIDI instrument map entry . . . .  80  
        6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83  
        6.7.9.  Getting indeces of all entries of a MIDI  
                instrument map  . . . . . . . . . . . . . . . . . . .  83  
        6.7.10. Remove an entry from the MIDI instrument map  . . . .  84  
        6.7.11. Get current settings of MIDI instrument map entry . .  85  
        6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86  
      6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87  
        6.8.1.  Creating a new instrument directory . . . . . . . . .  87  
        6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88  
        6.8.3.  Getting amount of instrument directories  . . . . . .  89  
        6.8.4.  Listing all directories in specific directory . . . .  89  
        6.8.5.  Getting instrument directory information  . . . . . .  90  
        6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91  
        6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91  
        6.8.8.  Copying instrument directories  . . . . . . . . . . .  92  
        6.8.9.  Changing the description of directory . . . . . . . .  93  
        6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93  
        6.8.11. Adding instruments to the instruments database  . . .  95  
        6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96  
        6.8.13. Getting amount of instruments . . . . . . . . . . . .  97  
        6.8.14. Listing all instruments in specific directory . . . .  97  
        6.8.15. Getting instrument information  . . . . . . . . . . .  98  
        6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100  
        6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101  
        6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102  
        6.8.19. Changing the description of instrument  . . . . . . . 102  
        6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103  
        6.8.21. Getting job status information  . . . . . . . . . . . 105  
        6.8.22. Formatting the instruments database . . . . . . . . . 106  
      6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107  
        6.9.1.  Opening an appropriate instrument editor  
                application . . . . . . . . . . . . . . . . . . . . . 107  
   
   
   
 Schoenebeck               Expires April 9, 2008                 [Page 4]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126  
      8.1.  Number of audio output devices changed  . . . . . . . . . 126  
      8.2.  Audio output device's settings changed  . . . . . . . . . 126  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 127  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 127  
      8.6.  Number of active voices changed . . . . . . . . . . . . . 127  
      8.7.  Number of active disk streams changed . . . . . . . . . . 128  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128  
      8.9.  Channel information changed . . . . . . . . . . . . . . . 128  
      8.10. Number of effect sends changed  . . . . . . . . . . . . . 129  
      8.11. Effect send information changed . . . . . . . . . . . . . 129  
      8.12. Total number of active voices changed . . . . . . . . . . 129  
      8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130  
      8.14. MIDI instrument map information changed . . . . . . . . . 130  
      8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130  
      8.16. MIDI instrument information changed . . . . . . . . . . . 131  
      8.17. Global settings changed . . . . . . . . . . . . . . . . . 131  
      8.18. Number of database instrument directories changed . . . . 132  
      8.19. Database instrument directory information changed . . . . 132  
      8.20. Number of database instruments changed  . . . . . . . . . 133  
      8.21. Database instrument information changed . . . . . . . . . 133  
      8.22. Database job status information changed . . . . . . . . . 134  
      8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138  
    Intellectual Property and Copyright Statements  . . . . . . . . . 139  
   
   
   
   
   
   
164    
165    
166    
167    Schoenebeck             Expires February 1, 2010                [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 . . . . . . . .  75
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  . . . . . . . . . .  79
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 . . . . .  82
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  . . .  87
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 . .  89
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  . . . . . .  93
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 . . . . 102
215           6.8.15. Getting instrument information  . . . . . . . . . . . 102
216           6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 105
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 February 1, 2010                [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 . . . . . . . . . 111
231           6.8.23. Checking for lost instrument files  . . . . . . . . . 111
232           6.8.24. Replacing an instrument file  . . . . . . . . . . . . 112
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  . . . . . 114
238           6.10.2. Retrieving all instruments of a file  . . . . . . . . 114
239           6.10.3. Retrieving informations about one instrument in a
240                   file  . . . . . . . . . . . . . . . . . . . . . . . . 115
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 February 1, 2010                [Page 5]
280    
281  Schoenebeck               Expires April 9, 2008                 [Page 5]  Internet-Draft        LinuxSampler Control Protocol            July 2009
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck               Expires April 9, 2008                 [Page 6]  Schoenebeck             Expires February 1, 2010                [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft    LinuxSampler Control P Line 363  Internet-Draft    LinuxSampler Control P
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 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck               Expires April 9, 2008                 [Page 7]  Schoenebeck             Expires February 1, 2010                [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck               Expires April 9, 2008                 [Page 8]  Schoenebeck             Expires February 1, 2010                [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck               Expires April 9, 2008                 [Page 9]  Schoenebeck             Expires February 1, 2010                [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck               Expires April 9, 2008                [Page 10]  Schoenebeck             Expires February 1, 2010               [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck               Expires April 9, 2008                [Page 11]  Schoenebeck             Expires February 1, 2010               [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck               Expires April 9, 2008                [Page 12]  Schoenebeck             Expires February 1, 2010               [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck               Expires April 9, 2008                [Page 13]  Schoenebeck             Expires February 1, 2010               [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck               Expires April 9, 2008                [Page 14]  Schoenebeck             Expires February 1, 2010               [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck               Expires April 9, 2008                [Page 15]  Schoenebeck             Expires February 1, 2010               [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck               Expires April 9, 2008                [Page 16]  Schoenebeck             Expires February 1, 2010               [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck               Expires April 9, 2008                [Page 17]  Schoenebeck             Expires February 1, 2010               [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck               Expires April 9, 2008                [Page 18]  Schoenebeck             Expires February 1, 2010               [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck               Expires April 9, 2008                [Page 19]  Schoenebeck             Expires February 1, 2010               [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck               Expires April 9, 2008                [Page 20]  Schoenebeck             Expires February 1, 2010               [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck               Expires April 9, 2008                [Page 21]  Schoenebeck             Expires February 1, 2010               [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck               Expires April 9, 2008                [Page 22]  Schoenebeck             Expires February 1, 2010               [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck               Expires April 9, 2008                [Page 23]  Schoenebeck             Expires February 1, 2010               [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck               Expires April 9, 2008                [Page 24]  Schoenebeck             Expires February 1, 2010               [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck               Expires April 9, 2008                [Page 25]  Schoenebeck             Expires February 1, 2010               [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft    LinuxSampler Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck               Expires April 9, 2008                [Page 26]  Schoenebeck             Expires February 1, 2010               [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck               Expires April 9, 2008                [Page 27]  Schoenebeck             Expires February 1, 2010               [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck               Expires April 9, 2008                [Page 28]  Schoenebeck             Expires February 1, 2010               [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck               Expires April 9, 2008                [Page 29]  Schoenebeck             Expires February 1, 2010               [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck               Expires April 9, 2008                [Page 30]  Schoenebeck             Expires February 1, 2010               [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft    LinuxSampler Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck               Expires April 9, 2008                [Page 31]  Schoenebeck             Expires February 1, 2010               [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck               Expires April 9, 2008                [Page 32]  Schoenebeck             Expires February 1, 2010               [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck               Expires April 9, 2008                [Page 33]  Schoenebeck             Expires February 1, 2010               [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck               Expires April 9, 2008                [Page 34]  Schoenebeck             Expires February 1, 2010               [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck               Expires April 9, 2008                [Page 35]  Schoenebeck             Expires February 1, 2010               [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck               Expires April 9, 2008                [Page 36]  Schoenebeck             Expires February 1, 2010               [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck               Expires April 9, 2008                [Page 37]  Schoenebeck             Expires February 1, 2010               [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck               Expires April 9, 2008                [Page 38]  Schoenebeck             Expires February 1, 2010               [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck               Expires April 9, 2008                [Page 39]  Schoenebeck             Expires February 1, 2010               [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck               Expires April 9, 2008                [Page 40]  Schoenebeck             Expires February 1, 2010               [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft    LinuxSampler Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck               Expires April 9, 2008                [Page 41]  Schoenebeck             Expires February 1, 2010               [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft    LinuxSampler Control P Line 2348  Internet-Draft    LinuxSampler Control P
2348    
2349    
2350    
2351  Schoenebeck               Expires April 9, 2008                [Page 42]  Schoenebeck             Expires February 1, 2010               [Page 42]
2352    
2353  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft    LinuxSampler Control P Line 2404  Internet-Draft    LinuxSampler Control P
2404    
2405    
2406    
2407  Schoenebeck               Expires April 9, 2008                [Page 43]  Schoenebeck             Expires February 1, 2010               [Page 43]
2408    
2409  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
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
# Line 2431  Internet-Draft    LinuxSampler Control P Line 2431  Internet-Draft    LinuxSampler Control P
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 2449  Internet-Draft    LinuxSampler Control P Line 2457  Internet-Draft    LinuxSampler Control P
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
    sampler channel.  This command has (currently) no way to define or  
    force if a new engine instance should be created and assigned to the  
    given sampler channel or if an already existing instance of that  
    engine type, shared with other sampler channels, should be used.  
2460    
    Possible Answers:  
2461    
2462    
2463    Schoenebeck             Expires February 1, 2010               [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol            July 2009
2466    
2467    
2468  Schoenebeck               Expires April 9, 2008                [Page 44]     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
2470  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007     given sampler channel or if an already existing instance of that
2471       engine type, shared with other sampler channels, should be used.
2472    
2473       Possible Answers:
2474    
2475        "OK" -        "OK" -
2476    
# Line 2503  Internet-Draft    LinuxSampler Control P Line 2510  Internet-Draft    LinuxSampler Control P
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck             Expires February 1, 2010               [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2513  Internet-Draft    LinuxSampler Control P Line 2531  Internet-Draft    LinuxSampler Control P
2531    
2532     Possible Answers:     Possible Answers:
2533    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 45]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
2534        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2535        all sampler channels numerical IDs.        all sampler channels numerical IDs.
2536    
# Line 2558  Internet-Draft    LinuxSampler Control P Line 2568  Internet-Draft    LinuxSampler Control P
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck             Expires February 1, 2010               [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2571  Internet-Draft    LinuxSampler Control P Line 2590  Internet-Draft    LinuxSampler Control P
2590    
2591    
2592    
   
 Schoenebeck               Expires April 9, 2008                [Page 46]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
   
   
2593  6.4.6.  Removing a sampler channel  6.4.6.  Removing a sampler channel
2594    
2595     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
# Line 2611  Internet-Draft    LinuxSampler Control P Line 2622  Internet-Draft    LinuxSampler Control P
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck             Expires February 1, 2010               [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2625  Internet-Draft    LinuxSampler Control P Line 2647  Internet-Draft    LinuxSampler Control P
2647    
2648     Example:     Example:
2649    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 47]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
2650        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2651    
2652        S: "4"        S: "4"
# Line 2667  Internet-Draft    LinuxSampler Control P Line 2681  Internet-Draft    LinuxSampler Control P
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 February 1, 2010               [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 2679  Internet-Draft    LinuxSampler Control P Line 2701  Internet-Draft    LinuxSampler Control P
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))
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 48]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
2706    
2707           VERSION -           VERSION -
2708    
# Line 2722  Internet-Draft    LinuxSampler Control P Line 2737  Internet-Draft    LinuxSampler Control P
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 February 1, 2010               [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol            July 2009
2746    
2747    
2748        following categories are defined:        following categories are defined:
2749    
2750    
# Line 2736  Internet-Draft    LinuxSampler Control P Line 2759  Internet-Draft    LinuxSampler Control P
2759    
2760              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2761              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2762              signal, "NONE" if there's no device connected to this              signal, "-1" if there's no device connected to this sampler
2763                channel
   
   
 Schoenebeck               Expires April 9, 2008                [Page 49]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
             sampler channel  
2764    
2765           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2766    
# Line 2764  Internet-Draft    LinuxSampler Control P Line 2779  Internet-Draft    LinuxSampler Control P
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    
2788              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument, "-1"
2789                if there's no instrument loaded for this sampler channel
2790    
2791           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2792    
2793              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2794                LSCP 1.2 this character string may contain escape sequences
2795                (Section 7.1))
2796    
2797    
2798    
2799    Schoenebeck             Expires February 1, 2010               [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol            July 2009
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
2806              integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
2807              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2808              loading exception.  Value of 100 indicates that the              loading exception (also returns "-1" in case no instrument
2809              instrument is fully loaded.              was yet to be loaded on the sampler channel).  Value of 100
2810                indicates that the instrument is fully loaded.
2811    
2812           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2813    
2814              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2815              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2816              commands, "NONE" if there's no device connected to this              commands, "-1" if there's no device connected to this
2817              sampler channel              sampler channel
2818    
2819           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2820    
2821              port number of the MIDI input device              port number of the MIDI input device (in case a MIDI device
2822                was already assigned to the sampler channel)
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 50]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
2823    
2824           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2825    
# Line 2829  Internet-Draft    LinuxSampler Control P Line 2849  Internet-Draft    LinuxSampler Control P
2849    
2850              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2851              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
2852    
2853    
2854    
2855    Schoenebeck             Expires February 1, 2010               [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol            July 2009
2858    
2859    
2860              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2861              values.              values.
2862    
# Line 2848  Internet-Draft    LinuxSampler Control P Line 2876  Internet-Draft    LinuxSampler Control P
2876    
2877           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
2878    
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 51]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
2879           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2880    
2881           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
# Line 2886  Internet-Draft    LinuxSampler Control P Line 2905  Internet-Draft    LinuxSampler Control P
2905     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2906     sampler channel by sending the following command:     sampler channel by sending the following command:
2907    
2908    
2909    
2910    
2911    Schoenebeck             Expires February 1, 2010               [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol            July 2009
2914    
2915    
2916        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2917    
2918     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 2901  Internet-Draft    LinuxSampler Control P Line 2928  Internet-Draft    LinuxSampler Control P
2928    
2929    
2930    
   
   
   
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 52]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
2931  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
2932    
2933     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
# Line 2944  Internet-Draft    LinuxSampler Control P Line 2959  Internet-Draft    LinuxSampler Control P
2959    
2960     to get the fill state in bytes or     to get the fill state in bytes or
2961    
2962    
2963    
2964    
2965    
2966    
2967    Schoenebeck             Expires February 1, 2010               [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol            July 2009
2970    
2971    
2972        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
2973    
2974     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
# Line 2961  Internet-Draft    LinuxSampler Control P Line 2986  Internet-Draft    LinuxSampler Control P
2986        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
2987        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
2988        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 53]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
2989        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
2990        to sort them by itself if necessary.        to sort them by itself if necessary.
2991    
# Line 3001  Internet-Draft    LinuxSampler Control P Line 3018  Internet-Draft    LinuxSampler Control P
3018     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3019     command.     command.
3020    
3021    
3022    
3023    Schoenebeck             Expires February 1, 2010               [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol            July 2009
3026    
3027    
3028     Possible Answers:     Possible Answers:
3029    
3030        "OK" -        "OK" -
# Line 3018  Internet-Draft    LinuxSampler Control P Line 3042  Internet-Draft    LinuxSampler Control P
3042           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3043           error message           error message
3044    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 54]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3045     Examples:     Examples:
3046    
3047    
# Line 3054  Internet-Draft    LinuxSampler Control P Line 3071  Internet-Draft    LinuxSampler Control P
3071           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3072           message           message
3073    
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck             Expires February 1, 2010               [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol            July 2009
3082    
3083    
3084        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3085    
3086           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3073  Internet-Draft    LinuxSampler Control P Line 3100  Internet-Draft    LinuxSampler Control P
3100    
3101     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3102     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 55]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3103     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
3104     audio output channel which should be rerouted and <audio-in> is the     audio output channel which should be rerouted and <audio-in> is the
3105     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
# Line 3107  Internet-Draft    LinuxSampler Control P Line 3126  Internet-Draft    LinuxSampler Control P
3126    
3127    
3128    
3129    
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck             Expires February 1, 2010               [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol            July 2009
3138    
3139    
3140  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
3141    
3142     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
# Line 3128  Internet-Draft    LinuxSampler Control P Line 3158  Internet-Draft    LinuxSampler Control P
3158    
3159        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3160    
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 56]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3161           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3162           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3163           message           message
# Line 3164  Internet-Draft    LinuxSampler Control P Line 3185  Internet-Draft    LinuxSampler Control P
3185    
3186     Possible Answers:     Possible Answers:
3187    
3188    
3189    
3190    
3191    Schoenebeck             Expires February 1, 2010               [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol            July 2009
3194    
3195    
3196        "OK" -        "OK" -
3197    
3198           on success           on success
# Line 3183  Internet-Draft    LinuxSampler Control P Line 3212  Internet-Draft    LinuxSampler Control P
3212    
3213    
3214    
   
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 57]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3215  6.4.19.  Setting MIDI input port  6.4.19.  Setting MIDI input port
3216    
3217     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
# Line 3224  Internet-Draft    LinuxSampler Control P Line 3243  Internet-Draft    LinuxSampler Control P
3243    
3244    
3245    
3246    
3247    Schoenebeck             Expires February 1, 2010               [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol            July 2009
3250    
3251    
3252    
3253    
3254  6.4.20.  Setting MIDI input channel  6.4.20.  Setting MIDI input channel
3255    
3256     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
# Line 3241  Internet-Draft    LinuxSampler Control P Line 3268  Internet-Draft    LinuxSampler Control P
3268    
3269           on success           on success
3270    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 58]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3271        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3272    
3273           if MIDI input channel was set, but there are noteworthy           if MIDI input channel was set, but there are noteworthy
# Line 3278  Internet-Draft    LinuxSampler Control P Line 3297  Internet-Draft    LinuxSampler Control P
3297    
3298     Possible Answers:     Possible Answers:
3299    
3300    
3301    
3302    
3303    Schoenebeck             Expires February 1, 2010               [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol            July 2009
3306    
3307    
3308        "OK" -        "OK" -
3309    
3310           on success           on success
# Line 3297  Internet-Draft    LinuxSampler Control P Line 3324  Internet-Draft    LinuxSampler Control P
3324    
3325    
3326    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 59]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
   
   
3327  6.4.22.  Muting a sampler channel  6.4.22.  Muting a sampler channel
3328    
3329     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
# Line 3336  Internet-Draft    LinuxSampler Control P Line 3353  Internet-Draft    LinuxSampler Control P
3353           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3354           error message           error message
3355    
3356    
3357    
3358    
3359    Schoenebeck             Expires February 1, 2010               [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol            July 2009
3362    
3363    
3364     Examples:     Examples:
3365    
3366    
# Line 3354  Internet-Draft    LinuxSampler Control P Line 3379  Internet-Draft    LinuxSampler Control P
3379    
3380     Possible Answers:     Possible Answers:
3381    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 60]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3382        "OK" -        "OK" -
3383    
3384           on success           on success
# Line 3392  Internet-Draft    LinuxSampler Control P Line 3410  Internet-Draft    LinuxSampler Control P
3410     (Section 6.4.4) command and <map> can have the following     (Section 6.4.4) command and <map> can have the following
3411     possibilites:     possibilites:
3412    
3413    
3414    
3415    Schoenebeck             Expires February 1, 2010               [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol            July 2009
3418    
3419    
3420        "NONE" -        "NONE" -
3421    
3422           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
# Line 3409  Internet-Draft    LinuxSampler Control P Line 3434  Internet-Draft    LinuxSampler Control P
3434           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
3435           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3436           command.  Once that map will be deleted, the sampler channel           command.  Once that map will be deleted, the sampler channel
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 61]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3437           would fall back to "NONE".           would fall back to "NONE".
3438    
3439     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
# Line 3448  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3466     (Section 6.4.4) command, that is the sampler channel on which the     (Section 6.4.4) command, that is the sampler channel on which the
3467     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3468    
3469    
3470    
3471    Schoenebeck             Expires February 1, 2010               [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol            July 2009
3474    
3475    
3476     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3477     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3478     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
# Line 3465  Internet-Draft    LinuxSampler Control P Line 3490  Internet-Draft    LinuxSampler Control P
3490     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3491    
3492     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 62]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3493     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3494     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
3495     separate (sampler channel local) audio buffers are needed to render     separate (sampler channel local) audio buffers are needed to render
# Line 3503  Internet-Draft    LinuxSampler Control P Line 3520  Internet-Draft    LinuxSampler Control P
3520    
3521        C: "CREATE FX_SEND 0 93"        C: "CREATE FX_SEND 0 93"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck             Expires February 1, 2010               [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol            July 2009
3530    
3531    
3532        S: "OK[1]"        S: "OK[1]"
3533    
3534  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
# Line 3521  Internet-Draft    LinuxSampler Control P Line 3547  Internet-Draft    LinuxSampler Control P
3547    
3548     Possible Answers:     Possible Answers:
3549    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 63]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3550        "OK" -        "OK" -
3551    
3552           on success           on success
# Line 3557  Internet-Draft    LinuxSampler Control P Line 3575  Internet-Draft    LinuxSampler Control P
3575    
3576     Possible Answers:     Possible Answers:
3577    
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck             Expires February 1, 2010               [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol            July 2009
3586    
3587    
3588        The sampler will answer by returning the number of effect sends on        The sampler will answer by returning the number of effect sends on
3589        the given sampler channel.        the given sampler channel.
3590    
# Line 3577  Internet-Draft    LinuxSampler Control P Line 3605  Internet-Draft    LinuxSampler Control P
3605     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3606     (Section 6.4.4) command.     (Section 6.4.4) command.
3607    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 64]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3608     Possible Answers:     Possible Answers:
3609    
3610        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
# Line 3613  Internet-Draft    LinuxSampler Control P Line 3633  Internet-Draft    LinuxSampler Control P
3633     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
3634     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.28) command.
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires February 1, 2010               [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol            July 2009
3642    
3643    
3644     Possible Answers:     Possible Answers:
3645    
3646        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
# Line 3625  Internet-Draft    LinuxSampler Control P Line 3653  Internet-Draft    LinuxSampler Control P
3653    
3654           NAME -           NAME -
3655    
3656              name of the effect send entity              name of the effect send entity (note that this character
3657                string may contain escape sequences (Section 7.1))
3658    
3659           MIDI_CONTROLLER -           MIDI_CONTROLLER -
3660    
3661              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3662              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3663    
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 65]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3664           LEVEL -           LEVEL -
3665    
3666              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
# Line 3669  Internet-Draft    LinuxSampler Control P Line 3689  Internet-Draft    LinuxSampler Control P
3689    
3690           "LEVEL: 0.3"           "LEVEL: 0.3"
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires February 1, 2010               [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol            July 2009
3698    
3699    
3700           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3701    
3702           "."           "."
# Line 3690  Internet-Draft    LinuxSampler Control P Line 3718  Internet-Draft    LinuxSampler Control P
3718     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
3719     (Section 7.1)").     (Section 7.1)").
3720    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 66]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3721     Possible Answers:     Possible Answers:
3722    
3723        "OK" -        "OK" -
# Line 3724  Internet-Draft    LinuxSampler Control P Line 3745  Internet-Draft    LinuxSampler Control P
3745        <audio-src> <audio-dst>        <audio-src> <audio-dst>
3746    
3747     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3748    
3749    
3750    
3751    Schoenebeck             Expires February 1, 2010               [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol            July 2009
3754    
3755    
3756     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3757     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3758     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
# Line 3746  Internet-Draft    LinuxSampler Control P Line 3775  Internet-Draft    LinuxSampler Control P
3775    
3776     Possible Answers:     Possible Answers:
3777    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 67]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3778        "OK" -        "OK" -
3779    
3780           on success           on success
# Line 3779  Internet-Draft    LinuxSampler Control P Line 3801  Internet-Draft    LinuxSampler Control P
3801     The front-end can alter the MIDI controller of an effect send entity     The front-end can alter the MIDI controller of an effect send entity
3802     by sending the following command:     by sending the following command:
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires February 1, 2010               [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol            July 2009
3810    
3811    
3812        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3813        ctrl>        ctrl>
3814    
# Line 3802  Internet-Draft    LinuxSampler Control P Line 3832  Internet-Draft    LinuxSampler Control P
3832           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3833           message           message
3834    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 68]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3835        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3836    
3837           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3834  Internet-Draft    LinuxSampler Control P Line 3857  Internet-Draft    LinuxSampler Control P
3857     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3858     dotted positive number (a value smaller than 1.0 means attenuation,     dotted positive number (a value smaller than 1.0 means attenuation,
3859     whereas a value greater than 1.0 means amplification) reflecting the     whereas a value greater than 1.0 means amplification) reflecting the
3860    
3861    
3862    
3863    Schoenebeck             Expires February 1, 2010               [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol            July 2009
3866    
3867    
3868     new send level.     new send level.
3869    
3870     Possible Answers:     Possible Answers:
# Line 3855  Internet-Draft    LinuxSampler Control P Line 3886  Internet-Draft    LinuxSampler Control P
3886    
3887     Example:     Example:
3888    
3889          C: "SET FX_SEND LEVEL 0 0 0.15"
3890    
3891          S: "OK"
3892    
3893    6.4.34.  Sending MIDI messages to sampler channel
3894    
3895       The front-end can send MIDI events to specific sampler channel by
3896       sending the following command:
3897    
3898          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
3899    
3900       Where <sampler-chan> is the sampler channel number as returned by the
3901       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3902       command, <arg1> and <arg2> arguments depend on the <midi-msg>
3903       argument, which specifies the MIDI message type.  Currently, the
3904       following MIDI messages are supported:
3905    
3906  Schoenebeck               Expires April 9, 2008                [Page 69]        "NOTE_ON" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
3907    
3908             For turning on MIDI notes, where <arg1> specifies the key
3909             number and <arg2> the velocity as described in the MIDI
3910             specification.
3911    
3912        C: "SET FX_SEND LEVEL 0 0 0.15"        "NOTE_OFF" -
3913    
3914             For turning a currently playing MIDI note off, where <arg1>
3915             specifies the key number and <arg2> the velocity as described
3916    
3917    
3918    
3919    Schoenebeck             Expires February 1, 2010               [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol            July 2009
3922    
3923    
3924             in the MIDI specification.
3925    
3926       CAUTION: This command is provided for implementations of virtual MIDI
3927       keyboards and no realtime guarantee whatsoever will be made!
3928    
3929       Possible Answers:
3930    
3931          "OK" -
3932    
3933             on success
3934    
3935          "ERR:<error-code>:<error-message>" -
3936    
3937             in case it failed, providing an appropriate error code and
3938             error message
3939    
3940       Example:
3941    
3942          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
3943    
3944        S: "OK"        S: "OK"
3945    
3946  6.4.34.  Resetting a sampler channel  6.4.35.  Resetting a sampler channel
3947    
3948     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3949     following command:     following command:
# Line 3893  Internet-Draft    LinuxSampler Control P Line 3967  Internet-Draft    LinuxSampler Control P
3967           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3968           message           message
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck             Expires February 1, 2010               [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol            July 2009
3978    
3979    
3980        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3981    
3982           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3912  Internet-Draft    LinuxSampler Control P Line 3996  Internet-Draft    LinuxSampler Control P
3996     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3997     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3998    
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 70]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
3999        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
4000    
4001     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 3947  Internet-Draft    LinuxSampler Control P Line 4022  Internet-Draft    LinuxSampler Control P
4022    
4023    
4024    
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck             Expires February 1, 2010               [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol            July 2009
4034    
4035    
4036  6.5.2.  Unregister front-end for not receiving event messages  6.5.2.  Unregister front-end for not receiving event messages
4037    
4038     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
# Line 3969  Internet-Draft    LinuxSampler Control P Line 4055  Internet-Draft    LinuxSampler Control P
4055           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4056           message           message
4057    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 71]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
4058        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4059    
4060           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 4002  Internet-Draft    LinuxSampler Control P Line 4080  Internet-Draft    LinuxSampler Control P
4080    
4081     Possible Answers:     Possible Answers:
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck             Expires February 1, 2010               [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol            July 2009
4090    
4091    
4092        "OK" -        "OK" -
4093    
4094           usually           usually
# Line 4024  Internet-Draft    LinuxSampler Control P Line 4111  Internet-Draft    LinuxSampler Control P
4111     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4112     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4113    
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 72]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
4114  6.6.  Global commands  6.6.  Global commands
4115    
4116     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 4058  Internet-Draft    LinuxSampler Control P Line 4136  Internet-Draft    LinuxSampler Control P
4136    
4137     Possible Answers:     Possible Answers:
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck             Expires February 1, 2010               [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol            July 2009
4146    
4147    
4148        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4149        voices.        voices.
4150    
4151  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4152    
4153       The front-end can ask for the current number of active disk streams
4154       on the sampler by sending the following command:
4155    
4156          GET TOTAL_STREAM_COUNT
4157    
4158       Possible Answers:
4159    
4160          LinuxSampler will answer by returning the number of all active
4161          disk streams on the sampler.
4162    
4163    6.6.4.  Reset sampler
4164    
4165     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4166     command:     command:
# Line 4078  Internet-Draft    LinuxSampler Control P Line 4177  Internet-Draft    LinuxSampler Control P
4177    
4178    
4179    
4180    6.6.5.  General sampler informations
   
   
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 73]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
 6.6.4.  General sampler informations  
4181    
4182     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4183     instance by sending the following command:     instance by sending the following command:
# Line 4106  Internet-Draft    LinuxSampler Control P Line 4194  Internet-Draft    LinuxSampler Control P
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck             Expires February 1, 2010               [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol            July 2009
4202    
4203    
4204    
4205    
4206           DESCRIPTION -           DESCRIPTION -
4207    
4208              arbitrary textual description about the sampler (note that              arbitrary textual description about the sampler (note that
# Line 4129  Internet-Draft    LinuxSampler Control P Line 4226  Internet-Draft    LinuxSampler Control P
4226     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4227     Other fields might be added in future.     Other fields might be added in future.
4228    
4229  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4230    
4231     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4232     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4138  Internet-Draft    LinuxSampler Control P Line 4235  Internet-Draft    LinuxSampler Control P
4235    
4236     Possible Answers:     Possible Answers:
4237    
   
   
 Schoenebeck               Expires April 9, 2008                [Page 74]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
4238        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
4239        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4240        attenuation.        attenuation.
# Line 4153  Internet-Draft    LinuxSampler Control P Line 4243  Internet-Draft    LinuxSampler Control P
4243     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4244     this parameter.     this parameter.
4245    
4246  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4247    
4248     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4249     attenuation by sending the following command:     attenuation by sending the following command:
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck             Expires February 1, 2010               [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol            July 2009
4258    
4259    
4260        SET VOLUME <volume>        SET VOLUME <volume>
4261    
4262     Where <volume> should be replaced by the optional dotted floating     Where <volume> should be replaced by the optional dotted floating
# Line 4182  Internet-Draft    LinuxSampler Control P Line 4281  Internet-Draft    LinuxSampler Control P
4281           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4282           error message           error message
4283    
4284    6.6.8.  Getting global voice limit
4285    
4286       The client can ask for the current global sampler-wide limit for
4287       maximum voices by sending the following command:
4288    
4289          GET VOICES
4290    
4291       Possible Answers:
4292    
4293          LinuxSampler will answer by returning the number for the current
4294          limit of maximum voices.
4295    
4296       The voice limit setting defines how many voices should maximum be
4297       processed by the sampler at the same time.  If the user triggers new
4298       notes which would exceed that voice limit, the sampler engine will
4299       react by stealing old voices for those newly triggered notes.  Note
4300       that the amount of voices triggered by a new note can be larger than
4301       one and is dependent to the respective instrument and probably
4302       further criterias.
4303    
4304    6.6.9.  Setting global voice limit
4305    
4306       The client can alter the current global sampler-wide limit for
4307       maximum voices by sending the following command:
4308    
4309    
4310    
4311    Schoenebeck             Expires February 1, 2010               [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol            July 2009
4314    
4315    
4316          SET VOICES <max-voices>
4317    
4318       Where <max-voices> should be replaced by the integer value,
4319       reflecting the new global amount limit of maximum voices.  This value
4320       has to be larger than 0.
4321    
4322       Possible Answers:
4323    
4324          "OK" -
4325    
4326             on success
4327    
4328          "WRN:<warning-code>:<warning-message>" -
4329    
4330             if the voice limit was set, but there are noteworthy issue(s)
4331             related, providing an appropriate warning code and warning
4332             message
4333    
4334          "ERR:<error-code>:<error-message>" -
4335    
4336             in case it failed, providing an appropriate error code and
4337             error message
4338    
4339       Note: the given value will be passed to all sampler engine instances.
4340       The total amount of maximum voices on the running system might thus
4341       be as big as the given value multiplied by the current amount of
4342       engine instances.
4343    
4344       Caution: when adjusting the voice limit, you SHOULD also adjust the
4345       disk stream limit respectively and vice versa.
4346    
4347    6.6.10.  Getting global disk stream limit
4348    
4349       The client can ask for the current global sampler-wide limit for
4350       maximum disk streams by sending the following command:
4351    
4352          GET STREAMS
4353    
4354       Possible Answers:
4355    
4356          LinuxSampler will answer by returning the number for the current
4357          limit of maximum disk streams.
4358    
4359       The disk stream limit setting defines how many disk streams should
4360       maximum be processed by a sampler engine at the same time.  The
4361       higher this value, the more memory (RAM) will be occupied, since
4362       every disk streams allocates a certain buffer size for being able to
4363       perform its streaming operations.
4364    
4365    
4366    
4367    Schoenebeck             Expires February 1, 2010               [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol            July 2009
4370    
4371    
4372    6.6.11.  Setting global disk stream limit
4373    
4374       The client can alter the current global sampler-wide limit for
4375       maximum disk streams by sending the following command:
4376    
4377          SET STREAMS <max-streams>
4378    
4379       Where <max-streams> should be replaced by the integer value,
4380       reflecting the new global amount limit of maximum disk streams.  This
4381       value has to be positive.
4382    
4383       Possible Answers:
4384    
4385          "OK" -
4386    
4387             on success
4388    
4389          "WRN:<warning-code>:<warning-message>" -
4390    
4391             if the disk stream limit was set, but there are noteworthy
4392             issue(s) related, providing an appropriate warning code and
4393             warning message
4394    
4395          "ERR:<error-code>:<error-message>" -
4396    
4397             in case it failed, providing an appropriate error code and
4398             error message
4399    
4400       Note: the given value will be passed to all sampler engine instances.
4401       The total amount of maximum disk streams on the running system might
4402       thus be as big as the given value multiplied by the current amount of
4403       engine instances.
4404    
4405       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4406       the voice limit respectively and vice versa.
4407    
4408  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4409    
4410     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4196  Internet-Draft    LinuxSampler Control P Line 4419  Internet-Draft    LinuxSampler Control P
4419    
4420    
4421    
4422  Schoenebeck               Expires April 9, 2008                [Page 75]  
4423    Schoenebeck             Expires February 1, 2010               [Page 79]
4424  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
4425    Internet-Draft        LinuxSampler Control Protocol            July 2009
4426    
4427    
4428     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
# Line 4252  Internet-Draft    LinuxSampler Control P Line 4476  Internet-Draft    LinuxSampler Control P
4476    
4477    
4478    
4479  Schoenebeck               Expires April 9, 2008                [Page 76]  Schoenebeck             Expires February 1, 2010               [Page 80]
4480    
4481  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4482    
4483    
4484        S: "OK[0]"        S: "OK[0]"
# Line 4308  Internet-Draft    LinuxSampler Control P Line 4532  Internet-Draft    LinuxSampler Control P
4532    
4533    
4534    
4535  Schoenebeck               Expires April 9, 2008                [Page 77]  Schoenebeck             Expires February 1, 2010               [Page 81]
4536    
4537  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4538    
4539    
4540  6.7.3.  Get amount of existing MIDI instrument maps  6.7.3.  Get amount of existing MIDI instrument maps
# Line 4364  Internet-Draft    LinuxSampler Control P Line 4588  Internet-Draft    LinuxSampler Control P
4588    
4589    
4590    
4591  Schoenebeck               Expires April 9, 2008                [Page 78]  Schoenebeck             Expires February 1, 2010               [Page 82]
4592    
4593  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4594    
4595    
4596     Possible Answers:     Possible Answers:
# Line 4382  Internet-Draft    LinuxSampler Control P Line 4606  Internet-Draft    LinuxSampler Control P
4606           NAME -           NAME -
4607    
4608              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4609              unique              unique (note that this character string may contain escape
4610                sequences (Section 7.1))
4611    
4612           DEFAULT -           DEFAULT -
4613    
# Line 4419  Internet-Draft    LinuxSampler Control P Line 4644  Internet-Draft    LinuxSampler Control P
4644    
4645    
4646    
4647    Schoenebeck             Expires February 1, 2010               [Page 83]
4648    
4649  Schoenebeck               Expires April 9, 2008                [Page 79]  Internet-Draft        LinuxSampler Control Protocol            July 2009
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
4650    
4651    
4652        "OK" -        "OK" -
# Line 4476  Internet-Draft    LinuxSampler Control P Line 4700  Internet-Draft    LinuxSampler Control P
4700    
4701    
4702    
4703  Schoenebeck               Expires April 9, 2008                [Page 80]  Schoenebeck             Expires February 1, 2010               [Page 84]
4704    
4705  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4706    
4707    
4708        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
# Line 4532  Internet-Draft    LinuxSampler Control P Line 4756  Internet-Draft    LinuxSampler Control P
4756    
4757    
4758    
4759  Schoenebeck               Expires April 9, 2008                [Page 81]  Schoenebeck             Expires February 1, 2010               [Page 85]
4760    
4761  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4762    
4763    
4764     (Section 6.7.11)).     (Section 6.7.11)).
# Line 4588  Internet-Draft    LinuxSampler Control P Line 4812  Internet-Draft    LinuxSampler Control P
4812    
4813    
4814    
4815  Schoenebeck               Expires April 9, 2008                [Page 82]  Schoenebeck             Expires February 1, 2010               [Page 86]
4816    
4817  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4818    
4819    
4820        S: "OK"        S: "OK"
# Line 4644  Internet-Draft    LinuxSampler Control P Line 4868  Internet-Draft    LinuxSampler Control P
4868    
4869    
4870    
4871  Schoenebeck               Expires April 9, 2008                [Page 83]  Schoenebeck             Expires February 1, 2010               [Page 87]
4872    
4873  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4874    
4875    
4876        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
# Line 4700  Internet-Draft    LinuxSampler Control P Line 4924  Internet-Draft    LinuxSampler Control P
4924    
4925    
4926    
4927  Schoenebeck               Expires April 9, 2008                [Page 84]  Schoenebeck             Expires February 1, 2010               [Page 88]
4928    
4929  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
4930    
4931    
4932  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
# Line 4732  Internet-Draft    LinuxSampler Control P Line 4956  Internet-Draft    LinuxSampler Control P
4956           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4957           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4958           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4959           be unique.           be unique. (note that this character string may contain escape
4960             sequences (Section 7.1))
4961    
4962        "ENGINE_NAME" -        "ENGINE_NAME" -
4963    
# Line 4740  Internet-Draft    LinuxSampler Control P Line 4965  Internet-Draft    LinuxSampler Control P
4965    
4966        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4967    
4968           File name of the instrument.           File name of the instrument (note that this path may contain
4969             escape sequences (Section 7.1)).
4970    
4971        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
4972    
# Line 4750  Internet-Draft    LinuxSampler Control P Line 4976  Internet-Draft    LinuxSampler Control P
4976    
4977           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
4978           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4979           cannot be changed.           cannot be changed (note that this character string may contain
4980    
4981    
4982    
4983    Schoenebeck             Expires February 1, 2010               [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol            July 2009
4986    
 Schoenebeck               Expires April 9, 2008                [Page 85]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
4987    
4988             escape sequences (Section 7.1)).
4989    
4990        "LOAD_MODE" -        "LOAD_MODE" -
4991    
# Line 4806  Internet-Draft    LinuxSampler Control P Line 5032  Internet-Draft    LinuxSampler Control P
5032     The front-end can clear all MIDI instrument maps, that is delete all     The front-end can clear all MIDI instrument maps, that is delete all
5033     entries of all maps by sending the following command:     entries of all maps by sending the following command:
5034    
       CLEAR MIDI_INSTRUMENTS ALL  
5035    
    The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,  
5036    
5037    
5038    
5039  Schoenebeck               Expires April 9, 2008                [Page 86]  Schoenebeck             Expires February 1, 2010               [Page 90]
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
5040    
5041    Internet-Draft        LinuxSampler Control Protocol            July 2009
5042    
5043    
5044          CLEAR MIDI_INSTRUMENTS ALL
5045    
5046       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
5047     only their entries, thus the map's settings like custom name will be     only their entries, thus the map's settings like custom name will be
5048     preservevd.     preservevd.
5049    
# Line 4865  Internet-Draft    LinuxSampler Control P Line 5092  Internet-Draft    LinuxSampler Control P
5092    
5093    
5094    
5095    Schoenebeck             Expires February 1, 2010               [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol            July 2009
   
 Schoenebeck               Expires April 9, 2008                [Page 87]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
5098    
5099    
5100        "OK" -        "OK" -
# Line 4924  Internet-Draft    LinuxSampler Control P Line 5148  Internet-Draft    LinuxSampler Control P
5148    
5149    
5150    
5151  Schoenebeck               Expires April 9, 2008                [Page 88]  Schoenebeck             Expires February 1, 2010               [Page 92]
5152    
5153  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5154    
5155    
5156  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
# Line 4980  Internet-Draft    LinuxSampler Control P Line 5204  Internet-Draft    LinuxSampler Control P
5204    
5205    
5206    
5207  Schoenebeck               Expires April 9, 2008                [Page 89]  Schoenebeck             Expires February 1, 2010               [Page 93]
5208    
5209  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5210    
5211    
5212     Example:     Example:
# Line 5036  Internet-Draft    LinuxSampler Control P Line 5260  Internet-Draft    LinuxSampler Control P
5260    
5261    
5262    
5263  Schoenebeck               Expires April 9, 2008                [Page 90]  Schoenebeck             Expires February 1, 2010               [Page 94]
5264    
5265  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5266    
5267    
5268     Example:     Example:
# Line 5092  Internet-Draft    LinuxSampler Control P Line 5316  Internet-Draft    LinuxSampler Control P
5316    
5317    
5318    
5319  Schoenebeck               Expires April 9, 2008                [Page 91]  Schoenebeck             Expires February 1, 2010               [Page 95]
5320    
5321  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5322    
5323    
5324        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
# Line 5148  Internet-Draft    LinuxSampler Control P Line 5372  Internet-Draft    LinuxSampler Control P
5372    
5373    
5374    
5375  Schoenebeck               Expires April 9, 2008                [Page 92]  Schoenebeck             Expires February 1, 2010               [Page 96]
5376    
5377  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5378    
5379    
5380     Example:     Example:
# Line 5204  Internet-Draft    LinuxSampler Control P Line 5428  Internet-Draft    LinuxSampler Control P
5428    
5429    
5430    
5431  Schoenebeck               Expires April 9, 2008                [Page 93]  Schoenebeck             Expires February 1, 2010               [Page 97]
5432    
5433  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5434    
5435    
5436     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
# Line 5260  Internet-Draft    LinuxSampler Control P Line 5484  Internet-Draft    LinuxSampler Control P
5484    
5485    
5486    
5487  Schoenebeck               Expires April 9, 2008                [Page 94]  Schoenebeck             Expires February 1, 2010               [Page 98]
5488    
5489  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5490    
5491    
5492           if the given directory does not exist.           if the given directory does not exist.
# Line 5283  Internet-Draft    LinuxSampler Control P Line 5507  Internet-Draft    LinuxSampler Control P
5507     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5508     database by sending the following command:     database by sending the following command:
5509    
5510        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5511        [<instr_index>]        <file_path> [<instr_index>]
5512    
5513     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5514     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
# Line 5316  Internet-Draft    LinuxSampler Control P Line 5540  Internet-Draft    LinuxSampler Control P
5540    
5541    
5542    
5543  Schoenebeck               Expires April 9, 2008                [Page 95]  Schoenebeck             Expires February 1, 2010               [Page 99]
5544    
5545  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
5546    
5547    
5548        "FLAT" -        "FLAT" -
# Line 5328  Internet-Draft    LinuxSampler Control P Line 5552  Internet-Draft    LinuxSampler Control P
5552           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5553           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5554    
5555       If FILE_AS_DIR argument is supplied, all instruments in an instrument
5556       file will be added to a separate directory in the instruments
5557       database, which name will be the name of the instrument file with the
5558       file extension stripped off.
5559    
5560     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
5561     is that the regular command returns when the scanning is finished     is that the regular command returns when the scanning is finished
5562     while NON_MODAL version returns immediately and a background process     while NON_MODAL version returns immediately and a background process
# Line 5362  Internet-Draft    LinuxSampler Control P Line 5591  Internet-Draft    LinuxSampler Control P
5591     The front-end can remove a particular instrument from the instruments     The front-end can remove a particular instrument from the instruments
5592     database by sending the following command:     database by sending the following command:
5593    
       REMOVE DB_INSTRUMENT <instr_path>  
5594    
    Where <instr_path> is the absolute path name (in the instruments  
    database) of the instrument to remove.  
5595    
    Possible Answers:  
5596    
5597    
5598    
5599    Schoenebeck             Expires February 1, 2010              [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol            July 2009
5602    
 Schoenebeck               Expires April 9, 2008                [Page 96]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
5603    
5604          REMOVE DB_INSTRUMENT <instr_path>
5605    
5606       Where <instr_path> is the absolute path name (in the instruments
5607       database) of the instrument to remove.
5608    
5609       Possible Answers:
5610    
5611        "OK" -        "OK" -
5612    
# Line 5417  Internet-Draft    LinuxSampler Control P Line 5648  Internet-Draft    LinuxSampler Control P
5648    
5649        S: "2"        S: "2"
5650    
 6.8.14.  Listing all instruments in specific directory  
5651    
    The front-end can retrieve the current list of instruments in  
    specific directory by sending the following command:  
5652    
       LIST DB_INSTRUMENTS [RECURSIVE] <dir>  
5653    
    Where <dir> should be replaced by the absolute path name of the  
5654    
5655    Schoenebeck             Expires February 1, 2010              [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol            July 2009
5658    
 Schoenebeck               Expires April 9, 2008                [Page 97]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
5659    
5660    6.8.14.  Listing all instruments in specific directory
5661    
5662       The front-end can retrieve the current list of instruments in
5663       specific directory by sending the following command:
5664    
5665          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5666    
5667       Where <dir> should be replaced by the absolute path name of the
5668     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5669     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5670     specified directory, will be returned.     specified directory, will be returned.
# Line 5473  Internet-Draft    LinuxSampler Control P Line 5705  Internet-Draft    LinuxSampler Control P
5705        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5706        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
5707        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
       following categories are defined:  
5708    
5709    
5710    
5711           INSTRUMENT_FILE -  Schoenebeck             Expires February 1, 2010              [Page 102]
5712    
5713              File name of the instrument.  Note that the character string  Internet-Draft        LinuxSampler Control Protocol            July 2009
             may contain escape sequences (Section 7.1).  
5714    
5715    
5716          following categories are defined:
5717    
 Schoenebeck               Expires April 9, 2008                [Page 98]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
5718    
5719    
5720             INSTRUMENT_FILE -
5721    
5722                File name of the instrument.  Note that the character string
5723                may contain escape sequences (Section 7.1).
5724    
5725           INSTRUMENT_NR -           INSTRUMENT_NR -
5726    
5727              Index of the instrument within the file.              Index of the instrument within the file.
# Line 5527  Internet-Draft    LinuxSampler Control P Line 5760  Internet-Draft    LinuxSampler Control P
5760              either true or false, determines whether the instrument is a              either true or false, determines whether the instrument is a
5761              drumkit or a chromatic instrument              drumkit or a chromatic instrument
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck             Expires February 1, 2010              [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol            July 2009
5770    
5771    
5772           PRODUCT -           PRODUCT -
5773    
5774              The product title of the instrument.  Note that the              The product title of the instrument.  Note that the
# Line 5537  Internet-Draft    LinuxSampler Control P Line 5779  Internet-Draft    LinuxSampler Control P
5779              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5780              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5781    
   
   
   
 Schoenebeck               Expires April 9, 2008                [Page 99]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
5782           KEYWORDS -           KEYWORDS -
5783    
5784              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5582  Internet-Draft    LinuxSampler Control P Line 5816  Internet-Draft    LinuxSampler Control P
5816    
5817           "KEYWORDS: Bosendorfer"           "KEYWORDS: Bosendorfer"
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck             Expires February 1, 2010              [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol            July 2009
5826    
5827    
5828           "."           "."
5829    
5830  6.8.16.  Renaming an instrument  6.8.16.  Renaming an instrument
# Line 5594  Internet-Draft    LinuxSampler Control P Line 5837  Internet-Draft    LinuxSampler Control P
5837     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5838     is the new name for that instrument.     is the new name for that instrument.
5839    
   
   
 Schoenebeck               Expires April 9, 2008               [Page 100]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
5840     Possible Answers:     Possible Answers:
5841    
5842        "OK" -        "OK" -
# Line 5635  Internet-Draft    LinuxSampler Control P Line 5871  Internet-Draft    LinuxSampler Control P
5871    
5872           on success           on success
5873    
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires February 1, 2010              [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol            July 2009
5882    
5883    
5884        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5885    
5886           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
# Line 5648  Internet-Draft    LinuxSampler Control P Line 5894  Internet-Draft    LinuxSampler Control P
5894    
5895        S: "OK"        S: "OK"
5896    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 101]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
5897  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5898    
5899     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5691  Internet-Draft    LinuxSampler Control P Line 5928  Internet-Draft    LinuxSampler Control P
5928     The front-end can alter the description of a specific instrument by     The front-end can alter the description of a specific instrument by
5929     sending the following command:     sending the following command:
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck             Expires February 1, 2010              [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol            July 2009
5938    
5939    
5940        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5941    
5942     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
# Line 5704  Internet-Draft    LinuxSampler Control P Line 5950  Internet-Draft    LinuxSampler Control P
5950    
5951           on success           on success
5952    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 102]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
5953        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5954    
5955           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5747  Internet-Draft    LinuxSampler Control P Line 5984  Internet-Draft    LinuxSampler Control P
5984    
5985     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck             Expires February 1, 2010              [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol            July 2009
5994    
5995    
5996        Restricts the search to instruments, which size is in the        Restricts the search to instruments, which size is in the
5997        specified range.  If <min> is omitted, the search results are        specified range.  If <min> is omitted, the search results are
5998        restricted to instruments with size less then or equal to <max>.        restricted to instruments with size less then or equal to <max>.
# Line 5762  Internet-Draft    LinuxSampler Control P Line 6008  Internet-Draft    LinuxSampler Control P
6008        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
6009        instruments created after <date-after>.        instruments created after <date-after>.
6010    
   
   
 Schoenebeck               Expires April 9, 2008               [Page 103]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6011     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
6012    
6013        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5802  Internet-Draft    LinuxSampler Control P Line 6041  Internet-Draft    LinuxSampler Control P
6041    
6042     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
6043    
6044    
6045    
6046    
6047    Schoenebeck             Expires February 1, 2010              [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol            July 2009
6050    
6051    
6052        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
6053        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6054        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5818  Internet-Draft    LinuxSampler Control P Line 6065  Internet-Draft    LinuxSampler Control P
6065        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6066        families.        families.
6067    
   
   
 Schoenebeck               Expires April 9, 2008               [Page 104]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6068     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6069     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6070    
# Line 5856  Internet-Draft    LinuxSampler Control P Line 6096  Internet-Draft    LinuxSampler Control P
6096     The front-end can ask for the current status of a particular database     The front-end can ask for the current status of a particular database
6097     instruments job by sending the following command:     instruments job by sending the following command:
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires February 1, 2010              [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol            July 2009
6106    
6107    
6108        GET DB_INSTRUMENTS_JOB INFO <job-id>        GET DB_INSTRUMENTS_JOB INFO <job-id>
6109    
6110     Where <job-id> should be replaced by the numerical ID of the job the     Where <job-id> should be replaced by the numerical ID of the job the
# Line 5873  Internet-Draft    LinuxSampler Control P Line 6122  Internet-Draft    LinuxSampler Control P
6122    
6123           FILES_TOTAL -           FILES_TOTAL -
6124    
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 105]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6125              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6126    
6127           FILES_SCANNED -           FILES_SCANNED -
# Line 5912  Internet-Draft    LinuxSampler Control P Line 6153  Internet-Draft    LinuxSampler Control P
6153    
6154           "STATUS: 42"           "STATUS: 42"
6155    
6156    
6157    
6158    
6159    Schoenebeck             Expires February 1, 2010              [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol            July 2009
6162    
6163    
6164           "."           "."
6165    
6166  6.8.22.  Formatting the instruments database  6.8.22.  Formatting the instruments database
# Line 5928  Internet-Draft    LinuxSampler Control P Line 6177  Internet-Draft    LinuxSampler Control P
6177    
6178           on success           on success
6179    
6180          "ERR:<error-code>:<error-message>" -
6181    
6182             If the formatting of the instruments database failed.
6183    
6184    6.8.23.  Checking for lost instrument files
6185    
6186       The front-end can retrieve the list of all instrument files in the
6187       instruments database that don't exist in the filesystem by sending
6188       the following command:
6189    
6190          FIND LOST DB_INSTRUMENT_FILES
6191    
6192  Schoenebeck               Expires April 9, 2008               [Page 106]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
6193    
6194          A comma separated list with the absolute path names (encapsulated
6195          into apostrophes) of all lost instrument files.
6196    
6197        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6198    
6199           If the formatting of the instruments database failed.           in case it failed, providing an appropriate error code and
6200             error message.
6201    
6202       Example:
6203    
6204          C: "FIND LOST DB_INSTRUMENT_FILES"
6205    
6206          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6207          Piano.gig'"
6208    
6209    
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck             Expires February 1, 2010              [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol            July 2009
6218    
6219    
6220    6.8.24.  Replacing an instrument file
6221    
6222       The front-end can substitute all occurrences of an instrument file in
6223       the instruments database with a new one by sending the following
6224       command:
6225    
6226          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6227    
6228       Where <old_path> is the absolute path name of the instrument file to
6229       substitute with <new_path>.
6230    
6231       Possible Answers:
6232    
6233          "OK" -
6234    
6235             on success
6236    
6237          "ERR:<error-code>:<error-message>" -
6238    
6239             in case it failed, providing an appropriate error code and
6240             error message.
6241    
6242       Example:
6243    
6244          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6245          '/gigs/pianos/Bosendorfer 290.gig'"
6246    
6247          S: "OK"
6248    
6249  6.9.  Editing Instruments  6.9.  Editing Instruments
6250    
# Line 5958  Internet-Draft    LinuxSampler Control P Line 6263  Internet-Draft    LinuxSampler Control P
6263     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
6264     application by sending the following command:     application by sending the following command:
6265    
6266        EDIT INSTRUMENT <sampler-channel>  
6267    
6268    
6269    
6270    
6271    Schoenebeck             Expires February 1, 2010              [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol            July 2009
6274    
6275    
6276          EDIT CHANNEL INSTRUMENT <sampler-channel>
6277    
6278     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
6279     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
# Line 5984  Internet-Draft    LinuxSampler Control P Line 6299  Internet-Draft    LinuxSampler Control P
6299    
6300           when an appropriate instrument editor was launched           when an appropriate instrument editor was launched
6301    
6302          "WRN:<warning-code>:<warning-message>" -
6303    
6304             when an appropriate instrument editor was launched, but there
6305             are noteworthy issues
6306    
6307          "ERR:<error-code>:<error-message>" -
6308    
6309             when an appropriate instrument editor could not be launched
6310    
6311  Schoenebeck               Expires April 9, 2008               [Page 107]     Examples:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
6312    
6313          C: "EDIT CHANNEL INSTRUMENT 0"
6314    
6315        "WRN:<warning-code>:<warning-message>" -        S: "OK"
6316    
6317    6.10.  Managing Files
6318    
6319       You can query detailed informations about files located at the same
6320       system where the sampler instance is running on.  Using this command
6321       set allows to retrieve file informations even remotely from another
6322       machine.
6323    
6324           when an appropriate instrument editor was launched, but there  
6325           are noteworthy issues  
6326    
6327    Schoenebeck             Expires February 1, 2010              [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol            July 2009
6330    
6331    
6332    6.10.1.  Retrieving amount of instruments of a file
6333    
6334       The front-end can retrieve the amount of instruments within a given
6335       instrument file by sending the following command:
6336    
6337          GET FILE INSTRUMENTS <filename>
6338    
6339       Where <filename> is the name of the instrument file (encapsulated
6340       into apostrophes, supporting escape sequences as described in chapter
6341       "Character Set and Escape Sequences (Section 7.1)").
6342    
6343       The sampler will try to ask all sampler engines, whether they support
6344       the given file and ask the first engine with a positive answer for
6345       the amount of instruments.
6346    
6347       Possible Answers:
6348    
6349          On success, the sampler will answer by returning the amount of
6350          instruments.
6351    
6352        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6353    
6354           when an appropriate instrument editor could not be launched           if the file could not be handled
6355    
6356     Examples:     Examples:
6357    
6358        C: "EDIT INSTRUMENT 0"        C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6359    
6360          S: "10"
6361    
6362    6.10.2.  Retrieving all instruments of a file
6363    
6364       The front-end can retrieve a list of all instruments within a given
6365       instrument file by sending the following command:
6366    
6367          LIST FILE INSTRUMENTS <filename>
6368    
6369       Where <filename> is the name of the instrument file (encapsulated
6370       into apostrophes, supporting escape sequences as described in chapter
6371       "Character Set and Escape Sequences (Section 7.1)").
6372    
6373       The sampler will try to ask all sampler engines, whether they support
6374       the given file and ask the first engine with a positive answer for a
6375       list of IDs for the instruments in the given file.
6376    
6377       Possible Answers:
6378    
       S: "OK"  
6379    
6380    
6381    
6382    
6383    Schoenebeck             Expires February 1, 2010              [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol            July 2009
6386    
6387    
6388          On success, the sampler will answer by returning a comma separated
6389          list of instrument IDs.
6390    
6391          "ERR:<error-code>:<error-message>" -
6392    
6393             if the file could not be handled
6394    
6395       Examples:
6396    
6397          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6398    
6399          S: "0,1,2,3,4,5,6,7,8,9"
6400    
6401    6.10.3.  Retrieving informations about one instrument in a file
6402    
6403       The front-end can retrieve detailed informations about a specific
6404       instrument within a given instrument file by sending the following
6405       command:
6406    
6407          GET FILE INSTRUMENT INFO <filename> <instr-id>
6408    
6409       Where <filename> is the name of the instrument file (encapsulated
6410       into apostrophes, supporting escape sequences as described in chapter
6411       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6412       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6413       (Section 6.10.2) command.
6414    
6415       The sampler will try to ask all sampler engines, whether they support
6416       the given file and ask the first engine with a positive answer for
6417       informations about the specific instrument in the given file.
6418    
6419       Possible Answers:
6420    
6421          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6422          answer line begins with the settings category name followed by a
6423          colon and then a space character <SP> and finally the info
6424          character string to that setting category.  At the moment the
6425          following categories are defined:
6426    
6427    
6428    
6429             NAME -
6430    
6431                name of the instrument as stored in the instrument file
6432    
6433             FORMAT_FAMILY -
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires February 1, 2010              [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol            July 2009
6442    
6443    
6444                name of the sampler format of the given instrument
6445    
6446             FORMAT_VERSION -
6447    
6448                version of the sampler format the instrumen is stored as
6449    
6450             PRODUCT -
6451    
6452                official product name of the instrument as stored in the
6453                file
6454    
6455             ARTISTS -
6456    
6457                artists / sample library vendor of the instrument
6458    
6459             KEY_BINDINGS -
6460    
6461                comma separated list of integer values representing the
6462                instrument's key mapping in the range between 0 .. 127,
6463                reflecting the analog meaning of the MIDI specification.
6464    
6465  Schoenebeck               Expires April 9, 2008               [Page 108]           KEYSWITCH_BINDINGS -
6466    
6467  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007              comma separated list of integer values representing the
6468                instrument's keyswitch mapping in the range between 0 ..
6469                127, reflecting the analog meaning of the MIDI
6470                specification.
6471    
6472       The mentioned fields above don't have to be in particular order.
6473    
6474       Example:
6475    
6476          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6477    
6478          S: "NAME: Lunatic Loops"
6479    
6480             "FORMAT_FAMILY: GIG"
6481    
6482             "FORMAT_VERSION: 3"
6483    
6484             "PRODUCT: The Backbone Bongo Beats"
6485    
6486             "ARTISTS: Jimmy the Fish"
6487    
6488             "."
6489    
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires February 1, 2010              [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol            July 2009
6498    
6499    
6500  7.  Command Syntax  7.  Command Syntax
# Line 6100  Internet-Draft    LinuxSampler Control P Line 6548  Internet-Draft    LinuxSampler Control P
6548    
6549    
6550    
6551  Schoenebeck               Expires April 9, 2008               [Page 109]  Schoenebeck             Expires February 1, 2010              [Page 117]
6552    
6553  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
6554    
6555    
6556        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6131  Internet-Draft    LinuxSampler Control P Line 6579  Internet-Draft    LinuxSampler Control P
6579    
6580        / FORMAT SP format_instruction        / FORMAT SP format_instruction
6581    
6582          / SEND SP send_instruction
6583    
6584        / RESET        / RESET
6585    
6586        / QUIT        / QUIT
# Line 6143  Internet-Draft    LinuxSampler Control P Line 6593  Internet-Draft    LinuxSampler Control P
6593    
6594        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename        / 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        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6600    
6601        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename        / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
6602          filename
6603    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP  
       instrument_index  
6604    
       / DB_INSTRUMENTS SP db_path SP filename  
6605    
6606    
6607    Schoenebeck             Expires February 1, 2010              [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol            July 2009
6610    
6611    
6612  Schoenebeck               Expires April 9, 2008               [Page 110]        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
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        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6620    
# Line 6179  Internet-Draft    LinuxSampler Control P Line 6634  Internet-Draft    LinuxSampler Control P
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
# Line 6197  Internet-Draft    LinuxSampler Control P Line 6656  Internet-Draft    LinuxSampler Control P
6656    
6657        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck             Expires February 1, 2010              [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol            July 2009
6666    
6667    
6668        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
6669    
6670        / DB_INSTRUMENT_DIRECTORY_COUNT        / DB_INSTRUMENT_DIRECTORY_COUNT
# Line 6209  Internet-Draft    LinuxSampler Control P Line 6677  Internet-Draft    LinuxSampler Control P
6677    
6678        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6679    
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 111]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6680        / MISCELLANEOUS        / MISCELLANEOUS
6681    
6682          / TOTAL_STREAM_COUNT
6683    
6684        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6685    
6686        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6235  Internet-Draft    LinuxSampler Control P Line 6697  Internet-Draft    LinuxSampler Control P
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 6247  Internet-Draft    LinuxSampler Control P Line 6713  Internet-Draft    LinuxSampler Control P
6713    
6714        / FX_SEND_INFO        / FX_SEND_INFO
6715    
6716    
6717    
6718    
6719    Schoenebeck             Expires February 1, 2010              [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol            July 2009
6722    
6723    
6724        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
6725    
6726        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 6265  Internet-Draft    LinuxSampler Control P Line 6739  Internet-Draft    LinuxSampler Control P
6739    
6740        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6741    
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 112]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6742        / MISCELLANEOUS        / MISCELLANEOUS
6743    
6744          / TOTAL_STREAM_COUNT
6745    
6746        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6747    
6748        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6302  Internet-Draft    LinuxSampler Control P Line 6770  Internet-Draft    LinuxSampler Control P
6770    
6771     remove_instruction =     remove_instruction =
6772    
6773    
6774    
6775    Schoenebeck             Expires February 1, 2010              [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol            July 2009
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
# Line 6320  Internet-Draft    LinuxSampler Control P Line 6795  Internet-Draft    LinuxSampler Control P
6795    
6796        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
6797    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 113]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6798        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
6799    
6800        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
# Line 6359  Internet-Draft    LinuxSampler Control P Line 6825  Internet-Draft    LinuxSampler Control P
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 February 1, 2010              [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 6376  Internet-Draft    LinuxSampler Control P Line 6850  Internet-Draft    LinuxSampler Control P
6850    
6851        / SERVER SP INFO        / SERVER SP INFO
6852    
6853          / TOTAL_STREAM_COUNT
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 114]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
6854    
6855        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6856    
# Line 6413  Internet-Draft    LinuxSampler Control P Line 6880  Internet-Draft    LinuxSampler Control P
6880    
6881        / DB_INSTRUMENTS SP db_path        / DB_INSTRUMENTS SP db_path
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck             Expires February 1, 2010              [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol            July 2009
6890    
6891    
6892        / DB_INSTRUMENT SP INFO SP db_path        / DB_INSTRUMENT SP INFO SP db_path
6893    
6894        / DB_INSTRUMENTS_JOB SP INFO SP number        / 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 6432  Internet-Draft    LinuxSampler Control P Line 6916  Internet-Draft    LinuxSampler Control P
6916    
6917        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6918    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 115]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
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 6461  Internet-Draft    LinuxSampler Control P Line 6936  Internet-Draft    LinuxSampler Control P
6936    
6937        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck             Expires February 1, 2010              [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol            July 2009
6946    
6947    
6948        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6949        stringval_escaped        stringval_escaped
6950    
# Line 6468  Internet-Draft    LinuxSampler Control P Line 6952  Internet-Draft    LinuxSampler Control P
6952    
6953        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped        / 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 6488  Internet-Draft    LinuxSampler Control P Line 6978  Internet-Draft    LinuxSampler Control P
6978    
6979     reset_instruction =     reset_instruction =
6980    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 116]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
6981        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6982    
6983     clear_instruction =     clear_instruction =
# Line 6511  Internet-Draft    LinuxSampler Control P Line 6992  Internet-Draft    LinuxSampler Control P
6992    
6993        / DB_INSTRUMENTS SP db_path SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck             Expires February 1, 2010              [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol            July 2009
7002    
7003    
7004        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
7005        query_val_list        query_val_list
7006    
7007        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
7008    
7009          / LOST SP DB_INSTRUMENT_FILES
7010    
7011     move_instruction =     move_instruction =
7012    
7013        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
# Line 6544  Internet-Draft    LinuxSampler Control P Line 7036  Internet-Draft    LinuxSampler Control P
7036    
7037     set_chan_instruction =     set_chan_instruction =
7038    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 117]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
7039        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
7040    
7041        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
# Line 6565  Internet-Draft    LinuxSampler Control P Line 7048  Internet-Draft    LinuxSampler Control P
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 February 1, 2010              [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol            July 2009
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 6586  Internet-Draft    LinuxSampler Control P Line 7078  Internet-Draft    LinuxSampler Control P
7078    
7079     edit_instruction =     edit_instruction =
7080    
7081        INSTRUMENT SP sampler_channel        CHANNEL SP INSTRUMENT SP sampler_channel
7082    
7083     format_instruction =     format_instruction =
7084    
# Line 6600  Internet-Draft    LinuxSampler Control P Line 7092  Internet-Draft    LinuxSampler Control P
7092    
7093     key_val_list =     key_val_list =
7094    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 118]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
7095        string '=' param_val_list        string '=' param_val_list
7096    
7097        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6621  Internet-Draft    LinuxSampler Control P Line 7104  Internet-Draft    LinuxSampler Control P
7104    
7105     list_instruction =     list_instruction =
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck             Expires February 1, 2010              [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol            July 2009
7114    
7115    
7116        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
7117    
7118        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6649  Internet-Draft    LinuxSampler Control P Line 7141  Internet-Draft    LinuxSampler Control P
7141    
7142        / DB_INSTRUMENTS SP db_path        / 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 6657  Internet-Draft    LinuxSampler Control P Line 7156  Internet-Draft    LinuxSampler Control P
7156    
7157     load_engine_args =     load_engine_args =
7158    
7159          engine_name SP sampler_channel
7160    
7161       instr_load_mode =
7162    
7163    
 Schoenebeck               Expires April 9, 2008               [Page 119]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
7164    
7165    
       engine_name SP sampler_channel  
7166    
7167     instr_load_mode =  Schoenebeck             Expires February 1, 2010              [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol            July 2009
7170    
7171    
7172        ON_DEMAND        ON_DEMAND
7173    
# Line 6713  Internet-Draft    LinuxSampler Control P Line 7213  Internet-Draft    LinuxSampler Control P
7213    
7214        number        number
7215    
7216       midi_ctrl =
7217    
7218          number
7219    
7220    
 Schoenebeck               Expires April 9, 2008               [Page 120]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
7221    
7222    
7223     midi_ctrl =  Schoenebeck             Expires February 1, 2010              [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol            July 2009
7226    
       number  
7227    
7228     volume_value =     volume_value =
7229    
# Line 6769  Internet-Draft    LinuxSampler Control P Line 7269  Internet-Draft    LinuxSampler Control P
7269    
7270     param_val_list =     param_val_list =
7271    
7272          param_val
7273    
7274          / param_val_list','param_val
7275    
7276    
 Schoenebeck               Expires April 9, 2008               [Page 121]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
7277    
7278    
7279        param_val  Schoenebeck             Expires February 1, 2010              [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol            July 2009
7282    
       / param_val_list','param_val  
7283    
7284     param_val =     param_val =
7285    
# Line 6828  Internet-Draft    LinuxSampler Control P Line 7328  Internet-Draft    LinuxSampler Control P
7328    
7329    
7330    
7331  Schoenebeck               Expires April 9, 2008               [Page 122]  
7332    
7333  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
7334    
7335    Schoenebeck             Expires February 1, 2010              [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol            July 2009
7338    
7339    
7340     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6869  Internet-Draft    LinuxSampler Control P Line 7373  Internet-Draft    LinuxSampler Control P
7373     backslash was sufficient.     backslash was sufficient.
7374    
7375     The following LSCP commands support escape sequences as part of their     The following LSCP commands support escape sequences as part of their
7376     filename / path based arguments:     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)        "LOAD INSTRUMENT" (Section 6.4.1)
7380    
7381          "GET CHANNEL INFO" (Section 6.4.10)
7382    
7383        "MAP MIDI_INSTRUMENT" (Section 6.7.7)        "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7384    
7385        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7386    
       "ADD DB_INSTRUMENTS" (Section 6.8.11)  
7387    
       "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)  
7388    
7389    
7390    
7391    Schoenebeck             Expires February 1, 2010              [Page 132]
7392    
7393  Schoenebeck               Expires April 9, 2008               [Page 123]  Internet-Draft        LinuxSampler Control Protocol            July 2009
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
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)        "REMOVE DB_INSTRUMENT" (Section 6.8.12)
7403    
7404        "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)        "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
# Line 6923  Internet-Draft    LinuxSampler Control P Line 7433  Internet-Draft    LinuxSampler Control P
7433    
7434        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)        "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 February 1, 2010              [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol            July 2009
7450    
7451    
7452          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7453    
7454     Note that the forward slash character ('/') has a special meaning in     Note that the forward slash character ('/') has a special meaning in
7455     filename / path based arguments: it acts as separator of the nodes in     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     the path, thus if a directory- or filename includes a forward slash
# Line 6930  Internet-Draft    LinuxSampler Control P Line 7458  Internet-Draft    LinuxSampler Control P
7458     either with the respective hex escape sequence ("\x2f") or with the     either with the respective hex escape sequence ("\x2f") or with the
7459     respective octal escape sequence ("\057").     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     The following LSCP commands even support escape sequences as part of
7469     at least one of their text-based arguments (i.e. entity name,     at least one of their text-based arguments (i.e. entity name,
7470     description):     description) and / or may contain escape sequences in at least one of
7471       their text-based fields in their response:
7472    
7473        "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)        "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  Schoenebeck               Expires April 9, 2008               [Page 124]        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
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)        "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7492    
7493        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)        "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)        "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7498    
7499    
7500    
7501    
7502    
7503    Schoenebeck             Expires February 1, 2010              [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol            July 2009
7506    
7507    
7508        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "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)        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7515    
7516        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7517    
7518        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)        "FIND DB_INSTRUMENTS" (Section 6.8.20)
7519    
7520     Please note that these lists are manually maintained.  If you find a     Please note that these lists are manually maintained.  If you find a
7521     command that also supports escape sequences we forgot to mention     command that also supports escape sequences we forgot to mention
# Line 6996  Internet-Draft    LinuxSampler Control P Line 7554  Internet-Draft    LinuxSampler Control P
7554    
7555    
7556    
7557  Schoenebeck               Expires April 9, 2008               [Page 125]  
7558    
7559  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Schoenebeck             Expires February 1, 2010              [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol            July 2009
7562    
7563    
7564  8.  Events  8.  Events
# Line 7052  Internet-Draft    LinuxSampler Control P Line 7612  Internet-Draft    LinuxSampler Control P
7612    
7613    
7614    
7615  Schoenebeck               Expires April 9, 2008               [Page 126]  Schoenebeck             Expires February 1, 2010              [Page 136]
7616    
7617  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
7618    
7619    
7620        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7095  Internet-Draft    LinuxSampler Control P Line 7655  Internet-Draft    LinuxSampler Control P
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 MIDI data arrive on sampler
7661       channels on back-end side, by issuing the following command:
7662    
7663          SUBSCRIBE CHANNEL_MIDI
7664    
7665       Server will start sending one of the the following notification
7666       messages:
7667    
7668    
7669    
7670    
7671    Schoenebeck             Expires February 1, 2010              [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol            July 2009
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       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-     Client may want to be notified when the number of voices on the back-
7722     end changes by issuing the following command:     end changes by issuing the following command:
7723    
       SUBSCRIBE VOICE_COUNT  
7724    
    Server will start sending the following notification messages:  
7725    
7726    
7727    Schoenebeck             Expires February 1, 2010              [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol            July 2009
7730    
7731    
7732  Schoenebeck               Expires April 9, 2008               [Page 127]        SUBSCRIBE VOICE_COUNT
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
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    
# Line 7119  Internet-Draft    LinuxSampler Control P Line 7739  Internet-Draft    LinuxSampler Control P
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 7135  Internet-Draft    LinuxSampler Control P Line 7755  Internet-Draft    LinuxSampler Control P
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 7152  Internet-Draft    LinuxSampler Control P Line 7772  Internet-Draft    LinuxSampler Control P
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 February 1, 2010              [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol            July 2009
7786    
 Schoenebeck               Expires April 9, 2008               [Page 128]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
7787    
7788          SUBSCRIBE CHANNEL_INFO
7789    
7790       Server will start sending the following notification messages:
7791    
7792        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
7793    
# Line 7178  Internet-Draft    LinuxSampler Control P Line 7798  Internet-Draft    LinuxSampler Control P
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.  Number of effect sends changed  8.12.  Number of effect sends changed
7802    
7803     Client may want to be notified when the number of effect sends on a     Client may want to be notified when the number of effect sends on a
7804     particular sampler channel is changed by issuing the following     particular sampler channel is changed by issuing the following
# Line 7195  Internet-Draft    LinuxSampler Control P Line 7815  Internet-Draft    LinuxSampler Control P
7815     sends> will be replaced by the new number of effect sends on that     sends> will be replaced by the new number of effect sends on that
7816     channel.     channel.
7817    
7818  8.11.  Effect send information changed  8.13.  Effect send information changed
7819    
7820     Client may want to be notified when changes were made to effect sends     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:     on a a particular sampler channel by issuing the following command:
# Line 7211  Internet-Draft    LinuxSampler Control P Line 7831  Internet-Draft    LinuxSampler Control P
7831     send-id> will be replaced by the numerical ID of the changed effect     send-id> will be replaced by the numerical ID of the changed effect
7832     send.     send.
7833    
 8.12.  Total number of active voices changed  
7834    
    Client may want to be notified when the total number of voices on the  
    back-end changes by issuing the following command:  
7835    
7836    
7837    
7838    
7839    Schoenebeck             Expires February 1, 2010              [Page 140]
7840    
7841  Schoenebeck               Expires April 9, 2008               [Page 129]  Internet-Draft        LinuxSampler Control Protocol            July 2009
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
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
7847       back-end changes by issuing the following command:
7848    
7849        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
7850    
7851     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7234  Internet-Draft    LinuxSampler Control P Line 7855  Internet-Draft    LinuxSampler Control P
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.13.  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 7248  Internet-Draft    LinuxSampler Control P Line 7883  Internet-Draft    LinuxSampler Control P
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.14.  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    
7891    
7892    
7893    
7894    
7895    Schoenebeck             Expires February 1, 2010              [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol            July 2009
7898    
7899    
7900        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
7901    
7902     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7267  Internet-Draft    LinuxSampler Control P Line 7911  Internet-Draft    LinuxSampler Control P
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.15.  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:
7918    
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 130]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
7919        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
7920    
7921     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7291  Internet-Draft    LinuxSampler Control P Line 7926  Internet-Draft    LinuxSampler Control P
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.16.  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 7311  Internet-Draft    LinuxSampler Control P Line 7946  Internet-Draft    LinuxSampler Control P
7946     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7947     empty notification message is sufficient here.     empty notification message is sufficient here.
7948    
7949  8.17.  Global settings changed  
7950    
7951    Schoenebeck             Expires February 1, 2010              [Page 142]
7952    
7953    Internet-Draft        LinuxSampler Control Protocol            July 2009
7954    
7955    
7956    8.20.  Global settings changed
7957    
7958     Client may want to be notified when changes to the global settings of     Client may want to be notified when changes to the global settings of
7959     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 7326  Internet-Draft    LinuxSampler Control P Line 7968  Internet-Draft    LinuxSampler Control P
7968        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
7969        global volume parameter.        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
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 131]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
 8.18.  Number of database instrument directories changed  
7982    
7983     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
7984     directories in a particular directory in the instruments database is     directories in a particular directory in the instruments database is
# Line 7356  Internet-Draft    LinuxSampler Control P Line 7997  Internet-Draft    LinuxSampler Control P
7997     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
7998     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
7999    
8000  8.19.  Database instrument directory information changed  8.22.  Database instrument directory information changed
8001    
8002     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
8003     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
8004    
8005    
8006    
8007    Schoenebeck             Expires February 1, 2010              [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol            July 2009
8010    
8011    
8012        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
8013    
8014     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7382  Internet-Draft    LinuxSampler Control P Line 8030  Internet-Draft    LinuxSampler Control P
8030     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
8031     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
8032    
8033    8.23.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 132]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
 8.20.  Number of database instruments changed  
8034    
8035     Client may want to be notified when the number of instruments in a     Client may want to be notified when the number of instruments in a
8036     particular directory in the instruments database is changed by     particular directory in the instruments database is changed by
# Line 7412  Internet-Draft    LinuxSampler Control P Line 8049  Internet-Draft    LinuxSampler Control P
8049     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
8050     sent for the instruments in that directory.     sent for the instruments in that directory.
8051    
8052  8.21.  Database instrument information changed  8.24.  Database instrument information changed
8053    
8054     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
8055     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7421  Internet-Draft    LinuxSampler Control P Line 8058  Internet-Draft    LinuxSampler Control P
8058    
8059     Server will start sending the following notification messages:     Server will start sending the following notification messages:
8060    
8061    
8062    
8063    Schoenebeck             Expires February 1, 2010              [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol            July 2009
8066    
8067    
8068        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
8069    
8070     where <instr-path> will be replaced by the absolute path name of the     where <instr-path> will be replaced by the absolute path name of the
# Line 7438  Internet-Draft    LinuxSampler Control P Line 8082  Internet-Draft    LinuxSampler Control P
8082     <new-name> is the new name of the instrument, encapsulated into     <new-name> is the new name of the instrument, encapsulated into
8083     apostrophes.     apostrophes.
8084    
8085    8.25.  Database job status information changed
   
   
   
   
   
 Schoenebeck               Expires April 9, 2008               [Page 133]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
   
   
 8.22.  Database job status information changed  
8086    
8087     Client may want to be notified when the status of particular database     Client may want to be notified when the status of particular database
8088     instruments job is changed by issuing the following command:     instruments job is changed by issuing the following command:
# Line 7467  Internet-Draft    LinuxSampler Control P Line 8100  Internet-Draft    LinuxSampler Control P
8100     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
8101     empty notification message is sufficient here.     empty notification message is sufficient here.
8102    
8103  8.23.  Miscellaneous and debugging events  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 7480  Internet-Draft    LinuxSampler Control P Line 8113  Internet-Draft    LinuxSampler Control P
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 February 1, 2010              [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol            July 2009
8122    
8123    
8124     facilitate debugging.     facilitate debugging.
8125    
8126    
# Line 7500  Internet-Draft    LinuxSampler Control P Line 8141  Internet-Draft    LinuxSampler Control P
8141    
8142    
8143    
8144  Schoenebeck               Expires April 9, 2008               [Page 134]  
8145    
8146  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  
8147    
8148    
8149    
8150    
8151    
8152    
8153    
8154    
8155    
8156    
8157    
8158    
8159    
8160    
8161    
8162    
8163    
8164    
8165    
8166    
8167    
8168    
8169    
8170    
8171    
8172    
8173    
8174    
8175    Schoenebeck             Expires February 1, 2010              [Page 146]
8176    
8177    Internet-Draft        LinuxSampler Control Protocol            July 2009
8178    
8179    
8180  9.  Security Considerations  9.  Security Considerations
# Line 7556  Internet-Draft    LinuxSampler Control P Line 8228  Internet-Draft    LinuxSampler Control P
8228    
8229    
8230    
8231  Schoenebeck               Expires April 9, 2008               [Page 135]  Schoenebeck             Expires February 1, 2010              [Page 147]
8232    
8233  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
8234    
8235    
8236  10.  Acknowledgments  10.  Acknowledgments
# Line 7612  Internet-Draft    LinuxSampler Control P Line 8284  Internet-Draft    LinuxSampler Control P
8284    
8285    
8286    
8287  Schoenebeck               Expires April 9, 2008               [Page 136]  Schoenebeck             Expires February 1, 2010              [Page 148]
8288    
8289  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
8290    
8291    
8292  11.  References  11.  References
# Line 7668  Internet-Draft    LinuxSampler Control P Line 8340  Internet-Draft    LinuxSampler Control P
8340    
8341    
8342    
8343  Schoenebeck               Expires April 9, 2008               [Page 137]  Schoenebeck             Expires February 1, 2010              [Page 149]
8344    
8345  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
8346    
8347    
8348  Author's Address  Author's Address
# Line 7724  Author's Address Line 8396  Author's Address
8396    
8397    
8398    
8399  Schoenebeck               Expires April 9, 2008               [Page 138]  Schoenebeck             Expires February 1, 2010              [Page 150]
8400    
8401  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007  Internet-Draft        LinuxSampler Control Protocol            July 2009
8402    
8403    
8404  Full Copyright Statement  Full Copyright Statement
8405    
8406     Copyright (C) The IETF Trust (2007).     Copyright (C) The IETF Trust (2009).
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 7771  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 April 9, 2008               [Page 139]  
8453    
8454    
8455    Schoenebeck             Expires February 1, 2010              [Page 151]
8456    
8457    
Legend:
Removed from v.1390  
changed lines
  Added in v.1960
  ViewVC Help
Powered by ViewVC