--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt 2007/10/11 18:53:29 1399 +++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt 2007/10/11 18:59:34 1400 @@ -4,7 +4,7 @@ LinuxSampler Developers C. Schoenebeck Internet-Draft Interessengemeinschaft Software Intended status: Standards Track Engineering e. V. -Expires: April 9, 2008 October 7, 2007 +Expires: April 13, 2008 October 11, 2007 LinuxSampler Control Protocol (draft) @@ -33,7 +33,7 @@ The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. - This Internet-Draft will expire on April 9, 2008. + This Internet-Draft will expire on April 13, 2008. Copyright Notice @@ -52,7 +52,7 @@ -Schoenebeck Expires April 9, 2008 [Page 1] +Schoenebeck Expires April 13, 2008 [Page 1] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -108,7 +108,7 @@ -Schoenebeck Expires April 9, 2008 [Page 2] +Schoenebeck Expires April 13, 2008 [Page 2] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -164,7 +164,7 @@ -Schoenebeck Expires April 9, 2008 [Page 3] +Schoenebeck Expires April 13, 2008 [Page 3] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -220,7 +220,7 @@ -Schoenebeck Expires April 9, 2008 [Page 4] +Schoenebeck Expires April 13, 2008 [Page 4] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -276,7 +276,7 @@ -Schoenebeck Expires April 9, 2008 [Page 5] +Schoenebeck Expires April 13, 2008 [Page 5] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -332,7 +332,7 @@ -Schoenebeck Expires April 9, 2008 [Page 6] +Schoenebeck Expires April 13, 2008 [Page 6] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -388,7 +388,7 @@ -Schoenebeck Expires April 9, 2008 [Page 7] +Schoenebeck Expires April 13, 2008 [Page 7] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -444,7 +444,7 @@ -Schoenebeck Expires April 9, 2008 [Page 8] +Schoenebeck Expires April 13, 2008 [Page 8] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -500,7 +500,7 @@ -Schoenebeck Expires April 9, 2008 [Page 9] +Schoenebeck Expires April 13, 2008 [Page 9] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -556,7 +556,7 @@ -Schoenebeck Expires April 9, 2008 [Page 10] +Schoenebeck Expires April 13, 2008 [Page 10] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -612,7 +612,7 @@ -Schoenebeck Expires April 9, 2008 [Page 11] +Schoenebeck Expires April 13, 2008 [Page 11] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -668,7 +668,7 @@ -Schoenebeck Expires April 9, 2008 [Page 12] +Schoenebeck Expires April 13, 2008 [Page 12] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -724,7 +724,7 @@ -Schoenebeck Expires April 9, 2008 [Page 13] +Schoenebeck Expires April 13, 2008 [Page 13] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -780,7 +780,7 @@ -Schoenebeck Expires April 9, 2008 [Page 14] +Schoenebeck Expires April 13, 2008 [Page 14] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -836,7 +836,7 @@ -Schoenebeck Expires April 9, 2008 [Page 15] +Schoenebeck Expires April 13, 2008 [Page 15] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -892,7 +892,7 @@ -Schoenebeck Expires April 9, 2008 [Page 16] +Schoenebeck Expires April 13, 2008 [Page 16] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -948,7 +948,7 @@ -Schoenebeck Expires April 9, 2008 [Page 17] +Schoenebeck Expires April 13, 2008 [Page 17] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1004,7 +1004,7 @@ -Schoenebeck Expires April 9, 2008 [Page 18] +Schoenebeck Expires April 13, 2008 [Page 18] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1060,7 +1060,7 @@ -Schoenebeck Expires April 9, 2008 [Page 19] +Schoenebeck Expires April 13, 2008 [Page 19] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1116,7 +1116,7 @@ -Schoenebeck Expires April 9, 2008 [Page 20] +Schoenebeck Expires April 13, 2008 [Page 20] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1172,7 +1172,7 @@ -Schoenebeck Expires April 9, 2008 [Page 21] +Schoenebeck Expires April 13, 2008 [Page 21] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1228,7 +1228,7 @@ -Schoenebeck Expires April 9, 2008 [Page 22] +Schoenebeck Expires April 13, 2008 [Page 22] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1284,7 +1284,7 @@ -Schoenebeck Expires April 9, 2008 [Page 23] +Schoenebeck Expires April 13, 2008 [Page 23] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1340,7 +1340,7 @@ -Schoenebeck Expires April 9, 2008 [Page 24] +Schoenebeck Expires April 13, 2008 [Page 24] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1396,7 +1396,7 @@ -Schoenebeck Expires April 9, 2008 [Page 25] +Schoenebeck Expires April 13, 2008 [Page 25] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1452,7 +1452,7 @@ -Schoenebeck Expires April 9, 2008 [Page 26] +Schoenebeck Expires April 13, 2008 [Page 26] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1508,7 +1508,7 @@ -Schoenebeck Expires April 9, 2008 [Page 27] +Schoenebeck Expires April 13, 2008 [Page 27] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1564,7 +1564,7 @@ -Schoenebeck Expires April 9, 2008 [Page 28] +Schoenebeck Expires April 13, 2008 [Page 28] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1620,7 +1620,7 @@ -Schoenebeck Expires April 9, 2008 [Page 29] +Schoenebeck Expires April 13, 2008 [Page 29] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1676,7 +1676,7 @@ -Schoenebeck Expires April 9, 2008 [Page 30] +Schoenebeck Expires April 13, 2008 [Page 30] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1732,7 +1732,7 @@ -Schoenebeck Expires April 9, 2008 [Page 31] +Schoenebeck Expires April 13, 2008 [Page 31] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1788,7 +1788,7 @@ -Schoenebeck Expires April 9, 2008 [Page 32] +Schoenebeck Expires April 13, 2008 [Page 32] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1844,7 +1844,7 @@ -Schoenebeck Expires April 9, 2008 [Page 33] +Schoenebeck Expires April 13, 2008 [Page 33] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1900,7 +1900,7 @@ -Schoenebeck Expires April 9, 2008 [Page 34] +Schoenebeck Expires April 13, 2008 [Page 34] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -1956,7 +1956,7 @@ -Schoenebeck Expires April 9, 2008 [Page 35] +Schoenebeck Expires April 13, 2008 [Page 35] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2012,7 +2012,7 @@ -Schoenebeck Expires April 9, 2008 [Page 36] +Schoenebeck Expires April 13, 2008 [Page 36] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2068,7 +2068,7 @@ -Schoenebeck Expires April 9, 2008 [Page 37] +Schoenebeck Expires April 13, 2008 [Page 37] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2124,7 +2124,7 @@ -Schoenebeck Expires April 9, 2008 [Page 38] +Schoenebeck Expires April 13, 2008 [Page 38] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2180,7 +2180,7 @@ -Schoenebeck Expires April 9, 2008 [Page 39] +Schoenebeck Expires April 13, 2008 [Page 39] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2236,7 +2236,7 @@ -Schoenebeck Expires April 9, 2008 [Page 40] +Schoenebeck Expires April 13, 2008 [Page 40] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2292,7 +2292,7 @@ -Schoenebeck Expires April 9, 2008 [Page 41] +Schoenebeck Expires April 13, 2008 [Page 41] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2348,7 +2348,7 @@ -Schoenebeck Expires April 9, 2008 [Page 42] +Schoenebeck Expires April 13, 2008 [Page 42] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2404,7 +2404,7 @@ -Schoenebeck Expires April 9, 2008 [Page 43] +Schoenebeck Expires April 13, 2008 [Page 43] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2460,7 +2460,7 @@ -Schoenebeck Expires April 9, 2008 [Page 44] +Schoenebeck Expires April 13, 2008 [Page 44] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2516,7 +2516,7 @@ -Schoenebeck Expires April 9, 2008 [Page 45] +Schoenebeck Expires April 13, 2008 [Page 45] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2572,7 +2572,7 @@ -Schoenebeck Expires April 9, 2008 [Page 46] +Schoenebeck Expires April 13, 2008 [Page 46] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2628,7 +2628,7 @@ -Schoenebeck Expires April 9, 2008 [Page 47] +Schoenebeck Expires April 13, 2008 [Page 47] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2679,12 +2679,12 @@ DESCRIPTION - - arbitrary description text about the engine + arbitrary description text about the engine (note that the + character string may contain escape sequences (Section 7.1)) - -Schoenebeck Expires April 9, 2008 [Page 48] +Schoenebeck Expires April 13, 2008 [Page 48] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2740,7 +2740,7 @@ -Schoenebeck Expires April 9, 2008 [Page 49] +Schoenebeck Expires April 13, 2008 [Page 49] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -2764,7 +2764,9 @@ INSTRUMENT_FILE - the file name of the loaded instrument, "NONE" if there's no - instrument yet loaded for this sampler channel + instrument yet loaded for this sampler channel (note: since + LSCP 1.2 this path may contain escape sequences + (Section 7.1)) INSTRUMENT_NR - @@ -2772,7 +2774,9 @@ INSTRUMENT_NAME - - the instrument name of the loaded instrument + the instrument name of the loaded instrument (note: since + LSCP 1.2 this character string may contain escape sequences + (Section 7.1)) INSTRUMENT_STATUS - @@ -2788,19 +2792,19 @@ commands, "NONE" if there's no device connected to this sampler channel - MIDI_INPUT_PORT - - - port number of the MIDI input device - -Schoenebeck Expires April 9, 2008 [Page 50] +Schoenebeck Expires April 13, 2008 [Page 50] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + MIDI_INPUT_PORT - + + port number of the MIDI input device + MIDI_INPUT_CHANNEL - the MIDI input channel number this sampler channel should @@ -2844,19 +2848,19 @@ "AUDIO_OUTPUT_DEVICE: 0" - "AUDIO_OUTPUT_CHANNELS: 2" - - "AUDIO_OUTPUT_ROUTING: 0,1" - -Schoenebeck Expires April 9, 2008 [Page 51] +Schoenebeck Expires April 13, 2008 [Page 51] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + "AUDIO_OUTPUT_CHANNELS: 2" + + "AUDIO_OUTPUT_ROUTING: 0,1" + "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig" "INSTRUMENT_NR: 0" @@ -2904,15 +2908,13 @@ - - - - -Schoenebeck Expires April 9, 2008 [Page 52] +Schoenebeck Expires April 13, 2008 [Page 52] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + + 6.4.12. Current number of active disk streams The front-end can ask for the current number of active disk streams @@ -2959,16 +2961,16 @@ "NA" for *not available* in case the engine which is deployed doesn't support disk streaming. Each entry in the answer list will begin with the stream's ID in brackets followed by the - numerical representation of the fill size (either in bytes or - percentage). Note: due to efficiency reasons the fill states in -Schoenebeck Expires April 9, 2008 [Page 53] +Schoenebeck Expires April 13, 2008 [Page 53] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + numerical representation of the fill size (either in bytes or + percentage). Note: due to efficiency reasons the fill states in the response are not in particular order, thus the front-end has to sort them by itself if necessary. @@ -3013,18 +3015,21 @@ issue(s) related, providing an appropriate warning code and warning message - "ERR::" - - in case it failed, providing an appropriate error code and - error message -Schoenebeck Expires April 9, 2008 [Page 54] + +Schoenebeck Expires April 13, 2008 [Page 54] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + "ERR::" - + + in case it failed, providing an appropriate error code and + error message + Examples: @@ -3068,19 +3073,19 @@ The front-end can alter the audio output channel on a specific sampler channel by sending the following command: - SET CHANNEL AUDIO_OUTPUT_CHANNEL - - - Where is the sampler channel number as returned by the - "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) -Schoenebeck Expires April 9, 2008 [Page 55] +Schoenebeck Expires April 13, 2008 [Page 55] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + SET CHANNEL AUDIO_OUTPUT_CHANNEL + + + Where is the sampler channel number as returned by the + "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) command, is the numerical ID of the sampler channel's audio output channel which should be rerouted and is the numerical ID of the audio channel of the selected audio output device @@ -3122,21 +3127,22 @@ Possible Answers: - "OK" - - - on success - - "WRN::" - -Schoenebeck Expires April 9, 2008 [Page 56] +Schoenebeck Expires April 13, 2008 [Page 56] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + "OK" - + + on success + + "WRN::" - + if MIDI input device was set, but there are noteworthy issue(s) related, providing an appropriate warning code and warning message @@ -3179,18 +3185,16 @@ in case it failed, providing an appropriate error code and error message - Examples: - - +Schoenebeck Expires April 13, 2008 [Page 57] + +Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + Examples: -Schoenebeck Expires April 9, 2008 [Page 57] - -Internet-Draft LinuxSampler Control Protocol (draft) October 2007 6.4.19. Setting MIDI input port @@ -3237,18 +3241,18 @@ Possible Answers: - "OK" - - - on success - -Schoenebeck Expires April 9, 2008 [Page 58] +Schoenebeck Expires April 13, 2008 [Page 58] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + "OK" - + + on success + "WRN::" - if MIDI input channel was set, but there are noteworthy @@ -3293,18 +3297,16 @@ in case it failed, providing an appropriate error code and error message - Examples: - - - -Schoenebeck Expires April 9, 2008 [Page 59] +Schoenebeck Expires April 13, 2008 [Page 59] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + Examples: + 6.4.22. Muting a sampler channel @@ -3352,15 +3354,15 @@ (Section 6.4.4) command and should be replaced either by "1" to solo the channel or "0" to unsolo the channel. - Possible Answers: - -Schoenebeck Expires April 9, 2008 [Page 60] +Schoenebeck Expires April 13, 2008 [Page 60] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + Possible Answers: + "OK" - on success @@ -3407,16 +3409,16 @@ You can assign a specific MIDI instrument map by replacing with the respective numeric ID of the MIDI instrument map - as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) - command. Once that map will be deleted, the sampler channel -Schoenebeck Expires April 9, 2008 [Page 61] +Schoenebeck Expires April 13, 2008 [Page 61] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) + command. Once that map will be deleted, the sampler channel would fall back to "NONE". Read chapter "MIDI Instrument Mapping" (Section 6.7) for details @@ -3464,15 +3466,14 @@ can alter the destination channels however with "SET FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31). - Note: Create effect sends on a sampler channel only when needed, - -Schoenebeck Expires April 9, 2008 [Page 62] +Schoenebeck Expires April 13, 2008 [Page 62] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + Note: Create effect sends on a sampler channel only when needed, because having effect sends on a sampler channel will decrease runtime performance, because for implementing channel effect sends, separate (sampler channel local) audio buffers are needed to render @@ -3523,8 +3524,7 @@ - -Schoenebeck Expires April 9, 2008 [Page 63] +Schoenebeck Expires April 13, 2008 [Page 63] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3580,7 +3580,7 @@ -Schoenebeck Expires April 9, 2008 [Page 64] +Schoenebeck Expires April 13, 2008 [Page 64] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3625,7 +3625,8 @@ NAME - - name of the effect send entity + name of the effect send entity (note that this character + string may contain escape sequences (Section 7.1)) MIDI_CONTROLLER - @@ -3635,8 +3636,7 @@ - -Schoenebeck Expires April 9, 2008 [Page 65] +Schoenebeck Expires April 13, 2008 [Page 65] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3692,7 +3692,7 @@ -Schoenebeck Expires April 9, 2008 [Page 66] +Schoenebeck Expires April 13, 2008 [Page 66] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3748,7 +3748,7 @@ -Schoenebeck Expires April 9, 2008 [Page 67] +Schoenebeck Expires April 13, 2008 [Page 67] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3804,7 +3804,7 @@ -Schoenebeck Expires April 9, 2008 [Page 68] +Schoenebeck Expires April 13, 2008 [Page 68] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3860,7 +3860,7 @@ -Schoenebeck Expires April 9, 2008 [Page 69] +Schoenebeck Expires April 13, 2008 [Page 69] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3916,7 +3916,7 @@ -Schoenebeck Expires April 9, 2008 [Page 70] +Schoenebeck Expires April 13, 2008 [Page 70] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -3972,7 +3972,7 @@ -Schoenebeck Expires April 9, 2008 [Page 71] +Schoenebeck Expires April 13, 2008 [Page 71] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4028,7 +4028,7 @@ -Schoenebeck Expires April 9, 2008 [Page 72] +Schoenebeck Expires April 13, 2008 [Page 72] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4084,7 +4084,7 @@ -Schoenebeck Expires April 9, 2008 [Page 73] +Schoenebeck Expires April 13, 2008 [Page 73] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4140,7 +4140,7 @@ -Schoenebeck Expires April 9, 2008 [Page 74] +Schoenebeck Expires April 13, 2008 [Page 74] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4196,7 +4196,7 @@ -Schoenebeck Expires April 9, 2008 [Page 75] +Schoenebeck Expires April 13, 2008 [Page 75] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4252,7 +4252,7 @@ -Schoenebeck Expires April 9, 2008 [Page 76] +Schoenebeck Expires April 13, 2008 [Page 76] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4308,7 +4308,7 @@ -Schoenebeck Expires April 9, 2008 [Page 77] +Schoenebeck Expires April 13, 2008 [Page 77] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4364,7 +4364,7 @@ -Schoenebeck Expires April 9, 2008 [Page 78] +Schoenebeck Expires April 13, 2008 [Page 78] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4382,7 +4382,8 @@ NAME - custom name of the given map, which does not have to be - unique + unique (note that this character string may contain escape + sequences (Section 7.1)) DEFAULT - @@ -4419,8 +4420,7 @@ - -Schoenebeck Expires April 9, 2008 [Page 79] +Schoenebeck Expires April 13, 2008 [Page 79] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4476,7 +4476,7 @@ -Schoenebeck Expires April 9, 2008 [Page 80] +Schoenebeck Expires April 13, 2008 [Page 80] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4532,7 +4532,7 @@ -Schoenebeck Expires April 9, 2008 [Page 81] +Schoenebeck Expires April 13, 2008 [Page 81] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4588,7 +4588,7 @@ -Schoenebeck Expires April 9, 2008 [Page 82] +Schoenebeck Expires April 13, 2008 [Page 82] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4644,7 +4644,7 @@ -Schoenebeck Expires April 9, 2008 [Page 83] +Schoenebeck Expires April 13, 2008 [Page 83] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4700,7 +4700,7 @@ -Schoenebeck Expires April 9, 2008 [Page 84] +Schoenebeck Expires April 13, 2008 [Page 84] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4732,7 +4732,8 @@ name shall be used by frontends for displaying a name for this mapped instrument. It can be set and changed with the "MAP MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to - be unique. + be unique. (note that this character string may contain escape + sequences (Section 7.1)) "ENGINE_NAME" - @@ -4740,7 +4741,8 @@ "INSTRUMENT_FILE" - - File name of the instrument. + File name of the instrument (note that this path may contain + escape sequences (Section 7.1)). "INSTRUMENT_NR" - @@ -4750,17 +4752,17 @@ Name of the loaded instrument as reflected by its file. In contrast to the "NAME" field, the "INSTRUMENT_NAME" field - cannot be changed. - - + cannot be changed (note that this character string may contain -Schoenebeck Expires April 9, 2008 [Page 85] +Schoenebeck Expires April 13, 2008 [Page 85] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + escape sequences (Section 7.1)). + "LOAD_MODE" - Life time of instrument (see "MAP MIDI_INSTRUMENT" @@ -4806,17 +4808,18 @@ The front-end can clear all MIDI instrument maps, that is delete all entries of all maps by sending the following command: - CLEAR MIDI_INSTRUMENTS ALL - The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, -Schoenebeck Expires April 9, 2008 [Page 86] +Schoenebeck Expires April 13, 2008 [Page 86] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + CLEAR MIDI_INSTRUMENTS ALL + + The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, only their entries, thus the map's settings like custom name will be preservevd. @@ -4865,10 +4868,7 @@ - - - -Schoenebeck Expires April 9, 2008 [Page 87] +Schoenebeck Expires April 13, 2008 [Page 87] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4924,7 +4924,7 @@ -Schoenebeck Expires April 9, 2008 [Page 88] +Schoenebeck Expires April 13, 2008 [Page 88] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -4980,7 +4980,7 @@ -Schoenebeck Expires April 9, 2008 [Page 89] +Schoenebeck Expires April 13, 2008 [Page 89] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5036,7 +5036,7 @@ -Schoenebeck Expires April 9, 2008 [Page 90] +Schoenebeck Expires April 13, 2008 [Page 90] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5092,7 +5092,7 @@ -Schoenebeck Expires April 9, 2008 [Page 91] +Schoenebeck Expires April 13, 2008 [Page 91] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5148,7 +5148,7 @@ -Schoenebeck Expires April 9, 2008 [Page 92] +Schoenebeck Expires April 13, 2008 [Page 92] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5204,7 +5204,7 @@ -Schoenebeck Expires April 9, 2008 [Page 93] +Schoenebeck Expires April 13, 2008 [Page 93] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5260,7 +5260,7 @@ -Schoenebeck Expires April 9, 2008 [Page 94] +Schoenebeck Expires April 13, 2008 [Page 94] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5316,7 +5316,7 @@ -Schoenebeck Expires April 9, 2008 [Page 95] +Schoenebeck Expires April 13, 2008 [Page 95] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5372,7 +5372,7 @@ -Schoenebeck Expires April 9, 2008 [Page 96] +Schoenebeck Expires April 13, 2008 [Page 96] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5428,7 +5428,7 @@ -Schoenebeck Expires April 9, 2008 [Page 97] +Schoenebeck Expires April 13, 2008 [Page 97] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5484,7 +5484,7 @@ -Schoenebeck Expires April 9, 2008 [Page 98] +Schoenebeck Expires April 13, 2008 [Page 98] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5540,7 +5540,7 @@ -Schoenebeck Expires April 9, 2008 [Page 99] +Schoenebeck Expires April 13, 2008 [Page 99] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5596,7 +5596,7 @@ -Schoenebeck Expires April 9, 2008 [Page 100] +Schoenebeck Expires April 13, 2008 [Page 100] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5652,7 +5652,7 @@ -Schoenebeck Expires April 9, 2008 [Page 101] +Schoenebeck Expires April 13, 2008 [Page 101] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5708,7 +5708,7 @@ -Schoenebeck Expires April 9, 2008 [Page 102] +Schoenebeck Expires April 13, 2008 [Page 102] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5764,7 +5764,7 @@ -Schoenebeck Expires April 9, 2008 [Page 103] +Schoenebeck Expires April 13, 2008 [Page 103] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5820,7 +5820,7 @@ -Schoenebeck Expires April 9, 2008 [Page 104] +Schoenebeck Expires April 13, 2008 [Page 104] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5876,7 +5876,7 @@ -Schoenebeck Expires April 9, 2008 [Page 105] +Schoenebeck Expires April 13, 2008 [Page 105] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5932,7 +5932,7 @@ -Schoenebeck Expires April 9, 2008 [Page 106] +Schoenebeck Expires April 13, 2008 [Page 106] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -5988,7 +5988,7 @@ -Schoenebeck Expires April 9, 2008 [Page 107] +Schoenebeck Expires April 13, 2008 [Page 107] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6044,7 +6044,7 @@ -Schoenebeck Expires April 9, 2008 [Page 108] +Schoenebeck Expires April 13, 2008 [Page 108] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6100,7 +6100,7 @@ -Schoenebeck Expires April 9, 2008 [Page 109] +Schoenebeck Expires April 13, 2008 [Page 109] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6156,7 +6156,7 @@ -Schoenebeck Expires April 9, 2008 [Page 110] +Schoenebeck Expires April 13, 2008 [Page 110] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6212,7 +6212,7 @@ -Schoenebeck Expires April 9, 2008 [Page 111] +Schoenebeck Expires April 13, 2008 [Page 111] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6268,7 +6268,7 @@ -Schoenebeck Expires April 9, 2008 [Page 112] +Schoenebeck Expires April 13, 2008 [Page 112] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6324,7 +6324,7 @@ -Schoenebeck Expires April 9, 2008 [Page 113] +Schoenebeck Expires April 13, 2008 [Page 113] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6380,7 +6380,7 @@ -Schoenebeck Expires April 9, 2008 [Page 114] +Schoenebeck Expires April 13, 2008 [Page 114] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6436,7 +6436,7 @@ -Schoenebeck Expires April 9, 2008 [Page 115] +Schoenebeck Expires April 13, 2008 [Page 115] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6492,7 +6492,7 @@ -Schoenebeck Expires April 9, 2008 [Page 116] +Schoenebeck Expires April 13, 2008 [Page 116] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6548,7 +6548,7 @@ -Schoenebeck Expires April 9, 2008 [Page 117] +Schoenebeck Expires April 13, 2008 [Page 117] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6604,7 +6604,7 @@ -Schoenebeck Expires April 9, 2008 [Page 118] +Schoenebeck Expires April 13, 2008 [Page 118] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6660,7 +6660,7 @@ -Schoenebeck Expires April 9, 2008 [Page 119] +Schoenebeck Expires April 13, 2008 [Page 119] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6716,7 +6716,7 @@ -Schoenebeck Expires April 9, 2008 [Page 120] +Schoenebeck Expires April 13, 2008 [Page 120] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6772,7 +6772,7 @@ -Schoenebeck Expires April 9, 2008 [Page 121] +Schoenebeck Expires April 13, 2008 [Page 121] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6828,7 +6828,7 @@ -Schoenebeck Expires April 9, 2008 [Page 122] +Schoenebeck Expires April 13, 2008 [Page 122] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -6869,26 +6869,32 @@ backslash was sufficient. The following LSCP commands support escape sequences as part of their - filename / path based arguments: + filename / path based arguments and / or may contain a filename / + path with escape sequences in their response: "LOAD INSTRUMENT" (Section 6.4.1) - "MAP MIDI_INSTRUMENT" (Section 6.7.7) + "GET CHANNEL INFO" (Section 6.4.10) - "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1) + "MAP MIDI_INSTRUMENT" (Section 6.7.7) - "ADD DB_INSTRUMENTS" (Section 6.8.11) + "GET MIDI_INSTRUMENT INFO" (Section 6.7.11) - "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2) -Schoenebeck Expires April 9, 2008 [Page 123] +Schoenebeck Expires April 13, 2008 [Page 123] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 + "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1) + + "ADD DB_INSTRUMENTS" (Section 6.8.11) + + "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2) + "REMOVE DB_INSTRUMENT" (Section 6.8.12) "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3) @@ -6931,61 +6937,55 @@ respective octal escape sequence ("\057"). The following LSCP commands even support escape sequences as part of - at least one of their text-based arguments (i.e. entity name, - description): - "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1) - - - -Schoenebeck Expires April 9, 2008 [Page 124] +Schoenebeck Expires April 13, 2008 [Page 124] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 - "MAP MIDI_INSTRUMENT" (Section 6.7.7) - - "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6) - - "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) - - "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_INSTRUMENT_DIRECTORIES" (Section 6.8.10) - - Please note that these lists are manually maintained. If you find a - command that also supports escape sequences we forgot to mention - here, please report it! - - - - - - + at least one of their text-based arguments (i.e. entity name, + description) and / or may contain escape sequences in at least one of + their text-based fields in their response: + "GET SERVER INFO" (Section 6.6.4) + "GET ENGINE INFO" (Section 6.4.9) + "GET CHANNEL INFO" (Section 6.4.10) + "CREATE FX_SEND" (Section 6.4.25) + "GET FX_SEND INFO" (Section 6.4.29) + "SET FX_SEND NAME" (Section 6.4.30) + "GET MIDI_INSTRUMENT INFO" (Section 6.7.11) + "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5) + "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1) + "MAP MIDI_INSTRUMENT" (Section 6.7.7) + "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6) + "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) + "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) + "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10) + "SET DB_INSTRUMENT NAME" (Section 6.8.16) + "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19) + "FIND DB_INSTRUMENTS" (Section 6.8.20) + Please note that these lists are manually maintained. If you find a + command that also supports escape sequences we forgot to mention + here, please report it! @@ -6996,7 +6996,7 @@ -Schoenebeck Expires April 9, 2008 [Page 125] +Schoenebeck Expires April 13, 2008 [Page 125] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7052,7 +7052,7 @@ -Schoenebeck Expires April 9, 2008 [Page 126] +Schoenebeck Expires April 13, 2008 [Page 126] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7108,7 +7108,7 @@ -Schoenebeck Expires April 9, 2008 [Page 127] +Schoenebeck Expires April 13, 2008 [Page 127] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7164,7 +7164,7 @@ -Schoenebeck Expires April 9, 2008 [Page 128] +Schoenebeck Expires April 13, 2008 [Page 128] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7220,7 +7220,7 @@ -Schoenebeck Expires April 9, 2008 [Page 129] +Schoenebeck Expires April 13, 2008 [Page 129] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7276,7 +7276,7 @@ -Schoenebeck Expires April 9, 2008 [Page 130] +Schoenebeck Expires April 13, 2008 [Page 130] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7332,7 +7332,7 @@ -Schoenebeck Expires April 9, 2008 [Page 131] +Schoenebeck Expires April 13, 2008 [Page 131] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7388,7 +7388,7 @@ -Schoenebeck Expires April 9, 2008 [Page 132] +Schoenebeck Expires April 13, 2008 [Page 132] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7444,7 +7444,7 @@ -Schoenebeck Expires April 9, 2008 [Page 133] +Schoenebeck Expires April 13, 2008 [Page 133] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7500,7 +7500,7 @@ -Schoenebeck Expires April 9, 2008 [Page 134] +Schoenebeck Expires April 13, 2008 [Page 134] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7556,7 +7556,7 @@ -Schoenebeck Expires April 9, 2008 [Page 135] +Schoenebeck Expires April 13, 2008 [Page 135] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7612,7 +7612,7 @@ -Schoenebeck Expires April 9, 2008 [Page 136] +Schoenebeck Expires April 13, 2008 [Page 136] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7668,7 +7668,7 @@ -Schoenebeck Expires April 9, 2008 [Page 137] +Schoenebeck Expires April 13, 2008 [Page 137] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7724,7 +7724,7 @@ -Schoenebeck Expires April 9, 2008 [Page 138] +Schoenebeck Expires April 13, 2008 [Page 138] Internet-Draft LinuxSampler Control Protocol (draft) October 2007 @@ -7780,6 +7780,6 @@ -Schoenebeck Expires April 9, 2008 [Page 139] +Schoenebeck Expires April 13, 2008 [Page 139]