--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt 2008/05/02 13:03:00 1731 +++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt 2008/09/10 15:14:31 1773 @@ -4,7 +4,7 @@ LinuxSampler Developers C. Schoenebeck Internet-Draft Interessengemeinschaft Software Intended status: Standards Track Engineering e. V. -Expires: October 3, 2008 April 2008 +Expires: March 14, 2009 September 10, 2008 LinuxSampler Control Protocol @@ -33,11 +33,11 @@ The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. - This Internet-Draft will expire on October 3, 2008. - - + This Internet-Draft will expire on March 14, 2009. +Copyright Notice + Copyright (C) The IETF Trust (2008). @@ -52,9 +52,9 @@ -Schoenebeck Expires October 3, 2008 [Page 1] +Schoenebeck Expires March 14, 2009 [Page 1] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Abstract @@ -108,9 +108,9 @@ -Schoenebeck Expires October 3, 2008 [Page 2] +Schoenebeck Expires March 14, 2009 [Page 2] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.3.8. Getting all created MIDI input device list . . . . . 37 @@ -155,118 +155,119 @@ 6.4.31. Altering effect send's audio routing . . . . . . . . 67 6.4.32. Altering effect send's MIDI controller . . . . . . . 68 6.4.33. Altering effect send's send level . . . . . . . . . . 69 - 6.4.34. Resetting a sampler channel . . . . . . . . . . . . . 70 - 6.5. Controlling connection . . . . . . . . . . . . . . . . . 71 - 6.5.1. Register front-end for receiving event messages . . . 71 + 6.4.34. Sending MIDI messages to sampler channel . . . . . . 70 + 6.4.35. Resetting a sampler channel . . . . . . . . . . . . . 71 + 6.5. Controlling connection . . . . . . . . . . . . . . . . . 72 + 6.5.1. Register front-end for receiving event messages . . . 72 6.5.2. Unregister front-end for not receiving event - messages . . . . . . . . . . . . . . . . . . . . . . 71 - 6.5.3. Enable or disable echo of commands . . . . . . . . . 72 + messages . . . . . . . . . . . . . . . . . . . . . . 72 -Schoenebeck Expires October 3, 2008 [Page 3] +Schoenebeck Expires March 14, 2009 [Page 3] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 - 6.5.4. Close client connection . . . . . . . . . . . . . . . 73 - 6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 73 - 6.6.1. Current number of active voices . . . . . . . . . . . 73 - 6.6.2. Maximum amount of active voices . . . . . . . . . . . 73 + 6.5.3. Enable or disable echo of commands . . . . . . . . . 73 + 6.5.4. Close client connection . . . . . . . . . . . . . . . 74 + 6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 74 + 6.6.1. Current number of active voices . . . . . . . . . . . 74 + 6.6.2. Maximum amount of active voices . . . . . . . . . . . 74 6.6.3. Current number of active disk streams . . . . . . . . 74 - 6.6.4. Reset sampler . . . . . . . . . . . . . . . . . . . . 74 - 6.6.5. General sampler informations . . . . . . . . . . . . 74 - 6.6.6. Getting global volume attenuation . . . . . . . . . . 75 - 6.6.7. Setting global volume attenuation . . . . . . . . . . 75 - 6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 76 + 6.6.4. Reset sampler . . . . . . . . . . . . . . . . . . . . 75 + 6.6.5. General sampler informations . . . . . . . . . . . . 75 + 6.6.6. Getting global volume attenuation . . . . . . . . . . 76 + 6.6.7. Setting global volume attenuation . . . . . . . . . . 76 + 6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 77 6.7.1. Create a new MIDI instrument map . . . . . . . . . . 77 - 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 . . . . . . . 79 - 6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 80 - 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.2. Delete one particular or all MIDI instrument maps . . 78 + 6.7.3. Get amount of existing MIDI instrument maps . . . . . 79 + 6.7.4. Getting all created MIDI instrument maps . . . . . . 79 + 6.7.5. Getting MIDI instrument map information . . . . . . . 80 + 6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 81 + 6.7.7. Create or replace a MIDI instrument map entry . . . . 81 + 6.7.8. Getting ammount of MIDI instrument map entries . . . 84 6.7.9. Getting indeces of all entries of a MIDI - instrument map . . . . . . . . . . . . . . . . . . . 84 - 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 . . . . . . . . . . . . . . 87 - 6.8. Managing Instruments Database . . . . . . . . . . . . . . 88 - 6.8.1. Creating a new instrument directory . . . . . . . . . 88 - 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 . . . . 90 - 6.8.5. Getting instrument directory information . . . . . . 90 - 6.8.6. Renaming an instrument directory . . . . . . . . . . 91 - 6.8.7. Moving an instrument directory . . . . . . . . . . . 92 - 6.8.8. Copying instrument directories . . . . . . . . . . . 93 - 6.8.9. Changing the description of directory . . . . . . . . 93 - 6.8.10. Finding directories . . . . . . . . . . . . . . . . . 94 - 6.8.11. Adding instruments to the instruments database . . . 95 - 6.8.12. Removing an instrument . . . . . . . . . . . . . . . 97 - 6.8.13. Getting amount of instruments . . . . . . . . . . . . 97 - 6.8.14. Listing all instruments in specific directory . . . . 98 - 6.8.15. Getting instrument information . . . . . . . . . . . 99 - 6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 101 - 6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 102 - 6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102 - 6.8.19. Changing the description of instrument . . . . . . . 103 - 6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103 - 6.8.21. Getting job status information . . . . . . . . . . . 106 - 6.8.22. Formatting the instruments database . . . . . . . . . 107 - 6.8.23. Checking for lost instrument files . . . . . . . . . 107 - 6.8.24. Replacing an instrument file . . . . . . . . . . . . 108 + instrument map . . . . . . . . . . . . . . . . . . . 85 + 6.7.10. Remove an entry from the MIDI instrument map . . . . 85 + 6.7.11. Get current settings of MIDI instrument map entry . . 86 + 6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 88 + 6.8. Managing Instruments Database . . . . . . . . . . . . . . 89 + 6.8.1. Creating a new instrument directory . . . . . . . . . 89 + 6.8.2. Deleting an instrument directory . . . . . . . . . . 89 + 6.8.3. Getting amount of instrument directories . . . . . . 90 + 6.8.4. Listing all directories in specific directory . . . . 91 + 6.8.5. Getting instrument directory information . . . . . . 91 + 6.8.6. Renaming an instrument directory . . . . . . . . . . 92 + 6.8.7. Moving an instrument directory . . . . . . . . . . . 93 + 6.8.8. Copying instrument directories . . . . . . . . . . . 94 + 6.8.9. Changing the description of directory . . . . . . . . 94 + 6.8.10. Finding directories . . . . . . . . . . . . . . . . . 95 + 6.8.11. Adding instruments to the instruments database . . . 96 + 6.8.12. Removing an instrument . . . . . . . . . . . . . . . 98 + 6.8.13. Getting amount of instruments . . . . . . . . . . . . 98 + 6.8.14. Listing all instruments in specific directory . . . . 99 + 6.8.15. Getting instrument information . . . . . . . . . . . 100 + 6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 102 + 6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 103 + 6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103 + 6.8.19. Changing the description of instrument . . . . . . . 104 + 6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104 + 6.8.21. Getting job status information . . . . . . . . . . . 107 + 6.8.22. Formatting the instruments database . . . . . . . . . 108 + 6.8.23. Checking for lost instrument files . . . . . . . . . 108 -Schoenebeck Expires October 3, 2008 [Page 4] +Schoenebeck Expires March 14, 2009 [Page 4] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 - 6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 108 + 6.8.24. Replacing an instrument file . . . . . . . . . . . . 109 + 6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 109 6.9.1. Opening an appropriate instrument editor - application . . . . . . . . . . . . . . . . . . . . . 109 - 6.10. Managing Files . . . . . . . . . . . . . . . . . . . . . 110 - 6.10.1. Retrieving amount of instruments of a file . . . . . 110 - 6.10.2. Retrieving all instruments of a file . . . . . . . . 110 + application . . . . . . . . . . . . . . . . . . . . . 110 + 6.10. Managing Files . . . . . . . . . . . . . . . . . . . . . 111 + 6.10.1. Retrieving amount of instruments of a file . . . . . 111 + 6.10.2. Retrieving all instruments of a file . . . . . . . . 111 6.10.3. Retrieving informations about one instrument in a - file . . . . . . . . . . . . . . . . . . . . . . . . 111 - 7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 113 - 7.1. Character Set and Escape Sequences . . . . . . . . . . . 127 - 8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 - 8.1. Number of audio output devices changed . . . . . . . . . 131 - 8.2. Audio output device's settings changed . . . . . . . . . 131 - 8.3. Number of MIDI input devices changed . . . . . . . . . . 131 - 8.4. MIDI input device's settings changed . . . . . . . . . . 132 - 8.5. Number of sampler channels changed . . . . . . . . . . . 132 - 8.6. MIDI data on a sampler channel arrived . . . . . . . . . 132 - 8.7. MIDI data on a MIDI input device arrived . . . . . . . . 133 - 8.8. Number of active voices changed . . . . . . . . . . . . . 133 - 8.9. Number of active disk streams changed . . . . . . . . . . 134 - 8.10. Disk stream buffer fill state changed . . . . . . . . . . 134 - 8.11. Channel information changed . . . . . . . . . . . . . . . 134 - 8.12. Number of effect sends changed . . . . . . . . . . . . . 135 - 8.13. Effect send information changed . . . . . . . . . . . . . 135 - 8.14. Total number of active voices changed . . . . . . . . . . 136 - 8.15. Total number of active disk streams changed . . . . . . . 136 - 8.16. Number of MIDI instrument maps changed . . . . . . . . . 136 - 8.17. MIDI instrument map information changed . . . . . . . . . 136 - 8.18. Number of MIDI instruments changed . . . . . . . . . . . 137 - 8.19. MIDI instrument information changed . . . . . . . . . . . 137 - 8.20. Global settings changed . . . . . . . . . . . . . . . . . 138 - 8.21. Number of database instrument directories changed . . . . 138 - 8.22. Database instrument directory information changed . . . . 138 - 8.23. Number of database instruments changed . . . . . . . . . 139 - 8.24. Database instrument information changed . . . . . . . . . 139 - 8.25. Database job status information changed . . . . . . . . . 140 - 8.26. Miscellaneous and debugging events . . . . . . . . . . . 140 - 9. Security Considerations . . . . . . . . . . . . . . . . . . . 141 - 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 142 - 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 143 - Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 144 - Intellectual Property and Copyright Statements . . . . . . . . . 145 + file . . . . . . . . . . . . . . . . . . . . . . . . 112 + 7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 115 + 7.1. Character Set and Escape Sequences . . . . . . . . . . . 129 + 8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 + 8.1. Number of audio output devices changed . . . . . . . . . 133 + 8.2. Audio output device's settings changed . . . . . . . . . 133 + 8.3. Number of MIDI input devices changed . . . . . . . . . . 133 + 8.4. MIDI input device's settings changed . . . . . . . . . . 134 + 8.5. Number of sampler channels changed . . . . . . . . . . . 134 + 8.6. MIDI data on a sampler channel arrived . . . . . . . . . 134 + 8.7. MIDI data on a MIDI input device arrived . . . . . . . . 135 + 8.8. Number of active voices changed . . . . . . . . . . . . . 135 + 8.9. Number of active disk streams changed . . . . . . . . . . 136 + 8.10. Disk stream buffer fill state changed . . . . . . . . . . 136 + 8.11. Channel information changed . . . . . . . . . . . . . . . 136 + 8.12. Number of effect sends changed . . . . . . . . . . . . . 137 + 8.13. Effect send information changed . . . . . . . . . . . . . 137 + 8.14. Total number of active voices changed . . . . . . . . . . 138 + 8.15. Total number of active disk streams changed . . . . . . . 138 + 8.16. Number of MIDI instrument maps changed . . . . . . . . . 138 + 8.17. MIDI instrument map information changed . . . . . . . . . 138 + 8.18. Number of MIDI instruments changed . . . . . . . . . . . 139 + 8.19. MIDI instrument information changed . . . . . . . . . . . 139 + 8.20. Global settings changed . . . . . . . . . . . . . . . . . 140 + 8.21. Number of database instrument directories changed . . . . 140 + 8.22. Database instrument directory information changed . . . . 140 + 8.23. Number of database instruments changed . . . . . . . . . 141 + 8.24. Database instrument information changed . . . . . . . . . 141 + 8.25. Database job status information changed . . . . . . . . . 142 + 8.26. Miscellaneous and debugging events . . . . . . . . . . . 142 + 9. Security Considerations . . . . . . . . . . . . . . . . . . . 143 + 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 144 + 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 145 + Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 146 + Intellectual Property and Copyright Statements . . . . . . . . . 147 @@ -275,10 +276,9 @@ - -Schoenebeck Expires October 3, 2008 [Page 5] +Schoenebeck Expires March 14, 2009 [Page 5] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 1. Requirements notation @@ -332,9 +332,9 @@ -Schoenebeck Expires October 3, 2008 [Page 6] +Schoenebeck Expires March 14, 2009 [Page 6] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 2. Versioning of this specification @@ -388,9 +388,9 @@ -Schoenebeck Expires October 3, 2008 [Page 7] +Schoenebeck Expires March 14, 2009 [Page 7] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 3. Introduction @@ -444,9 +444,9 @@ -Schoenebeck Expires October 3, 2008 [Page 8] +Schoenebeck Expires March 14, 2009 [Page 8] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 4. Focus of this protocol @@ -500,9 +500,9 @@ -Schoenebeck Expires October 3, 2008 [Page 9] +Schoenebeck Expires March 14, 2009 [Page 9] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 5. Communication Overview @@ -556,9 +556,9 @@ -Schoenebeck Expires October 3, 2008 [Page 10] +Schoenebeck Expires March 14, 2009 [Page 10] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 5.1.1. Result format @@ -612,9 +612,9 @@ -Schoenebeck Expires October 3, 2008 [Page 11] +Schoenebeck Expires March 14, 2009 [Page 11] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 set has the following format: @@ -668,9 +668,9 @@ -Schoenebeck Expires October 3, 2008 [Page 12] +Schoenebeck Expires March 14, 2009 [Page 12] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Each line of the result set MUST end with . @@ -724,9 +724,9 @@ -Schoenebeck Expires October 3, 2008 [Page 13] +Schoenebeck Expires March 14, 2009 [Page 13] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 inserted in the middle of the event message as well as any other @@ -780,9 +780,9 @@ -Schoenebeck Expires October 3, 2008 [Page 14] +Schoenebeck Expires March 14, 2009 [Page 14] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6. Description for control commands @@ -836,9 +836,9 @@ -Schoenebeck Expires October 3, 2008 [Page 15] +Schoenebeck Expires March 14, 2009 [Page 15] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.2.1. Getting amount of available audio output drivers @@ -892,9 +892,9 @@ -Schoenebeck Expires October 3, 2008 [Page 16] +Schoenebeck Expires March 14, 2009 [Page 16] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 LinuxSampler will answer by sending a separated list. Each @@ -948,9 +948,9 @@ -Schoenebeck Expires October 3, 2008 [Page 17] +Schoenebeck Expires March 14, 2009 [Page 17] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" @@ -1004,9 +1004,9 @@ -Schoenebeck Expires October 3, 2008 [Page 18] +Schoenebeck Expires March 14, 2009 [Page 18] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 MULTIPLICITY - @@ -1060,9 +1060,9 @@ -Schoenebeck Expires October 3, 2008 [Page 19] +Schoenebeck Expires March 14, 2009 [Page 19] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 returned, dependent to driver parameter) @@ -1116,9 +1116,9 @@ -Schoenebeck Expires October 3, 2008 [Page 20] +Schoenebeck Expires March 14, 2009 [Page 20] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "TYPE: INT" @@ -1172,9 +1172,9 @@ -Schoenebeck Expires October 3, 2008 [Page 21] +Schoenebeck Expires March 14, 2009 [Page 21] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 providing an appropriate warning code and warning message @@ -1228,9 +1228,9 @@ -Schoenebeck Expires October 3, 2008 [Page 22] +Schoenebeck Expires March 14, 2009 [Page 22] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 C: "DESTROY AUDIO_OUTPUT_DEVICE 0" @@ -1284,9 +1284,9 @@ -Schoenebeck Expires October 3, 2008 [Page 23] +Schoenebeck Expires March 14, 2009 [Page 23] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Possible Answers: @@ -1340,9 +1340,9 @@ -Schoenebeck Expires October 3, 2008 [Page 24] +Schoenebeck Expires March 14, 2009 [Page 24] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "FRAGMENTS: 2" @@ -1396,9 +1396,9 @@ -Schoenebeck Expires October 3, 2008 [Page 25] +Schoenebeck Expires March 14, 2009 [Page 25] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.2.11. Getting information about an audio channel @@ -1452,9 +1452,9 @@ -Schoenebeck Expires October 3, 2008 [Page 26] +Schoenebeck Expires March 14, 2009 [Page 26] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Examples: @@ -1508,9 +1508,9 @@ -Schoenebeck Expires October 3, 2008 [Page 27] +Schoenebeck Expires March 14, 2009 [Page 27] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 channel number and a specific channel parameter name for @@ -1564,9 +1564,9 @@ -Schoenebeck Expires October 3, 2008 [Page 28] +Schoenebeck Expires March 14, 2009 [Page 28] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 RANGE_MAX - @@ -1620,9 +1620,9 @@ -Schoenebeck Expires October 3, 2008 [Page 29] +Schoenebeck Expires March 14, 2009 [Page 29] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "OK" - @@ -1676,9 +1676,9 @@ -Schoenebeck Expires October 3, 2008 [Page 30] +Schoenebeck Expires March 14, 2009 [Page 30] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Note: examples in this chapter showing particular parameters of @@ -1732,9 +1732,9 @@ -Schoenebeck Expires October 3, 2008 [Page 31] +Schoenebeck Expires March 14, 2009 [Page 31] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.3.3. Getting information about a specific MIDI input driver @@ -1788,9 +1788,9 @@ -Schoenebeck Expires October 3, 2008 [Page 32] +Schoenebeck Expires March 14, 2009 [Page 32] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.3.4. Getting information about specific MIDI input driver parameter @@ -1844,9 +1844,9 @@ -Schoenebeck Expires October 3, 2008 [Page 33] +Schoenebeck Expires March 14, 2009 [Page 33] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 FIX - @@ -1900,9 +1900,9 @@ -Schoenebeck Expires October 3, 2008 [Page 34] +Schoenebeck Expires March 14, 2009 [Page 34] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 may also appear without (optionally returned, dependent to @@ -1956,9 +1956,9 @@ -Schoenebeck Expires October 3, 2008 [Page 35] +Schoenebeck Expires March 14, 2009 [Page 35] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "OK[]" - @@ -2012,9 +2012,9 @@ -Schoenebeck Expires October 3, 2008 [Page 36] +Schoenebeck Expires March 14, 2009 [Page 36] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 in case it failed, providing an appropriate error code and @@ -2068,9 +2068,9 @@ -Schoenebeck Expires October 3, 2008 [Page 37] +Schoenebeck Expires March 14, 2009 [Page 37] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.3.9. Getting current settings of a MIDI input device @@ -2124,9 +2124,9 @@ -Schoenebeck Expires October 3, 2008 [Page 38] +Schoenebeck Expires March 14, 2009 [Page 38] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "ACTIVE: true" @@ -2180,9 +2180,9 @@ -Schoenebeck Expires October 3, 2008 [Page 39] +Schoenebeck Expires March 14, 2009 [Page 39] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 MIDI_INPUT_DEVICES" (Section 6.3.8) command and the MIDI @@ -2236,9 +2236,9 @@ -Schoenebeck Expires October 3, 2008 [Page 40] +Schoenebeck Expires March 14, 2009 [Page 40] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 character string to that info category. There is information @@ -2292,9 +2292,9 @@ -Schoenebeck Expires October 3, 2008 [Page 41] +Schoenebeck Expires March 14, 2009 [Page 41] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 returned, dependent to device and port parameter) @@ -2348,9 +2348,9 @@ -Schoenebeck Expires October 3, 2008 [Page 42] +Schoenebeck Expires March 14, 2009 [Page 42] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "ERR::" - @@ -2404,9 +2404,9 @@ -Schoenebeck Expires October 3, 2008 [Page 43] +Schoenebeck Expires March 14, 2009 [Page 43] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 format and SHOULD return ERR and SHOULD not launch the background @@ -2460,9 +2460,9 @@ -Schoenebeck Expires October 3, 2008 [Page 44] +Schoenebeck Expires March 14, 2009 [Page 44] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 sampler channel. This command has (currently) no way to define or @@ -2516,9 +2516,9 @@ -Schoenebeck Expires October 3, 2008 [Page 45] +Schoenebeck Expires March 14, 2009 [Page 45] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.4.4. Getting all created sampler channel list @@ -2572,9 +2572,9 @@ -Schoenebeck Expires October 3, 2008 [Page 46] +Schoenebeck Expires March 14, 2009 [Page 46] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 in case a new channel was added successfully, but there are @@ -2628,9 +2628,9 @@ -Schoenebeck Expires October 3, 2008 [Page 47] +Schoenebeck Expires March 14, 2009 [Page 47] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.4.7. Getting amount of available engines @@ -2684,9 +2684,9 @@ -Schoenebeck Expires October 3, 2008 [Page 48] +Schoenebeck Expires March 14, 2009 [Page 48] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Possible Answers: @@ -2740,9 +2740,9 @@ -Schoenebeck Expires October 3, 2008 [Page 49] +Schoenebeck Expires March 14, 2009 [Page 49] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 following categories are defined: @@ -2796,9 +2796,9 @@ -Schoenebeck Expires October 3, 2008 [Page 50] +Schoenebeck Expires March 14, 2009 [Page 50] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 INSTRUMENT_STATUS - @@ -2852,9 +2852,9 @@ -Schoenebeck Expires October 3, 2008 [Page 51] +Schoenebeck Expires March 14, 2009 [Page 51] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 The mentioned fields above don't have to be in particular order. @@ -2908,9 +2908,9 @@ -Schoenebeck Expires October 3, 2008 [Page 52] +Schoenebeck Expires March 14, 2009 [Page 52] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or @@ -2964,9 +2964,9 @@ -Schoenebeck Expires October 3, 2008 [Page 53] +Schoenebeck Expires March 14, 2009 [Page 53] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 command. @@ -3020,9 +3020,9 @@ -Schoenebeck Expires October 3, 2008 [Page 54] +Schoenebeck Expires March 14, 2009 [Page 54] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "OK" - @@ -3076,9 +3076,9 @@ -Schoenebeck Expires October 3, 2008 [Page 55] +Schoenebeck Expires March 14, 2009 [Page 55] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Examples: @@ -3132,9 +3132,9 @@ -Schoenebeck Expires October 3, 2008 [Page 56] +Schoenebeck Expires March 14, 2009 [Page 56] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) @@ -3188,9 +3188,9 @@ -Schoenebeck Expires October 3, 2008 [Page 57] +Schoenebeck Expires March 14, 2009 [Page 57] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 message @@ -3244,9 +3244,9 @@ -Schoenebeck Expires October 3, 2008 [Page 58] +Schoenebeck Expires March 14, 2009 [Page 58] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 SET CHANNEL MIDI_INPUT_CHANNEL @@ -3300,9 +3300,9 @@ -Schoenebeck Expires October 3, 2008 [Page 59] +Schoenebeck Expires March 14, 2009 [Page 59] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 if channel volume was set, but there are noteworthy issue(s) @@ -3356,9 +3356,9 @@ -Schoenebeck Expires October 3, 2008 [Page 60] +Schoenebeck Expires March 14, 2009 [Page 60] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.4.23. Soloing a sampler channel @@ -3412,9 +3412,9 @@ -Schoenebeck Expires October 3, 2008 [Page 61] +Schoenebeck Expires March 14, 2009 [Page 61] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 This is the default setting. In this case the sampler channel @@ -3468,9 +3468,9 @@ -Schoenebeck Expires October 3, 2008 [Page 62] +Schoenebeck Expires March 14, 2009 [Page 62] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 effect send entity. The name does not have to be unique, but MUST be @@ -3524,9 +3524,9 @@ -Schoenebeck Expires October 3, 2008 [Page 63] +Schoenebeck Expires March 14, 2009 [Page 63] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.4.26. Removing an effect send from a sampler channel @@ -3580,9 +3580,9 @@ -Schoenebeck Expires October 3, 2008 [Page 64] +Schoenebeck Expires March 14, 2009 [Page 64] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 C: "GET FX_SENDS 0" @@ -3636,9 +3636,9 @@ -Schoenebeck Expires October 3, 2008 [Page 65] +Schoenebeck Expires March 14, 2009 [Page 65] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 character string to that setting category. At the moment the @@ -3692,9 +3692,9 @@ -Schoenebeck Expires October 3, 2008 [Page 66] +Schoenebeck Expires March 14, 2009 [Page 66] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.4.30. Changing effect send's name @@ -3748,9 +3748,9 @@ -Schoenebeck Expires October 3, 2008 [Page 67] +Schoenebeck Expires March 14, 2009 [Page 67] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 of the effect send's audio channel which should be rerouted and @@ -3804,9 +3804,9 @@ -Schoenebeck Expires October 3, 2008 [Page 68] +Schoenebeck Expires March 14, 2009 [Page 68] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) @@ -3860,9 +3860,9 @@ -Schoenebeck Expires October 3, 2008 [Page 69] +Schoenebeck Expires March 14, 2009 [Page 69] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "OK" - @@ -3886,7 +3886,59 @@ S: "OK" -6.4.34. Resetting a sampler channel +6.4.34. Sending MIDI messages to sampler channel + + The front-end can send MIDI events to specific sampler channel by + sending the following command: + + SEND CHANNEL MIDI_DATA + + Where is the sampler channel number as returned by the + "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) + command, and arguments depend on the + argument, which specifies the MIDI message type. Currently, the + following MIDI messages are supported: + + "NOTE_ON" - + + For turning on MIDI notes, where specifies the key + number and the velocity as described in the MIDI + specification. + + "NOTE_OFF" - + + For turning a currently playing MIDI note off, where + specifies the key number and the velocity as described + in the MIDI specification. + + CAUTION: This command is provided for implementations of virtual MIDI + keyboards and no realtime guarantee whatsoever will be made! + + + +Schoenebeck Expires March 14, 2009 [Page 70] + +Internet-Draft LinuxSampler Control Protocol September 2008 + + + Possible Answers: + + "OK" - + + on success + + "ERR::" - + + in case it failed, providing an appropriate error code and + error message + + Example: + + C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" + + S: "OK" + +6.4.35. Resetting a sampler channel The front-end can reset a particular sampler channel by sending the following command: @@ -3912,19 +3964,18 @@ "ERR::" - + in case it failed, providing an appropriate error code and + error message + Examples: -Schoenebeck Expires October 3, 2008 [Page 70] - -Internet-Draft LinuxSampler Control Protocol April 2008 - - in case it failed, providing an appropriate error code and - error message +Schoenebeck Expires March 14, 2009 [Page 71] + +Internet-Draft LinuxSampler Control Protocol September 2008 - Examples: @@ -3969,18 +4020,18 @@ The front-end can unregister itself if it doesn't want to receive event messages anymore by sending the following command: + UNSUBSCRIBE + Where will be replaced by the respective event that client + doesn't want to receive anymore. -Schoenebeck Expires October 3, 2008 [Page 71] - -Internet-Draft LinuxSampler Control Protocol April 2008 - UNSUBSCRIBE +Schoenebeck Expires March 14, 2009 [Page 72] + +Internet-Draft LinuxSampler Control Protocol September 2008 - Where will be replaced by the respective event that client - doesn't want to receive anymore. Possible Answers: @@ -4023,21 +4074,20 @@ usually + "ERR::" - + on syntax error, e.g. non boolean value + Examples: -Schoenebeck Expires October 3, 2008 [Page 72] - -Internet-Draft LinuxSampler Control Protocol April 2008 - - "ERR::" - - on syntax error, e.g. non boolean value +Schoenebeck Expires March 14, 2009 [Page 73] + +Internet-Draft LinuxSampler Control Protocol September 2008 - Examples: @@ -4079,16 +4129,6 @@ LinuxSampler will answer by returning the maximum number of active voices. - - - - - -Schoenebeck Expires October 3, 2008 [Page 73] - -Internet-Draft LinuxSampler Control Protocol April 2008 - - 6.6.3. Current number of active disk streams The front-end can ask for the current number of active disk streams @@ -4098,6 +4138,13 @@ Possible Answers: + + +Schoenebeck Expires March 14, 2009 [Page 74] + +Internet-Draft LinuxSampler Control Protocol September 2008 + + LinuxSampler will answer by returning the number of all active disk streams on the sampler. @@ -4137,14 +4184,6 @@ DESCRIPTION - - - - -Schoenebeck Expires October 3, 2008 [Page 74] - -Internet-Draft LinuxSampler Control Protocol April 2008 - - arbitrary textual description about the sampler (note that the character string may contain escape sequences (Section 7.1)) @@ -4153,6 +4192,15 @@ version of the sampler + + + + +Schoenebeck Expires March 14, 2009 [Page 75] + +Internet-Draft LinuxSampler Control Protocol September 2008 + + PROTOCOL_VERSION - version of the LSCP specification the sampler complies with @@ -4193,21 +4241,21 @@ Where should be replaced by the optional dotted floating point value, reflecting the new global volume parameter. This value might usually be in the range between 0.0 and 1.0, that is for + attenuating the overall volume. + Possible Answers: + "OK" - -Schoenebeck Expires October 3, 2008 [Page 75] - -Internet-Draft LinuxSampler Control Protocol April 2008 + on success - attenuating the overall volume. - Possible Answers: - "OK" - +Schoenebeck Expires March 14, 2009 [Page 76] + +Internet-Draft LinuxSampler Control Protocol September 2008 - on success "WRN::" - @@ -4250,17 +4298,20 @@ sampler to switch to the respective instrument as reflected by the current MIDI instrument map. +6.7.1. Create a new MIDI instrument map + + The front-end can add a new MIDI instrument map by sending the + following command: -Schoenebeck Expires October 3, 2008 [Page 76] - -Internet-Draft LinuxSampler Control Protocol April 2008 -6.7.1. Create a new MIDI instrument map - The front-end can add a new MIDI instrument map by sending the - following command: + +Schoenebeck Expires March 14, 2009 [Page 77] + +Internet-Draft LinuxSampler Control Protocol September 2008 + ADD MIDI_INSTRUMENT_MAP [] @@ -4306,15 +4357,17 @@ Where reflects the unique ID of the map to delete as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command. + The front-end can delete all MIDI instrument maps by sending the + following command: -Schoenebeck Expires October 3, 2008 [Page 77] - -Internet-Draft LinuxSampler Control Protocol April 2008 - The front-end can delete all MIDI instrument maps by sending the - following command: + +Schoenebeck Expires March 14, 2009 [Page 78] + +Internet-Draft LinuxSampler Control Protocol September 2008 + REMOVE MIDI_INSTRUMENT_MAP ALL @@ -4364,9 +4417,12 @@ -Schoenebeck Expires October 3, 2008 [Page 78] + + + +Schoenebeck Expires March 14, 2009 [Page 79] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 LIST MIDI_INSTRUMENT_MAPS @@ -4420,9 +4476,9 @@ -Schoenebeck Expires October 3, 2008 [Page 79] +Schoenebeck Expires March 14, 2009 [Page 80] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 C: "GET MIDI_INSTRUMENT_MAP INFO 0" @@ -4476,9 +4532,9 @@ -Schoenebeck Expires October 3, 2008 [Page 80] +Schoenebeck Expires March 14, 2009 [Page 81] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 an integer value between 0..127 reflecting the MIDI @@ -4532,9 +4588,9 @@ -Schoenebeck Expires October 3, 2008 [Page 81] +Schoenebeck Expires March 14, 2009 [Page 82] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 instrument does not exist in the InstrumentManager's list yet, @@ -4588,9 +4644,9 @@ -Schoenebeck Expires October 3, 2008 [Page 82] +Schoenebeck Expires March 14, 2009 [Page 83] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "ERR::" - @@ -4644,9 +4700,9 @@ -Schoenebeck Expires October 3, 2008 [Page 83] +Schoenebeck Expires March 14, 2009 [Page 84] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 The sampler will answer by sending the current number of entries @@ -4700,9 +4756,9 @@ -Schoenebeck Expires October 3, 2008 [Page 84] +Schoenebeck Expires March 14, 2009 [Page 85] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 UNMAP MIDI_INSTRUMENT @@ -4756,9 +4812,9 @@ -Schoenebeck Expires October 3, 2008 [Page 85] +Schoenebeck Expires March 14, 2009 [Page 86] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 mapped instrument. It can be set and changed with the "MAP @@ -4812,9 +4868,9 @@ -Schoenebeck Expires October 3, 2008 [Page 86] +Schoenebeck Expires March 14, 2009 [Page 87] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "INSTRUMENT_NR: 0" @@ -4868,9 +4924,9 @@ -Schoenebeck Expires October 3, 2008 [Page 87] +Schoenebeck Expires March 14, 2009 [Page 88] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.8. Managing Instruments Database @@ -4924,9 +4980,9 @@ -Schoenebeck Expires October 3, 2008 [Page 88] +Schoenebeck Expires March 14, 2009 [Page 89] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] @@ -4980,9 +5036,9 @@ -Schoenebeck Expires October 3, 2008 [Page 89] +Schoenebeck Expires March 14, 2009 [Page 90] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 C: "GET DB_INSTRUMENT_DIRECTORIES '/'" @@ -5036,9 +5092,9 @@ -Schoenebeck Expires October 3, 2008 [Page 90] +Schoenebeck Expires March 14, 2009 [Page 91] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 LinuxSampler will answer by sending a separated list. Each @@ -5092,9 +5148,9 @@ -Schoenebeck Expires October 3, 2008 [Page 91] +Schoenebeck Expires March 14, 2009 [Page 92] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Possible Answers: @@ -5148,9 +5204,9 @@ -Schoenebeck Expires October 3, 2008 [Page 92] +Schoenebeck Expires March 14, 2009 [Page 93] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.8.8. Copying instrument directories @@ -5204,9 +5260,9 @@ -Schoenebeck Expires October 3, 2008 [Page 93] +Schoenebeck Expires March 14, 2009 [Page 94] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "ERR::" - @@ -5260,9 +5316,9 @@ -Schoenebeck Expires October 3, 2008 [Page 94] +Schoenebeck Expires March 14, 2009 [Page 95] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 are last modified before . If is @@ -5316,9 +5372,9 @@ -Schoenebeck Expires October 3, 2008 [Page 95] +Schoenebeck Expires March 14, 2009 [Page 96] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 file is supplied, only the instruments in the specified file will be @@ -5372,9 +5428,9 @@ -Schoenebeck Expires October 3, 2008 [Page 96] +Schoenebeck Expires March 14, 2009 [Page 97] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 if an invalid path is specified. @@ -5428,9 +5484,9 @@ -Schoenebeck Expires October 3, 2008 [Page 97] +Schoenebeck Expires March 14, 2009 [Page 98] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 The current number of instruments in the specified directory. @@ -5484,9 +5540,9 @@ -Schoenebeck Expires October 3, 2008 [Page 98] +Schoenebeck Expires March 14, 2009 [Page 99] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.8.15. Getting instrument information @@ -5540,9 +5596,9 @@ -Schoenebeck Expires October 3, 2008 [Page 99] +Schoenebeck Expires March 14, 2009 [Page 100] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 MODIFIED - @@ -5596,9 +5652,9 @@ -Schoenebeck Expires October 3, 2008 [Page 100] +Schoenebeck Expires March 14, 2009 [Page 101] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "SIZE: 2050871870" @@ -5652,9 +5708,9 @@ -Schoenebeck Expires October 3, 2008 [Page 101] +Schoenebeck Expires March 14, 2009 [Page 102] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 6.8.17. Moving an instrument @@ -5708,9 +5764,9 @@ -Schoenebeck Expires October 3, 2008 [Page 102] +Schoenebeck Expires March 14, 2009 [Page 103] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 in case the given instrument does not exists, or if an @@ -5764,9 +5820,9 @@ -Schoenebeck Expires October 3, 2008 [Page 103] +Schoenebeck Expires March 14, 2009 [Page 104] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 directory to search in. If NON_RECURSIVE is specified, the @@ -5820,9 +5876,9 @@ -Schoenebeck Expires October 3, 2008 [Page 104] +Schoenebeck Expires March 14, 2009 [Page 105] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Restricts the search to instruments with product info that @@ -5876,9 +5932,9 @@ -Schoenebeck Expires October 3, 2008 [Page 105] +Schoenebeck Expires March 14, 2009 [Page 106] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 S: "'/Piano Collection/Bosendorfer 290'" @@ -5932,9 +5988,9 @@ -Schoenebeck Expires October 3, 2008 [Page 106] +Schoenebeck Expires March 14, 2009 [Page 107] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Example: @@ -5988,9 +6044,9 @@ -Schoenebeck Expires October 3, 2008 [Page 107] +Schoenebeck Expires March 14, 2009 [Page 108] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 in case it failed, providing an appropriate error code and @@ -6044,9 +6100,9 @@ -Schoenebeck Expires October 3, 2008 [Page 108] +Schoenebeck Expires March 14, 2009 [Page 109] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 At the moment there is only one command for this feature set, but @@ -6100,9 +6156,9 @@ -Schoenebeck Expires October 3, 2008 [Page 109] +Schoenebeck Expires March 14, 2009 [Page 110] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 S: "OK" @@ -6156,9 +6212,9 @@ -Schoenebeck Expires October 3, 2008 [Page 110] +Schoenebeck Expires March 14, 2009 [Page 111] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "Character Set and Escape Sequences (Section 7.1)"). @@ -6212,9 +6268,9 @@ -Schoenebeck Expires October 3, 2008 [Page 111] +Schoenebeck Expires March 14, 2009 [Page 112] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 @@ -6240,6 +6296,19 @@ artists / sample library vendor of the instrument + KEY_BINDINGS - + + comma separated list of integer values representing the + instrument's key mapping in the range between 0 .. 127, + reflecting the analog meaning of the MIDI specification. + + KEYSWITCH_BINDINGS - + + comma separated list of integer values representing the + instrument's keyswitch mapping in the range between 0 .. + 127, reflecting the analog meaning of the MIDI + specification. + The mentioned fields above don't have to be in particular order. Example: @@ -6252,6 +6321,14 @@ "FORMAT_VERSION: 3" + + + +Schoenebeck Expires March 14, 2009 [Page 113] + +Internet-Draft LinuxSampler Control Protocol September 2008 + + "PRODUCT: The Backbone Bongo Beats" "ARTISTS: Jimmy the Fish" @@ -6268,9 +6345,44 @@ -Schoenebeck Expires October 3, 2008 [Page 112] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Schoenebeck Expires March 14, 2009 [Page 114] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 7. Command Syntax @@ -6324,9 +6436,9 @@ -Schoenebeck Expires October 3, 2008 [Page 113] +Schoenebeck Expires March 14, 2009 [Page 115] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 / LIST SP list_instruction @@ -6355,6 +6467,8 @@ / FORMAT SP format_instruction + SEND SP send_instruction + / RESET / QUIT @@ -6374,17 +6488,17 @@ / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index - / DB_INSTRUMENTS SP db_path SP filename - -Schoenebeck Expires October 3, 2008 [Page 114] +Schoenebeck Expires March 14, 2009 [Page 116] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / DB_INSTRUMENTS SP db_path SP filename + / DB_INSTRUMENTS SP db_path SP filename SP instrument_index / MIDI_INSTRUMENT_MAP @@ -6431,16 +6545,16 @@ / DB_INSTRUMENT_DIRECTORY_INFO - / DB_INSTRUMENT_COUNT - -Schoenebeck Expires October 3, 2008 [Page 115] +Schoenebeck Expires March 14, 2009 [Page 117] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / DB_INSTRUMENT_COUNT + / DB_INSTRUMENT_INFO / DB_INSTRUMENTS_JOB_INFO @@ -6487,16 +6601,16 @@ / MIDI_INSTRUMENT_COUNT - / MIDI_INSTRUMENT_INFO - -Schoenebeck Expires October 3, 2008 [Page 116] +Schoenebeck Expires March 14, 2009 [Page 118] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / MIDI_INSTRUMENT_INFO + / DB_INSTRUMENT_DIRECTORY_COUNT / DB_INSTRUMENT_DIRECTORY_INFO @@ -6542,17 +6656,17 @@ / MIDI_INSTRUMENT_MAP SP midi_map - / MIDI_INSTRUMENT_MAP SP ALL - -Schoenebeck Expires October 3, 2008 [Page 117] +Schoenebeck Expires March 14, 2009 [Page 119] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / MIDI_INSTRUMENT_MAP SP ALL + / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path / DB_INSTRUMENT_DIRECTORY SP db_path @@ -6598,17 +6712,17 @@ / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string - / CHANNELS - -Schoenebeck Expires October 3, 2008 [Page 118] +Schoenebeck Expires March 14, 2009 [Page 120] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / CHANNELS + / CHANNEL SP INFO SP sampler_channel / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel @@ -6655,16 +6769,16 @@ / DB_INSTRUMENTS_JOB SP INFO SP number - / VOLUME - -Schoenebeck Expires October 3, 2008 [Page 119] +Schoenebeck Expires March 14, 2009 [Page 121] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / VOLUME + / FILE SP INSTRUMENTS SP filename / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index @@ -6711,16 +6825,16 @@ / DB_INSTRUMENT SP FILE_PATH SP filename SP filename - / ECHO SP boolean - -Schoenebeck Expires October 3, 2008 [Page 120] +Schoenebeck Expires March 14, 2009 [Page 122] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + / ECHO SP boolean + / VOLUME SP volume_value create_instruction = @@ -6770,11 +6884,9 @@ - - -Schoenebeck Expires October 3, 2008 [Page 121] +Schoenebeck Expires March 14, 2009 [Page 123] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 DB_INSTRUMENT_DIRECTORY SP db_path SP db_path @@ -6828,9 +6940,9 @@ -Schoenebeck Expires October 3, 2008 [Page 122] +Schoenebeck Expires March 14, 2009 [Page 124] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE @@ -6884,9 +6996,9 @@ -Schoenebeck Expires October 3, 2008 [Page 123] +Schoenebeck Expires March 14, 2009 [Page 125] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 / MIDI_INSTRUMENT_MAPS @@ -6903,6 +7015,11 @@ / FILE SP INSTRUMENTS SP filename + send_instruction = + + CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP + number + load_instr_args = filename SP instrument_index SP sampler_channel @@ -6931,19 +7048,20 @@ audio_output_type_name = - string - midi_input_port_index = - number +Schoenebeck Expires March 14, 2009 [Page 126] + +Internet-Draft LinuxSampler Control Protocol September 2008 -Schoenebeck Expires October 3, 2008 [Page 124] - -Internet-Draft LinuxSampler Control Protocol April 2008 + string + midi_input_port_index = + + number midi_input_channel_index = @@ -6987,19 +7105,19 @@ fx_send_id = - number - engine_name = - string +Schoenebeck Expires March 14, 2009 [Page 127] + +Internet-Draft LinuxSampler Control Protocol September 2008 + number -Schoenebeck Expires October 3, 2008 [Page 125] - -Internet-Draft LinuxSampler Control Protocol April 2008 + engine_name = + string filename = @@ -7043,19 +7161,19 @@ / query_val_list SP string '=' query_val - query_val = - text_escaped - / stringval_escaped +Schoenebeck Expires March 14, 2009 [Page 128] + +Internet-Draft LinuxSampler Control Protocol September 2008 + query_val = -Schoenebeck Expires October 3, 2008 [Page 126] - -Internet-Draft LinuxSampler Control Protocol April 2008 + text_escaped + / stringval_escaped scan_mode = @@ -7098,21 +7216,22 @@ | \OOO | three digit octal ASCII code of the | | | character | | | | - | \xHH | two digit hex ASCII code of the | - | | character | - +------------------------+------------------------------------------+ - Notice: due to the transition of certain parts of the protocol which - now support escape sequences, a slight backward incompatibility to - protocols version v1.1 and younger has been introduced. The only -Schoenebeck Expires October 3, 2008 [Page 127] +Schoenebeck Expires March 14, 2009 [Page 129] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 + | \xHH | two digit hex ASCII code of the | + | | character | + +------------------------+------------------------------------------+ + + Notice: due to the transition of certain parts of the protocol which + now support escape sequences, a slight backward incompatibility to + protocols version v1.1 and younger has been introduced. The only difference is that in parts of the protocol where escape characters are now supported, a backslash characters MUST be escaped as well (that is as double backslash), whereas in the old versions a single @@ -7154,20 +7273,19 @@ "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) - "SET DB_INSTRUMENT NAME" (Section 6.8.16) - - "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19) - "FIND DB_INSTRUMENTS" (Section 6.8.20) +Schoenebeck Expires March 14, 2009 [Page 130] + +Internet-Draft LinuxSampler Control Protocol September 2008 + "SET DB_INSTRUMENT NAME" (Section 6.8.16) -Schoenebeck Expires October 3, 2008 [Page 128] - -Internet-Draft LinuxSampler Control Protocol April 2008 + "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19) + "FIND DB_INSTRUMENTS" (Section 6.8.20) "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10) @@ -7210,20 +7328,20 @@ "GET SERVER INFO" (Section 6.6.5) - "GET ENGINE INFO" (Section 6.4.9) - "GET CHANNEL INFO" (Section 6.4.10) - "CREATE FX_SEND" (Section 6.4.25) +Schoenebeck Expires March 14, 2009 [Page 131] + +Internet-Draft LinuxSampler Control Protocol September 2008 + "GET ENGINE INFO" (Section 6.4.9) -Schoenebeck Expires October 3, 2008 [Page 129] - -Internet-Draft LinuxSampler Control Protocol April 2008 + "GET CHANNEL INFO" (Section 6.4.10) + "CREATE FX_SEND" (Section 6.4.25) "GET FX_SEND INFO" (Section 6.4.29) @@ -7270,15 +7388,9 @@ - - - - - - -Schoenebeck Expires October 3, 2008 [Page 130] +Schoenebeck Expires March 14, 2009 [Page 132] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 8. Events @@ -7332,9 +7444,9 @@ -Schoenebeck Expires October 3, 2008 [Page 131] +Schoenebeck Expires March 14, 2009 [Page 133] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "NOTIFY:MIDI_INPUT_DEVICE_COUNT:" @@ -7388,9 +7500,9 @@ -Schoenebeck Expires October 3, 2008 [Page 132] +Schoenebeck Expires March 14, 2009 [Page 134] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 "NOTIFY:CHANNEL_MIDI: NOTE_ON " @@ -7444,9 +7556,9 @@ -Schoenebeck Expires October 3, 2008 [Page 133] +Schoenebeck Expires March 14, 2009 [Page 135] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 SUBSCRIBE VOICE_COUNT @@ -7500,9 +7612,9 @@ -Schoenebeck Expires October 3, 2008 [Page 134] +Schoenebeck Expires March 14, 2009 [Page 136] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 SUBSCRIBE CHANNEL_INFO @@ -7556,9 +7668,9 @@ -Schoenebeck Expires October 3, 2008 [Page 135] +Schoenebeck Expires March 14, 2009 [Page 137] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 8.14. Total number of active voices changed @@ -7612,9 +7724,9 @@ -Schoenebeck Expires October 3, 2008 [Page 136] +Schoenebeck Expires March 14, 2009 [Page 138] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO @@ -7668,9 +7780,9 @@ -Schoenebeck Expires October 3, 2008 [Page 137] +Schoenebeck Expires March 14, 2009 [Page 139] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 8.20. Global settings changed @@ -7724,9 +7836,9 @@ -Schoenebeck Expires October 3, 2008 [Page 138] +Schoenebeck Expires March 14, 2009 [Page 140] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 directory info. Because these messages will be triggered by LSCP @@ -7780,9 +7892,9 @@ -Schoenebeck Expires October 3, 2008 [Page 139] +Schoenebeck Expires March 14, 2009 [Page 141] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 sufficient here. @@ -7836,9 +7948,9 @@ -Schoenebeck Expires October 3, 2008 [Page 140] +Schoenebeck Expires March 14, 2009 [Page 142] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 9. Security Considerations @@ -7892,9 +8004,9 @@ -Schoenebeck Expires October 3, 2008 [Page 141] +Schoenebeck Expires March 14, 2009 [Page 143] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 10. Acknowledgments @@ -7948,9 +8060,9 @@ -Schoenebeck Expires October 3, 2008 [Page 142] +Schoenebeck Expires March 14, 2009 [Page 144] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 11. References @@ -8004,9 +8116,9 @@ -Schoenebeck Expires October 3, 2008 [Page 143] +Schoenebeck Expires March 14, 2009 [Page 145] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Author's Address @@ -8060,9 +8172,9 @@ -Schoenebeck Expires October 3, 2008 [Page 144] +Schoenebeck Expires March 14, 2009 [Page 146] -Internet-Draft LinuxSampler Control Protocol April 2008 +Internet-Draft LinuxSampler Control Protocol September 2008 Full Copyright Statement @@ -8107,14 +8219,14 @@ ietf-ipr@ietf.org. +Acknowledgment + Funding for the RFC Editor function is provided by the IETF + Administrative Support Activity (IASA). - - - -Schoenebeck Expires October 3, 2008 [Page 145] +Schoenebeck Expires March 14, 2009 [Page 147]