16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
18 |
|
|
19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.2cvs"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol (draft)</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
23 |
Schoenebeck'> |
Schoenebeck'> |
24 |
<organization> |
<organization> |
34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="March" year="2007"/> |
<date month="September" year="2007"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
61 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
62 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
63 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
64 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <xref target="RFC20"/>), |
65 |
example:</t> |
thus the following example:</t> |
66 |
|
|
67 |
<t> |
<t> |
68 |
<list> |
<list> |
2061 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
2062 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2064 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
2065 |
|
for specifying no value for parameters allowing a list of values.</t> |
2066 |
|
|
2067 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2068 |
<t> |
<t> |
2089 |
<t>Example:</t> |
<t>Example:</t> |
2090 |
<t> |
<t> |
2091 |
<list> |
<list> |
2092 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
2093 |
|
<t>S: "OK"</t> |
2094 |
|
</list> |
2095 |
|
</t> |
2096 |
|
<t> |
2097 |
|
<list> |
2098 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
2099 |
|
<t>S: "OK"</t> |
2100 |
</list> |
</list> |
2101 |
</t> |
</t> |
2102 |
</section> |
</section> |
2121 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2122 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2123 |
|
|
2124 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2125 |
|
escape characters for special characters (see chapter |
2126 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2127 |
|
for details) and accordingly backslash characters in the filename |
2128 |
|
MUST now be escaped as well!</t> |
2129 |
|
|
2130 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
2131 |
is that the regular command returns OK only after the instrument has been |
is that the regular command returns OK only after the instrument has been |
2132 |
fully loaded and the channel is ready to be used while NON_MODAL version |
fully loaded and the channel is ready to be used while NON_MODAL version |
3959 |
<list> |
<list> |
3960 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
3961 |
<list> |
<list> |
3962 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
3963 |
|
(note that the character string may contain |
3964 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3965 |
</list> |
</list> |
3966 |
</t> |
</t> |
3967 |
<t>VERSION - |
<t>VERSION - |
3975 |
complies with (see <xref target="LSCP versioning" /> for details)</t> |
complies with (see <xref target="LSCP versioning" /> for details)</t> |
3976 |
</list> |
</list> |
3977 |
</t> |
</t> |
3978 |
|
<t>INSTRUMENTS_DB_SUPPORT - |
3979 |
|
<list> |
3980 |
|
<t>either yes or no, specifies whether the |
3981 |
|
sampler is build with instruments database support.</t> |
3982 |
|
</list> |
3983 |
|
</t> |
3984 |
</list> |
</list> |
3985 |
</t> |
</t> |
3986 |
</list> |
</list> |
4341 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
4342 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4343 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
4344 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
4345 |
|
supporting escape sequences as described in chapter |
4346 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
4347 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4348 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4349 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
4425 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
4426 |
mode by i.e. sending |
mode by i.e. sending |
4427 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4428 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
4429 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
4430 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
4431 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
4432 |
mapped instruments (using |
mapped instruments (using |
4433 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4434 |
</t> |
</t> |
4759 |
</section> |
</section> |
4760 |
</section> |
</section> |
4761 |
|
|
4762 |
|
|
4763 |
|
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
4764 |
|
<t>The following commands describe how to use and manage |
4765 |
|
the instruments database.</t> |
4766 |
|
<t>Notice:</t> |
4767 |
|
<t> |
4768 |
|
<list> |
4769 |
|
<t>All command arguments representing a path or |
4770 |
|
instrument/directory name support escape sequences as described in chapter |
4771 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
4772 |
|
</t> |
4773 |
|
<t>All occurrences of a forward slash in instrument and directory |
4774 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
4775 |
|
</t> |
4776 |
|
</list> |
4777 |
|
</t> |
4778 |
|
|
4779 |
|
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
4780 |
|
<t>The front-end can add a new instrument directory to the |
4781 |
|
instruments database by sending the following command:</t> |
4782 |
|
<t> |
4783 |
|
<list> |
4784 |
|
<t>ADD DB_INSTRUMENT_DIRECTORY <dir></t> |
4785 |
|
</list> |
4786 |
|
</t> |
4787 |
|
<t>Where <dir> is the absolute path name of the directory |
4788 |
|
to be created (encapsulated into apostrophes).</t> |
4789 |
|
|
4790 |
|
<t>Possible Answers:</t> |
4791 |
|
<t> |
4792 |
|
<list> |
4793 |
|
<t>"OK" - |
4794 |
|
<list> |
4795 |
|
<t>on success</t> |
4796 |
|
</list> |
4797 |
|
</t> |
4798 |
|
<t>"ERR:<error-code>:<error-message>" - |
4799 |
|
<list> |
4800 |
|
<t>when the directory could not be created, which |
4801 |
|
can happen if the directory already exists or the |
4802 |
|
name contains not allowed symbols</t> |
4803 |
|
</list> |
4804 |
|
</t> |
4805 |
|
</list> |
4806 |
|
</t> |
4807 |
|
|
4808 |
|
<t>Examples:</t> |
4809 |
|
<t> |
4810 |
|
<list> |
4811 |
|
<t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t> |
4812 |
|
<t>S: "OK"</t> |
4813 |
|
</list> |
4814 |
|
</t> |
4815 |
|
</section> |
4816 |
|
|
4817 |
|
<section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY"> |
4818 |
|
<t>The front-end can delete a particular instrument directory |
4819 |
|
from the instruments database by sending the following command:</t> |
4820 |
|
<t> |
4821 |
|
<list> |
4822 |
|
<t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir></t> |
4823 |
|
</list> |
4824 |
|
</t> |
4825 |
|
<t>Where <dir> is the absolute path name of the directory |
4826 |
|
to delete. The optional FORCE argument can be used to |
4827 |
|
force the deletion of a non-empty directory and all its content.</t> |
4828 |
|
|
4829 |
|
<t>Possible Answers:</t> |
4830 |
|
<t> |
4831 |
|
<list> |
4832 |
|
<t>"OK" - |
4833 |
|
<list> |
4834 |
|
<t>if the directory is deleted successfully</t> |
4835 |
|
</list> |
4836 |
|
</t> |
4837 |
|
<t>"ERR:<error-code>:<error-message>" - |
4838 |
|
<list> |
4839 |
|
<t>if the given directory does not exist, or |
4840 |
|
if trying to delete a non-empty directory, |
4841 |
|
without using the FORCE argument.</t> |
4842 |
|
</list> |
4843 |
|
</t> |
4844 |
|
</list> |
4845 |
|
</t> |
4846 |
|
|
4847 |
|
<t>Examples:</t> |
4848 |
|
<t> |
4849 |
|
<list> |
4850 |
|
<t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t> |
4851 |
|
<t>S: "OK"</t> |
4852 |
|
</list> |
4853 |
|
</t> |
4854 |
|
</section> |
4855 |
|
|
4856 |
|
<section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES"> |
4857 |
|
<t>The front-end can retrieve the current amount of |
4858 |
|
directories in a specific directory by sending the following command:</t> |
4859 |
|
<t> |
4860 |
|
<list> |
4861 |
|
<t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
4862 |
|
</list> |
4863 |
|
</t> |
4864 |
|
<t>Where <dir> should be replaced by the absolute path |
4865 |
|
name of the directory. If RECURSIVE is specified, the number of |
4866 |
|
all directories, including those located in subdirectories of the |
4867 |
|
specified directory, will be returned.</t> |
4868 |
|
|
4869 |
|
<t>Possible Answers:</t> |
4870 |
|
<t> |
4871 |
|
<list> |
4872 |
|
<t>The current number of instrument directories |
4873 |
|
in the specified directory.</t> |
4874 |
|
<t>"ERR:<error-code>:<error-message>" - |
4875 |
|
<list> |
4876 |
|
<t>if the given directory does not exist.</t> |
4877 |
|
</list> |
4878 |
|
</t> |
4879 |
|
</list> |
4880 |
|
</t> |
4881 |
|
|
4882 |
|
<t>Example:</t> |
4883 |
|
<t> |
4884 |
|
<list> |
4885 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t> |
4886 |
|
<t>S: "2"</t> |
4887 |
|
</list> |
4888 |
|
</t> |
4889 |
|
</section> |
4890 |
|
|
4891 |
|
<section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES"> |
4892 |
|
<t>The front-end can retrieve the current list of directories |
4893 |
|
in specific directory by sending the following command:</t> |
4894 |
|
<t> |
4895 |
|
<list> |
4896 |
|
<t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
4897 |
|
</list> |
4898 |
|
</t> |
4899 |
|
<t>Where <dir> should be replaced by the absolute path |
4900 |
|
name of the directory. If RECURSIVE is specified, the absolute path names |
4901 |
|
of all directories, including those located in subdirectories of the |
4902 |
|
specified directory, will be returned.</t> |
4903 |
|
|
4904 |
|
<t>Possible Answers:</t> |
4905 |
|
<t> |
4906 |
|
<list> |
4907 |
|
<t>A comma separated list of all instrument directories |
4908 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
4909 |
|
<t>"ERR:<error-code>:<error-message>" - |
4910 |
|
<list> |
4911 |
|
<t>if the given directory does not exist.</t> |
4912 |
|
</list> |
4913 |
|
</t> |
4914 |
|
</list> |
4915 |
|
</t> |
4916 |
|
<t>Example:</t> |
4917 |
|
<t> |
4918 |
|
<list> |
4919 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t> |
4920 |
|
<t>S: "'Piano Collection','Percussion Collection'"</t> |
4921 |
|
</list> |
4922 |
|
</t> |
4923 |
|
<t> |
4924 |
|
<list> |
4925 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t> |
4926 |
|
<t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t> |
4927 |
|
</list> |
4928 |
|
</t> |
4929 |
|
</section> |
4930 |
|
|
4931 |
|
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
4932 |
|
<t>The front-end can ask for the current settings of an |
4933 |
|
instrument directory by sending the following command:</t> |
4934 |
|
<t> |
4935 |
|
<list> |
4936 |
|
<t>GET DB_INSTRUMENT_DIRECTORY INFO <dir></t> |
4937 |
|
</list> |
4938 |
|
</t> |
4939 |
|
<t>Where <dir> should be replaced by the absolute path |
4940 |
|
name of the directory the front-end is interested in.</t> |
4941 |
|
|
4942 |
|
<t>Possible Answers:</t> |
4943 |
|
<t> |
4944 |
|
<list> |
4945 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
4946 |
|
Each answer line begins with the settings category name |
4947 |
|
followed by a colon and then a space character <SP> and finally |
4948 |
|
the info character string to that setting category. At the |
4949 |
|
moment the following categories are defined:</t> |
4950 |
|
|
4951 |
|
<t> |
4952 |
|
<list> |
4953 |
|
<t>DESCRIPTION - |
4954 |
|
<list> |
4955 |
|
<t>A brief description of the directory content. |
4956 |
|
Note that the character string may contain |
4957 |
|
<xref target="character_set">escape sequences</xref>.</t> |
4958 |
|
</list> |
4959 |
|
</t> |
4960 |
|
<t>CREATED - |
4961 |
|
<list> |
4962 |
|
<t>The creation date and time of the directory, |
4963 |
|
represented in "YYYY-MM-DD HH:MM:SS" format</t> |
4964 |
|
</list> |
4965 |
|
</t> |
4966 |
|
<t>MODIFIED - |
4967 |
|
<list> |
4968 |
|
<t>The date and time of the last modification of the |
4969 |
|
directory, represented in "YYYY-MM-DD HH:MM:SS" format</t> |
4970 |
|
</list> |
4971 |
|
</t> |
4972 |
|
</list> |
4973 |
|
</t> |
4974 |
|
</list> |
4975 |
|
</t> |
4976 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
4977 |
|
|
4978 |
|
<t>Example:</t> |
4979 |
|
<t> |
4980 |
|
<list> |
4981 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t> |
4982 |
|
<t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t> |
4983 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
4984 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
4985 |
|
<t> "."</t> |
4986 |
|
</list> |
4987 |
|
</t> |
4988 |
|
</section> |
4989 |
|
|
4990 |
|
<section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME"> |
4991 |
|
<t>The front-end can alter the name of a specific |
4992 |
|
instrument directory by sending the following command:</t> |
4993 |
|
<t> |
4994 |
|
<list> |
4995 |
|
<t>SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name></t> |
4996 |
|
</list> |
4997 |
|
</t> |
4998 |
|
<t>Where <dir> is the absolute path name of the directory and |
4999 |
|
<name> is the new name for that directory.</t> |
5000 |
|
|
5001 |
|
<t>Possible Answers:</t> |
5002 |
|
<t> |
5003 |
|
<list> |
5004 |
|
<t>"OK" - |
5005 |
|
<list> |
5006 |
|
<t>on success</t> |
5007 |
|
</list> |
5008 |
|
</t> |
5009 |
|
<t>"ERR:<error-code>:<error-message>" - |
5010 |
|
<list> |
5011 |
|
<t>in case the given directory does not exists, |
5012 |
|
or if a directory with name equal to the new |
5013 |
|
name already exists.</t> |
5014 |
|
</list> |
5015 |
|
</t> |
5016 |
|
</list> |
5017 |
|
</t> |
5018 |
|
|
5019 |
|
<t>Example:</t> |
5020 |
|
<t> |
5021 |
|
<list> |
5022 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t> |
5023 |
|
<t>S: "OK"</t> |
5024 |
|
</list> |
5025 |
|
</t> |
5026 |
|
</section> |
5027 |
|
|
5028 |
|
<section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY"> |
5029 |
|
<t>The front-end can move a specific |
5030 |
|
instrument directory by sending the following command:</t> |
5031 |
|
<t> |
5032 |
|
<list> |
5033 |
|
<t>MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5034 |
|
</list> |
5035 |
|
</t> |
5036 |
|
<t>Where <dir> is the absolute path name of the directory |
5037 |
|
to move and <dst> is the location where the directory will |
5038 |
|
be moved to.</t> |
5039 |
|
|
5040 |
|
<t>Possible Answers:</t> |
5041 |
|
<t> |
5042 |
|
<list> |
5043 |
|
<t>"OK" - |
5044 |
|
<list> |
5045 |
|
<t>on success</t> |
5046 |
|
</list> |
5047 |
|
</t> |
5048 |
|
<t>"ERR:<error-code>:<error-message>" - |
5049 |
|
<list> |
5050 |
|
<t>in case a given directory does not exists, |
5051 |
|
or if a directory with name equal to the name |
5052 |
|
of the specified directory already exists in |
5053 |
|
the destination directory. Error is also thrown |
5054 |
|
when trying to move a directory to a subdirectory |
5055 |
|
of itself.</t> |
5056 |
|
</list> |
5057 |
|
</t> |
5058 |
|
</list> |
5059 |
|
</t> |
5060 |
|
|
5061 |
|
<t>Example:</t> |
5062 |
|
<t> |
5063 |
|
<list> |
5064 |
|
<t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t> |
5065 |
|
<t>S: "OK"</t> |
5066 |
|
</list> |
5067 |
|
</t> |
5068 |
|
</section> |
5069 |
|
|
5070 |
|
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY"> |
5071 |
|
<t>The front-end can copy a specific |
5072 |
|
instrument directory by sending the following command:</t> |
5073 |
|
<t> |
5074 |
|
<list> |
5075 |
|
<t>COPY DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5076 |
|
</list> |
5077 |
|
</t> |
5078 |
|
<t>Where <dir> is the absolute path name of the directory |
5079 |
|
to copy and <dst> is the location where the directory will |
5080 |
|
be copied to.</t> |
5081 |
|
|
5082 |
|
<t>Possible Answers:</t> |
5083 |
|
<t> |
5084 |
|
<list> |
5085 |
|
<t>"OK" - |
5086 |
|
<list> |
5087 |
|
<t>on success</t> |
5088 |
|
</list> |
5089 |
|
</t> |
5090 |
|
<t>"ERR:<error-code>:<error-message>" - |
5091 |
|
<list> |
5092 |
|
<t>in case a given directory does not exists, |
5093 |
|
or if a directory with name equal to the name |
5094 |
|
of the specified directory already exists in |
5095 |
|
the destination directory. Error is also thrown |
5096 |
|
when trying to copy a directory to a subdirectory |
5097 |
|
of itself.</t> |
5098 |
|
</list> |
5099 |
|
</t> |
5100 |
|
</list> |
5101 |
|
</t> |
5102 |
|
|
5103 |
|
<t>Example:</t> |
5104 |
|
<t> |
5105 |
|
<list> |
5106 |
|
<t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t> |
5107 |
|
<t>S: "OK"</t> |
5108 |
|
</list> |
5109 |
|
</t> |
5110 |
|
</section> |
5111 |
|
|
5112 |
|
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
5113 |
|
<t>The front-end can alter the description of a specific |
5114 |
|
instrument directory by sending the following command:</t> |
5115 |
|
<t> |
5116 |
|
<list> |
5117 |
|
<t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc></t> |
5118 |
|
</list> |
5119 |
|
</t> |
5120 |
|
<t>Where <dir> is the absolute path name of the directory and |
5121 |
|
<desc> is the new description for the directory |
5122 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5123 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5124 |
|
|
5125 |
|
<t>Possible Answers:</t> |
5126 |
|
<t> |
5127 |
|
<list> |
5128 |
|
<t>"OK" - |
5129 |
|
<list> |
5130 |
|
<t>on success</t> |
5131 |
|
</list> |
5132 |
|
</t> |
5133 |
|
<t>"ERR:<error-code>:<error-message>" - |
5134 |
|
<list> |
5135 |
|
<t>in case the given directory does not exists.</t> |
5136 |
|
</list> |
5137 |
|
</t> |
5138 |
|
</list> |
5139 |
|
</t> |
5140 |
|
|
5141 |
|
<t>Example:</t> |
5142 |
|
<t> |
5143 |
|
<list> |
5144 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t> |
5145 |
|
<t>S: "OK"</t> |
5146 |
|
</list> |
5147 |
|
</t> |
5148 |
|
</section> |
5149 |
|
|
5150 |
|
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES"> |
5151 |
|
<t>The front-end can search for directories |
5152 |
|
in specific directory by sending the following command:</t> |
5153 |
|
<t> |
5154 |
|
<list> |
5155 |
|
<t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-list></t> |
5156 |
|
</list> |
5157 |
|
</t> |
5158 |
|
<t>Where <dir> should be replaced by the absolute path |
5159 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
5160 |
|
directories located in subdirectories of the specified directory will not |
5161 |
|
be searched. <criteria-list> is a list of search criterias |
5162 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
5163 |
|
allowed:</t> |
5164 |
|
<t> |
5165 |
|
<t>NAME='<search-string>' |
5166 |
|
<list> |
5167 |
|
<t>Restricts the search to directories, which names |
5168 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
5169 |
|
supporting escape sequences as described in chapter |
5170 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5171 |
|
</list> |
5172 |
|
</t> |
5173 |
|
|
5174 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
5175 |
|
<list> |
5176 |
|
<t>Restricts the search to directories, which creation |
5177 |
|
date satisfies the specified period, where <date-after> |
5178 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
5179 |
|
If <date-after> is omitted the search is restricted to |
5180 |
|
directories created before <date-before>. If |
5181 |
|
<date-before> is omitted, the search is restricted |
5182 |
|
to directories created after <date-after>.</t> |
5183 |
|
</list> |
5184 |
|
</t> |
5185 |
|
|
5186 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
5187 |
|
<list> |
5188 |
|
<t>Restricts the search to directories, which |
5189 |
|
date of last modification satisfies the specified period, where |
5190 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
5191 |
|
format. If <date-after> is omitted the search is restricted to |
5192 |
|
directories, which are last modified before <date-before>. If |
5193 |
|
<date-before> is omitted, the search is restricted to directories, |
5194 |
|
which are last modified after <date-after>.</t> |
5195 |
|
</list> |
5196 |
|
</t> |
5197 |
|
|
5198 |
|
<t>DESCRIPTION='<search-string>' |
5199 |
|
<list> |
5200 |
|
<t>Restricts the search to directories with description |
5201 |
|
that satisfies the supplied search string |
5202 |
|
(encapsulated into apostrophes, supporting escape |
5203 |
|
sequences as described in chapter |
5204 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5205 |
|
</list> |
5206 |
|
</t> |
5207 |
|
</t> |
5208 |
|
|
5209 |
|
<t>Where <search-string> is either a regular expression, or a |
5210 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
5211 |
|
|
5212 |
|
<t>Possible Answers:</t> |
5213 |
|
<t> |
5214 |
|
<list> |
5215 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
5216 |
|
apostrophes) of all directories in the specified directory that satisfy |
5217 |
|
the supplied search criterias.</t> |
5218 |
|
<t>"ERR:<error-code>:<error-message>" - |
5219 |
|
<list> |
5220 |
|
<t>if the given directory does not exist.</t> |
5221 |
|
</list> |
5222 |
|
</t> |
5223 |
|
</list> |
5224 |
|
</t> |
5225 |
|
<t>Example:</t> |
5226 |
|
<t> |
5227 |
|
<list> |
5228 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t> |
5229 |
|
<t>S: "'/Piano Collection'"</t> |
5230 |
|
</list> |
5231 |
|
</t> |
5232 |
|
<t> |
5233 |
|
<list> |
5234 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t> |
5235 |
|
<t>S: "'/Piano Collection','/Percussions'"</t> |
5236 |
|
</list> |
5237 |
|
</t> |
5238 |
|
</section> |
5239 |
|
|
5240 |
|
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
5241 |
|
<t>The front-end can add one or more instruments |
5242 |
|
to the instruments database by sending the following command:</t> |
5243 |
|
<t> |
5244 |
|
<list> |
5245 |
|
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
5246 |
|
</list> |
5247 |
|
</t> |
5248 |
|
<t>Where <db_dir> is the absolute path name of a directory |
5249 |
|
(encapsulated into apostrophes) in the instruments database in which |
5250 |
|
only the new instruments (that are not already in the database) will |
5251 |
|
be added, <file_path> is the absolute path name of a file or |
5252 |
|
directory in the file system (encapsulated into apostrophes). In case |
5253 |
|
an instrument file is supplied, only the instruments in the specified |
5254 |
|
file will be added to the instruments database. If the optional |
5255 |
|
<instr_index> (the index of the instrument within the given file) |
5256 |
|
is supplied too, then only the specified instrument will be added. |
5257 |
|
In case a directory is supplied, the instruments in that directory |
5258 |
|
will be added. The OPTIONAL <mode> argument is only applied |
5259 |
|
when a directory is provided as <file_path> and specifies how the |
5260 |
|
scanning will be done and has exactly the following possibilities:</t> |
5261 |
|
<t> |
5262 |
|
<list> |
5263 |
|
<t>"RECURSIVE" - |
5264 |
|
<list> |
5265 |
|
<t>All instruments will be processed, including those |
5266 |
|
in the subdirectories, and the respective subdirectory |
5267 |
|
tree structure will be recreated in the instruments |
5268 |
|
database</t> |
5269 |
|
</list> |
5270 |
|
</t> |
5271 |
|
<t>"NON_RECURSIVE" - |
5272 |
|
<list> |
5273 |
|
<t>Only the instruments in the specified directory |
5274 |
|
will be added, the instruments in the subdirectories |
5275 |
|
will not be processed.</t> |
5276 |
|
</list> |
5277 |
|
</t> |
5278 |
|
<t>"FLAT" - |
5279 |
|
<list> |
5280 |
|
<t>All instruments will be processed, including those |
5281 |
|
in the subdirectories, but the respective subdirectory |
5282 |
|
structure will not be recreated in the instruments |
5283 |
|
database. All instruments will be added directly in |
5284 |
|
the specified database directory.</t> |
5285 |
|
</list> |
5286 |
|
</t> |
5287 |
|
</list> |
5288 |
|
</t> |
5289 |
|
|
5290 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5291 |
|
is that the regular command returns when the scanning is finished |
5292 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5293 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5294 |
|
command can be used to monitor the scanning progress.</t> |
5295 |
|
|
5296 |
|
<t>Possible Answers:</t> |
5297 |
|
<t> |
5298 |
|
<list> |
5299 |
|
<t>"OK" - |
5300 |
|
<list> |
5301 |
|
<t>on success when NON_MODAL is not supplied</t> |
5302 |
|
</list> |
5303 |
|
</t> |
5304 |
|
<t>"OK[<job-id>]" - |
5305 |
|
<list> |
5306 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5307 |
|
is a numerical ID used to obtain status information about the job progress. |
5308 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5309 |
|
</t> |
5310 |
|
</list> |
5311 |
|
</t> |
5312 |
|
<t>"ERR:<error-code>:<error-message>" - |
5313 |
|
<list> |
5314 |
|
<t>if an invalid path is specified.</t> |
5315 |
|
</list> |
5316 |
|
</t> |
5317 |
|
</list> |
5318 |
|
</t> |
5319 |
|
|
5320 |
|
<t>Examples:</t> |
5321 |
|
<t> |
5322 |
|
<list> |
5323 |
|
<t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t> |
5324 |
|
<t>S: "OK"</t> |
5325 |
|
</list> |
5326 |
|
</t> |
5327 |
|
</section> |
5328 |
|
|
5329 |
|
<section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT"> |
5330 |
|
<t>The front-end can remove a particular instrument |
5331 |
|
from the instruments database by sending the following command:</t> |
5332 |
|
<t> |
5333 |
|
<list> |
5334 |
|
<t>REMOVE DB_INSTRUMENT <instr_path></t> |
5335 |
|
</list> |
5336 |
|
</t> |
5337 |
|
<t>Where <instr_path> is the absolute path name |
5338 |
|
(in the instruments database) of the instrument to remove.</t> |
5339 |
|
|
5340 |
|
<t>Possible Answers:</t> |
5341 |
|
<t> |
5342 |
|
<list> |
5343 |
|
<t>"OK" - |
5344 |
|
<list> |
5345 |
|
<t>if the instrument is removed successfully</t> |
5346 |
|
</list> |
5347 |
|
</t> |
5348 |
|
<t>"ERR:<error-code>:<error-message>" - |
5349 |
|
<list> |
5350 |
|
<t>if the given path does not exist or |
5351 |
|
is a directory.</t> |
5352 |
|
</list> |
5353 |
|
</t> |
5354 |
|
</list> |
5355 |
|
</t> |
5356 |
|
|
5357 |
|
<t>Examples:</t> |
5358 |
|
<t> |
5359 |
|
<list> |
5360 |
|
<t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t> |
5361 |
|
<t>S: "OK"</t> |
5362 |
|
</list> |
5363 |
|
</t> |
5364 |
|
</section> |
5365 |
|
|
5366 |
|
<section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS"> |
5367 |
|
<t>The front-end can retrieve the current amount of |
5368 |
|
instruments in a specific directory by sending the following command:</t> |
5369 |
|
<t> |
5370 |
|
<list> |
5371 |
|
<t>GET DB_INSTRUMENTS [RECURSIVE] <dir></t> |
5372 |
|
</list> |
5373 |
|
</t> |
5374 |
|
<t>Where <dir> should be replaced by the absolute path name |
5375 |
|
of the directory. If RECURSIVE is specified, the number of all |
5376 |
|
instruments, including those located in subdirectories of the |
5377 |
|
specified directory, will be returned.</t> |
5378 |
|
|
5379 |
|
<t>Possible Answers:</t> |
5380 |
|
<t> |
5381 |
|
<list> |
5382 |
|
<t>The current number of instruments |
5383 |
|
in the specified directory.</t> |
5384 |
|
<t>"ERR:<error-code>:<error-message>" - |
5385 |
|
<list> |
5386 |
|
<t>if the given directory does not exist.</t> |
5387 |
|
</list> |
5388 |
|
</t> |
5389 |
|
</list> |
5390 |
|
</t> |
5391 |
|
|
5392 |
|
<t>Example:</t> |
5393 |
|
<t> |
5394 |
|
<list> |
5395 |
|
<t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t> |
5396 |
|
<t>S: "2"</t> |
5397 |
|
</list> |
5398 |
|
</t> |
5399 |
|
</section> |
5400 |
|
|
5401 |
|
<section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS"> |
5402 |
|
<t>The front-end can retrieve the current list of instruments |
5403 |
|
in specific directory by sending the following command:</t> |
5404 |
|
<t> |
5405 |
|
<list> |
5406 |
|
<t>LIST DB_INSTRUMENTS [RECURSIVE] <dir></t> |
5407 |
|
</list> |
5408 |
|
</t> |
5409 |
|
<t>Where <dir> should be replaced by the absolute path |
5410 |
|
name of the directory. If RECURSIVE is specified, the absolute path |
5411 |
|
names of all instruments, including those located in subdirectories |
5412 |
|
of the specified directory, will be returned.</t> |
5413 |
|
|
5414 |
|
<t>Possible Answers:</t> |
5415 |
|
<t> |
5416 |
|
<list> |
5417 |
|
<t>A comma separated list of all instruments |
5418 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
5419 |
|
<t>"ERR:<error-code>:<error-message>" - |
5420 |
|
<list> |
5421 |
|
<t>if the given directory does not exist.</t> |
5422 |
|
</list> |
5423 |
|
</t> |
5424 |
|
</list> |
5425 |
|
</t> |
5426 |
|
<t>Example:</t> |
5427 |
|
<t> |
5428 |
|
<list> |
5429 |
|
<t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t> |
5430 |
|
<t>S: "'Bosendorfer 290','Steinway D'"</t> |
5431 |
|
</list> |
5432 |
|
</t> |
5433 |
|
<t> |
5434 |
|
<list> |
5435 |
|
<t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t> |
5436 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t> |
5437 |
|
</list> |
5438 |
|
</t> |
5439 |
|
</section> |
5440 |
|
|
5441 |
|
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
5442 |
|
<t>The front-end can ask for the current settings of an |
5443 |
|
instrument by sending the following command:</t> |
5444 |
|
<t> |
5445 |
|
<list> |
5446 |
|
<t>GET DB_INSTRUMENT INFO <instr_path></t> |
5447 |
|
</list> |
5448 |
|
</t> |
5449 |
|
<t>Where <instr_path> should be replaced by the absolute path |
5450 |
|
name of the instrument the front-end is interested in.</t> |
5451 |
|
|
5452 |
|
<t>Possible Answers:</t> |
5453 |
|
<t> |
5454 |
|
<list> |
5455 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5456 |
|
Each answer line begins with the settings category name |
5457 |
|
followed by a colon and then a space character <SP> and finally |
5458 |
|
the info character string to that setting category. At the |
5459 |
|
moment the following categories are defined:</t> |
5460 |
|
|
5461 |
|
<t> |
5462 |
|
<list> |
5463 |
|
<t>INSTRUMENT_FILE - |
5464 |
|
<list> |
5465 |
|
<t>File name of the instrument. |
5466 |
|
Note that the character string may contain |
5467 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5468 |
|
</list> |
5469 |
|
</t> |
5470 |
|
<t>INSTRUMENT_NR - |
5471 |
|
<list> |
5472 |
|
<t>Index of the instrument within the file.</t> |
5473 |
|
</list> |
5474 |
|
</t> |
5475 |
|
<t>FORMAT_FAMILY - |
5476 |
|
<list> |
5477 |
|
<t>The format family of the instrument.</t> |
5478 |
|
</list> |
5479 |
|
</t> |
5480 |
|
<t>FORMAT_VERSION - |
5481 |
|
<list> |
5482 |
|
<t>The format version of the instrument.</t> |
5483 |
|
</list> |
5484 |
|
</t> |
5485 |
|
<t>SIZE - |
5486 |
|
<list> |
5487 |
|
<t>The size of the instrument in bytes.</t> |
5488 |
|
</list> |
5489 |
|
</t> |
5490 |
|
<t>CREATED - |
5491 |
|
<list> |
5492 |
|
<t>The date and time when the instrument is added |
5493 |
|
in the instruments database, represented in |
5494 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
5495 |
|
</list> |
5496 |
|
</t> |
5497 |
|
<t>MODIFIED - |
5498 |
|
<list> |
5499 |
|
<t>The date and time of the last modification of the |
5500 |
|
instrument's database settings, represented in |
5501 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
5502 |
|
</list> |
5503 |
|
</t> |
5504 |
|
<t>DESCRIPTION - |
5505 |
|
<list> |
5506 |
|
<t>A brief description of the instrument. |
5507 |
|
Note that the character string may contain |
5508 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5509 |
|
</list> |
5510 |
|
</t> |
5511 |
|
<t>IS_DRUM - |
5512 |
|
<list> |
5513 |
|
<t>either true or false, determines whether the |
5514 |
|
instrument is a drumkit or a chromatic instrument</t> |
5515 |
|
</list> |
5516 |
|
</t> |
5517 |
|
<t>PRODUCT - |
5518 |
|
<list> |
5519 |
|
<t>The product title of the instrument. |
5520 |
|
Note that the character string may contain |
5521 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5522 |
|
</list> |
5523 |
|
</t> |
5524 |
|
<t>ARTISTS - |
5525 |
|
<list> |
5526 |
|
<t>Lists the artist names. |
5527 |
|
Note that the character string may contain |
5528 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5529 |
|
</list> |
5530 |
|
</t> |
5531 |
|
<t>KEYWORDS - |
5532 |
|
<list> |
5533 |
|
<t>Provides a list of keywords that refer to the instrument. |
5534 |
|
Keywords are separated with semicolon and blank. |
5535 |
|
Note that the character string may contain |
5536 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5537 |
|
</list> |
5538 |
|
</t> |
5539 |
|
</list> |
5540 |
|
</t> |
5541 |
|
</list> |
5542 |
|
</t> |
5543 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5544 |
|
|
5545 |
|
<t>Example:</t> |
5546 |
|
<t> |
5547 |
|
<list> |
5548 |
|
<t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t> |
5549 |
|
<t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t> |
5550 |
|
<t> "INSTRUMENT_NR: 0"</t> |
5551 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
5552 |
|
<t> "FORMAT_VERSION: 2"</t> |
5553 |
|
<t> "SIZE: 2050871870"</t> |
5554 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
5555 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
5556 |
|
<t> "DESCRIPTION: "</t> |
5557 |
|
<t> "IS_DRUM: false"</t> |
5558 |
|
<t> "PRODUCT: GRANDIOSO Bosendorfer 290"</t> |
5559 |
|
<t> "ARTISTS: Post Musical Instruments"</t> |
5560 |
|
<t> "KEYWORDS: Bosendorfer"</t> |
5561 |
|
<t> "."</t> |
5562 |
|
</list> |
5563 |
|
</t> |
5564 |
|
</section> |
5565 |
|
|
5566 |
|
<section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME"> |
5567 |
|
<t>The front-end can alter the name of a specific |
5568 |
|
instrument by sending the following command:</t> |
5569 |
|
<t> |
5570 |
|
<list> |
5571 |
|
<t>SET DB_INSTRUMENT NAME <instr> <name></t> |
5572 |
|
</list> |
5573 |
|
</t> |
5574 |
|
<t>Where <instr> is the absolute path name of the instrument and |
5575 |
|
<name> is the new name for that instrument.</t> |
5576 |
|
|
5577 |
|
<t>Possible Answers:</t> |
5578 |
|
<t> |
5579 |
|
<list> |
5580 |
|
<t>"OK" - |
5581 |
|
<list> |
5582 |
|
<t>on success</t> |
5583 |
|
</list> |
5584 |
|
</t> |
5585 |
|
<t>"ERR:<error-code>:<error-message>" - |
5586 |
|
<list> |
5587 |
|
<t>in case the given instrument does not exists, |
5588 |
|
or if an instrument with name equal to the new |
5589 |
|
name already exists.</t> |
5590 |
|
</list> |
5591 |
|
</t> |
5592 |
|
</list> |
5593 |
|
</t> |
5594 |
|
|
5595 |
|
<t>Example:</t> |
5596 |
|
<t> |
5597 |
|
<list> |
5598 |
|
<t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t> |
5599 |
|
<t>S: "OK"</t> |
5600 |
|
</list> |
5601 |
|
</t> |
5602 |
|
</section> |
5603 |
|
|
5604 |
|
<section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT"> |
5605 |
|
<t>The front-end can move a specific instrument to another directory by |
5606 |
|
sending the following command:</t> |
5607 |
|
<t> |
5608 |
|
<list> |
5609 |
|
<t>MOVE DB_INSTRUMENT <instr> <dst></t> |
5610 |
|
</list> |
5611 |
|
</t> |
5612 |
|
<t>Where <instr> is the absolute path name of the instrument |
5613 |
|
to move and <dst> is the directory where the instrument will |
5614 |
|
be moved to.</t> |
5615 |
|
|
5616 |
|
<t>Possible Answers:</t> |
5617 |
|
<t> |
5618 |
|
<list> |
5619 |
|
<t>"OK" - |
5620 |
|
<list> |
5621 |
|
<t>on success</t> |
5622 |
|
</list> |
5623 |
|
</t> |
5624 |
|
<t>"ERR:<error-code>:<error-message>" - |
5625 |
|
<list> |
5626 |
|
<t>in case the given instrument does not exists, |
5627 |
|
or if an instrument with name equal to the name of the |
5628 |
|
specified instrument already exists in the destination |
5629 |
|
directory.</t> |
5630 |
|
</list> |
5631 |
|
</t> |
5632 |
|
</list> |
5633 |
|
</t> |
5634 |
|
|
5635 |
|
<t>Example:</t> |
5636 |
|
<t> |
5637 |
|
<list> |
5638 |
|
<t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t> |
5639 |
|
<t>S: "OK"</t> |
5640 |
|
</list> |
5641 |
|
</t> |
5642 |
|
</section> |
5643 |
|
|
5644 |
|
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT"> |
5645 |
|
<t>The front-end can copy a specific instrument to another directory by |
5646 |
|
sending the following command:</t> |
5647 |
|
<t> |
5648 |
|
<list> |
5649 |
|
<t>COPY DB_INSTRUMENT <instr> <dst></t> |
5650 |
|
</list> |
5651 |
|
</t> |
5652 |
|
<t>Where <instr> is the absolute path name of the instrument |
5653 |
|
to copy and <dst> is the directory where the instrument will |
5654 |
|
be copied to.</t> |
5655 |
|
|
5656 |
|
<t>Possible Answers:</t> |
5657 |
|
<t> |
5658 |
|
<list> |
5659 |
|
<t>"OK" - |
5660 |
|
<list> |
5661 |
|
<t>on success</t> |
5662 |
|
</list> |
5663 |
|
</t> |
5664 |
|
<t>"ERR:<error-code>:<error-message>" - |
5665 |
|
<list> |
5666 |
|
<t>in case the given instrument does not exists, |
5667 |
|
or if an instrument with name equal to the name of the |
5668 |
|
specified instrument already exists in the destination |
5669 |
|
directory.</t> |
5670 |
|
</list> |
5671 |
|
</t> |
5672 |
|
</list> |
5673 |
|
</t> |
5674 |
|
|
5675 |
|
<t>Example:</t> |
5676 |
|
<t> |
5677 |
|
<list> |
5678 |
|
<t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t> |
5679 |
|
<t>S: "OK"</t> |
5680 |
|
</list> |
5681 |
|
</t> |
5682 |
|
</section> |
5683 |
|
|
5684 |
|
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
5685 |
|
<t>The front-end can alter the description of a specific |
5686 |
|
instrument by sending the following command:</t> |
5687 |
|
<t> |
5688 |
|
<list> |
5689 |
|
<t>SET DB_INSTRUMENT DESCRIPTION <instr> <desc></t> |
5690 |
|
</list> |
5691 |
|
</t> |
5692 |
|
<t>Where <instr> is the absolute path name of the instrument and |
5693 |
|
<desc> is the new description for the instrument |
5694 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5695 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5696 |
|
|
5697 |
|
<t>Possible Answers:</t> |
5698 |
|
<t> |
5699 |
|
<list> |
5700 |
|
<t>"OK" - |
5701 |
|
<list> |
5702 |
|
<t>on success</t> |
5703 |
|
</list> |
5704 |
|
</t> |
5705 |
|
<t>"ERR:<error-code>:<error-message>" - |
5706 |
|
<list> |
5707 |
|
<t>in case the given instrument does not exists.</t> |
5708 |
|
</list> |
5709 |
|
</t> |
5710 |
|
</list> |
5711 |
|
</t> |
5712 |
|
|
5713 |
|
<t>Example:</t> |
5714 |
|
<t> |
5715 |
|
<list> |
5716 |
|
<t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t> |
5717 |
|
<t>S: "OK"</t> |
5718 |
|
</list> |
5719 |
|
</t> |
5720 |
|
</section> |
5721 |
|
|
5722 |
|
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS"> |
5723 |
|
<t>The front-end can search for instruments |
5724 |
|
in specific directory by sending the following command:</t> |
5725 |
|
<t> |
5726 |
|
<list> |
5727 |
|
<t>FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list></t> |
5728 |
|
</list> |
5729 |
|
</t> |
5730 |
|
<t>Where <dir> should be replaced by the absolute path |
5731 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
5732 |
|
directories located in subdirectories of the specified directory will not |
5733 |
|
be searched. <criteria-list> is a list of search criterias |
5734 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
5735 |
|
allowed:</t> |
5736 |
|
<t> |
5737 |
|
<t>NAME='<search-string>' |
5738 |
|
<list> |
5739 |
|
<t>Restricts the search to instruments, which names |
5740 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
5741 |
|
supporting escape sequences as described in chapter |
5742 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5743 |
|
</list> |
5744 |
|
</t> |
5745 |
|
|
5746 |
|
<t>SIZE=[<min>]..[<max>] |
5747 |
|
<list> |
5748 |
|
<t>Restricts the search to instruments, which |
5749 |
|
size is in the specified range. If <min> is omitted, |
5750 |
|
the search results are restricted to instruments with size less then |
5751 |
|
or equal to <max>. If <max> is omitted, the |
5752 |
|
search is restricted to instruments with size greater then |
5753 |
|
or equal to <min>.</t> |
5754 |
|
</list> |
5755 |
|
</t> |
5756 |
|
|
5757 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
5758 |
|
<list> |
5759 |
|
<t>Restricts the search to instruments, which creation |
5760 |
|
date satisfies the specified period, where <date-after> |
5761 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
5762 |
|
If <date-after> is omitted the search is restricted to |
5763 |
|
instruments created before <date-before>. If |
5764 |
|
<date-before> is omitted, the search is restricted |
5765 |
|
to instruments created after <date-after>.</t> |
5766 |
|
</list> |
5767 |
|
</t> |
5768 |
|
|
5769 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
5770 |
|
<list> |
5771 |
|
<t>Restricts the search to instruments, which |
5772 |
|
date of last modification satisfies the specified period, where |
5773 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
5774 |
|
format. If <date-after> is omitted the search is restricted to |
5775 |
|
instruments, which are last modified before <date-before>. If |
5776 |
|
<date-before> is omitted, the search is restricted to instruments, |
5777 |
|
which are last modified after <date-after>.</t> |
5778 |
|
</list> |
5779 |
|
</t> |
5780 |
|
|
5781 |
|
<t>DESCRIPTION='<search-string>' |
5782 |
|
<list> |
5783 |
|
<t>Restricts the search to instruments with description |
5784 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
5785 |
|
supporting escape sequences as described in chapter |
5786 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5787 |
|
</list> |
5788 |
|
</t> |
5789 |
|
|
5790 |
|
<t>PRODUCT='<search-string>' |
5791 |
|
<list> |
5792 |
|
<t>Restricts the search to instruments with product info |
5793 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
5794 |
|
supporting escape sequences as described in chapter |
5795 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5796 |
|
</list> |
5797 |
|
</t> |
5798 |
|
|
5799 |
|
<t>ARTISTS='<search-string>' |
5800 |
|
<list> |
5801 |
|
<t>Restricts the search to instruments with artists info |
5802 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
5803 |
|
supporting escape sequences as described in chapter |
5804 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5805 |
|
</list> |
5806 |
|
</t> |
5807 |
|
|
5808 |
|
<t>KEYWORDS='<search-string>' |
5809 |
|
<list> |
5810 |
|
<t>Restricts the search to instruments with keyword list |
5811 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
5812 |
|
supporting escape sequences as described in chapter |
5813 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5814 |
|
</list> |
5815 |
|
</t> |
5816 |
|
|
5817 |
|
<t>IS_DRUM=true | false |
5818 |
|
<list> |
5819 |
|
<t>Either true or false. Restricts the search to |
5820 |
|
drum kits or chromatic instruments.</t> |
5821 |
|
</list> |
5822 |
|
</t> |
5823 |
|
|
5824 |
|
<t>FORMAT_FAMILIES='<format-list>' |
5825 |
|
<list> |
5826 |
|
<t>Restricts the search to instruments of the supplied format families, |
5827 |
|
where <format-list> is a comma separated list of format families.</t> |
5828 |
|
</list> |
5829 |
|
</t> |
5830 |
|
</t> |
5831 |
|
|
5832 |
|
<t>Where <search-string> is either a regular expression, or a |
5833 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
5834 |
|
|
5835 |
|
<t>Possible Answers:</t> |
5836 |
|
<t> |
5837 |
|
<list> |
5838 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
5839 |
|
apostrophes) of all instruments in the specified directory that satisfy |
5840 |
|
the supplied search criterias.</t> |
5841 |
|
<t>"ERR:<error-code>:<error-message>" - |
5842 |
|
<list> |
5843 |
|
<t>if the given directory does not exist.</t> |
5844 |
|
</list> |
5845 |
|
</t> |
5846 |
|
</list> |
5847 |
|
</t> |
5848 |
|
<t>Example:</t> |
5849 |
|
<t> |
5850 |
|
<list> |
5851 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t> |
5852 |
|
<t>S: "'/Piano Collection/Bosendorfer 290'"</t> |
5853 |
|
</list> |
5854 |
|
</t> |
5855 |
|
<t> |
5856 |
|
<list> |
5857 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t> |
5858 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t> |
5859 |
|
</list> |
5860 |
|
</t> |
5861 |
|
</section> |
5862 |
|
|
5863 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
5864 |
|
<t>The front-end can ask for the current status of a |
5865 |
|
particular database instruments job by sending the following command:</t> |
5866 |
|
<t> |
5867 |
|
<list> |
5868 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
5869 |
|
</list> |
5870 |
|
</t> |
5871 |
|
<t>Where <job-id> should be replaced by the numerical ID |
5872 |
|
of the job the front-end is interested in.</t> |
5873 |
|
|
5874 |
|
<t>Possible Answers:</t> |
5875 |
|
<t> |
5876 |
|
<list> |
5877 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5878 |
|
Each answer line begins with the settings category name |
5879 |
|
followed by a colon and then a space character <SP> and finally |
5880 |
|
the info character string to that setting category. At the |
5881 |
|
moment the following categories are defined:</t> |
5882 |
|
|
5883 |
|
<t> |
5884 |
|
<list> |
5885 |
|
<t>FILES_TOTAL - |
5886 |
|
<list> |
5887 |
|
<t>The total number of files scheduled for scanning</t> |
5888 |
|
</list> |
5889 |
|
</t> |
5890 |
|
<t>FILES_SCANNED - |
5891 |
|
<list> |
5892 |
|
<t>The current number of scanned files</t> |
5893 |
|
</list> |
5894 |
|
</t> |
5895 |
|
<t>SCANNING - |
5896 |
|
<list> |
5897 |
|
<t>The absolute path name of the file which is currently |
5898 |
|
being scanned</t> |
5899 |
|
</list> |
5900 |
|
</t> |
5901 |
|
<t>STATUS - |
5902 |
|
<list> |
5903 |
|
<t>An integer value between 0 and 100 indicating the |
5904 |
|
scanning progress percentage of the file which is |
5905 |
|
currently being scanned</t> |
5906 |
|
</list> |
5907 |
|
</t> |
5908 |
|
</list> |
5909 |
|
</t> |
5910 |
|
</list> |
5911 |
|
</t> |
5912 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5913 |
|
|
5914 |
|
<t>Example:</t> |
5915 |
|
<t> |
5916 |
|
<list> |
5917 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
5918 |
|
<t>S: "FILES_TOTAL: 12"</t> |
5919 |
|
<t> "FILES_SCANNED: 7"</t> |
5920 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
5921 |
|
<t> "STATUS: 42"</t> |
5922 |
|
<t> "."</t> |
5923 |
|
</list> |
5924 |
|
</t> |
5925 |
|
</section> |
5926 |
|
|
5927 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
5928 |
|
<t>The front-end can remove all instruments and directories and re-create |
5929 |
|
the instruments database structure (e.g., in case of a database corruption) |
5930 |
|
by sending the following command:</t> |
5931 |
|
<t> |
5932 |
|
<list> |
5933 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
5934 |
|
</list> |
5935 |
|
</t> |
5936 |
|
|
5937 |
|
<t>Possible Answers:</t> |
5938 |
|
<t> |
5939 |
|
<list> |
5940 |
|
<t>"OK" - |
5941 |
|
<list> |
5942 |
|
<t>on success</t> |
5943 |
|
</list> |
5944 |
|
</t> |
5945 |
|
<t>"ERR:<error-code>:<error-message>" - |
5946 |
|
<list> |
5947 |
|
<t>If the formatting of the instruments database |
5948 |
|
failed.</t> |
5949 |
|
</list> |
5950 |
|
</t> |
5951 |
|
</list> |
5952 |
|
</t> |
5953 |
|
</section> |
5954 |
|
|
5955 |
|
</section> |
5956 |
|
|
5957 |
|
|
5958 |
|
|
5959 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
5960 |
|
<t>The sampler allows to edit instruments while playing with the |
5961 |
|
sampler by spawning an external (3rd party) instrument editor |
5962 |
|
application for a given instrument. The 3rd party instrument |
5963 |
|
editor applications have to place a respective plugin DLL file |
5964 |
|
into the sampler's plugins directory. The sampler will |
5965 |
|
automatically try to load all plugin DLLs in that directory on |
5966 |
|
startup and only on startup!</t> |
5967 |
|
<t>At the moment there is only one command for this feature set, |
5968 |
|
but this will most probably change in future.</t> |
5969 |
|
|
5970 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
5971 |
|
<t>The front-end can request to open an appropriate instrument |
5972 |
|
editor application by sending the following command:</t> |
5973 |
|
<t> |
5974 |
|
<list> |
5975 |
|
<t>EDIT INSTRUMENT <sampler-channel></t> |
5976 |
|
</list> |
5977 |
|
</t> |
5978 |
|
<t>Where <sampler-channel> should be replaced by the |
5979 |
|
number of the sampler channel as given by the |
5980 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
5981 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
5982 |
|
command.</t> |
5983 |
|
|
5984 |
|
<t>The sampler will try to ask all registered instrument |
5985 |
|
editors (or to be more specific: their sampler plugins) |
5986 |
|
whether they are capable to handle the instrument on the |
5987 |
|
given sampler channel. The sampler will simply use the first |
5988 |
|
instrument editor application which replied with a positive |
5989 |
|
answer and spawn that instrument editor application within |
5990 |
|
the sampler's process and provide that application access |
5991 |
|
to the instrument's data structures, so both applications |
5992 |
|
can share and access the same instruments data at the same |
5993 |
|
time, thus allowing to immediately hear changes with the |
5994 |
|
sampler made by the instrument editor.</t> |
5995 |
|
|
5996 |
|
<t>Note: consequently instrument editors are always spawned |
5997 |
|
locally on the same machine where the sampler is running |
5998 |
|
on!</t> |
5999 |
|
|
6000 |
|
<t>Possible Answers:</t> |
6001 |
|
<t> |
6002 |
|
<list> |
6003 |
|
<t>"OK" - |
6004 |
|
<list> |
6005 |
|
<t>when an appropriate instrument editor was |
6006 |
|
launched</t> |
6007 |
|
</list> |
6008 |
|
</t> |
6009 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6010 |
|
<list> |
6011 |
|
<t>when an appropriate instrument editor was |
6012 |
|
launched, but there are noteworthy issues</t> |
6013 |
|
</list> |
6014 |
|
</t> |
6015 |
|
<t>"ERR:<error-code>:<error-message>" - |
6016 |
|
<list> |
6017 |
|
<t>when an appropriate instrument editor |
6018 |
|
could not be launched</t> |
6019 |
|
</list> |
6020 |
|
</t> |
6021 |
|
</list> |
6022 |
|
</t> |
6023 |
|
|
6024 |
|
<t>Examples:</t> |
6025 |
|
<t> |
6026 |
|
<list> |
6027 |
|
<t>C: "EDIT INSTRUMENT 0"</t> |
6028 |
|
<t>S: "OK"</t> |
6029 |
|
</list> |
6030 |
|
</t> |
6031 |
|
</section> |
6032 |
|
</section> |
6033 |
</section> |
</section> |
6034 |
|
|
6035 |
|
|
6105 |
</t> |
</t> |
6106 |
<t>/ UNSUBSCRIBE SP unsubscribe_event |
<t>/ UNSUBSCRIBE SP unsubscribe_event |
6107 |
</t> |
</t> |
|
<t>/ SELECT SP text |
|
|
</t> |
|
6108 |
<t>/ RESET SP reset_instruction |
<t>/ RESET SP reset_instruction |
6109 |
</t> |
</t> |
6110 |
<t>/ CLEAR SP clear_instruction |
<t>/ CLEAR SP clear_instruction |
6111 |
</t> |
</t> |
6112 |
|
<t>/ FIND SP find_instruction |
6113 |
|
</t> |
6114 |
|
<t>/ MOVE SP move_instruction |
6115 |
|
</t> |
6116 |
|
<t>/ COPY SP copy_instruction |
6117 |
|
</t> |
6118 |
|
<t>/ EDIT SP edit_instruction |
6119 |
|
</t> |
6120 |
|
<t>/ FORMAT SP format_instruction |
6121 |
|
</t> |
6122 |
<t>/ RESET |
<t>/ RESET |
6123 |
</t> |
</t> |
6124 |
<t>/ QUIT |
<t>/ QUIT |
6129 |
<list> |
<list> |
6130 |
<t>CHANNEL |
<t>CHANNEL |
6131 |
</t> |
</t> |
6132 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6133 |
|
</t> |
6134 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6135 |
|
</t> |
6136 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6137 |
|
</t> |
6138 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6139 |
|
</t> |
6140 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
6141 |
|
</t> |
6142 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename |
6143 |
|
</t> |
6144 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6145 |
|
</t> |
6146 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
6147 |
</t> |
</t> |
6148 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
6181 |
</t> |
</t> |
6182 |
<t>/ MIDI_INSTRUMENT_INFO |
<t>/ MIDI_INSTRUMENT_INFO |
6183 |
</t> |
</t> |
6184 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
6185 |
|
</t> |
6186 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
6187 |
|
</t> |
6188 |
|
<t>/ DB_INSTRUMENT_COUNT |
6189 |
|
</t> |
6190 |
|
<t>/ DB_INSTRUMENT_INFO |
6191 |
|
</t> |
6192 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6193 |
|
</t> |
6194 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6195 |
</t> |
</t> |
6196 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6231 |
</t> |
</t> |
6232 |
<t>/ MIDI_INSTRUMENT_INFO |
<t>/ MIDI_INSTRUMENT_INFO |
6233 |
</t> |
</t> |
6234 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
6235 |
|
</t> |
6236 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
6237 |
|
</t> |
6238 |
|
<t>/ DB_INSTRUMENT_COUNT |
6239 |
|
</t> |
6240 |
|
<t>/ DB_INSTRUMENT_INFO |
6241 |
|
</t> |
6242 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6243 |
|
</t> |
6244 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6245 |
</t> |
</t> |
6246 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6275 |
</t> |
</t> |
6276 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
6277 |
</t> |
</t> |
6278 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6279 |
|
</t> |
6280 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6281 |
|
</t> |
6282 |
|
<t>/ DB_INSTRUMENT SP db_path |
6283 |
|
</t> |
6284 |
</list> |
</list> |
6285 |
</t> |
</t> |
6286 |
<t>get_instruction = |
<t>get_instruction = |
6351 |
</t> |
</t> |
6352 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
6353 |
</t> |
</t> |
6354 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6355 |
|
</t> |
6356 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6357 |
|
</t> |
6358 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
6359 |
|
</t> |
6360 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6361 |
|
</t> |
6362 |
|
<t>/ DB_INSTRUMENTS SP db_path |
6363 |
|
</t> |
6364 |
|
<t>/ DB_INSTRUMENT SP INFO SP db_path |
6365 |
|
</t> |
6366 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
6367 |
|
</t> |
6368 |
<t>/ VOLUME |
<t>/ VOLUME |
6369 |
</t> |
</t> |
6370 |
</list> |
</list> |
6377 |
</t> |
</t> |
6378 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
6379 |
</t> |
</t> |
6380 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
6381 |
|
</t> |
6382 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
6383 |
</t> |
</t> |
6384 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
6393 |
</t> |
</t> |
6394 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
6395 |
</t> |
</t> |
6396 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP raw_path |
6397 |
|
</t> |
6398 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP raw_path |
6399 |
|
</t> |
6400 |
|
<t>/ DB_INSTRUMENT SP NAME SP db_path SP raw_path |
6401 |
|
</t> |
6402 |
|
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP raw_path |
6403 |
|
</t> |
6404 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6405 |
</t> |
</t> |
6406 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6437 |
</t> |
</t> |
6438 |
</list> |
</list> |
6439 |
</t> |
</t> |
6440 |
|
<t>find_instruction = |
6441 |
|
<list> |
6442 |
|
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
6443 |
|
</t> |
6444 |
|
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
6445 |
|
</t> |
6446 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
6447 |
|
</t> |
6448 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6449 |
|
</t> |
6450 |
|
</list> |
6451 |
|
</t> |
6452 |
|
<t>move_instruction = |
6453 |
|
<list> |
6454 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6455 |
|
</t> |
6456 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6457 |
|
</t> |
6458 |
|
</list> |
6459 |
|
</t> |
6460 |
|
<t>copy_instruction = |
6461 |
|
<list> |
6462 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6463 |
|
</t> |
6464 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6465 |
|
</t> |
6466 |
|
</list> |
6467 |
|
</t> |
6468 |
<t>destroy_instruction = |
<t>destroy_instruction = |
6469 |
<list> |
<list> |
6470 |
<t>AUDIO_OUTPUT_DEVICE SP number |
<t>AUDIO_OUTPUT_DEVICE SP number |
6515 |
</t> |
</t> |
6516 |
</list> |
</list> |
6517 |
</t> |
</t> |
6518 |
|
<t>edit_instruction = |
6519 |
|
<list> |
6520 |
|
<t>INSTRUMENT SP sampler_channel |
6521 |
|
</t> |
6522 |
|
</list> |
6523 |
|
</t> |
6524 |
|
<t>format_instruction = |
6525 |
|
<list> |
6526 |
|
<t>INSTRUMENTS_DB |
6527 |
|
</t> |
6528 |
|
</list> |
6529 |
|
</t> |
6530 |
<t>modal_arg = |
<t>modal_arg = |
6531 |
<list> |
<list> |
6532 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
6573 |
</t> |
</t> |
6574 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
6575 |
</t> |
</t> |
6576 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6577 |
|
</t> |
6578 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6579 |
|
</t> |
6580 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6581 |
|
</t> |
6582 |
|
<t>/ DB_INSTRUMENTS SP db_path |
6583 |
|
</t> |
6584 |
</list> |
</list> |
6585 |
</t> |
</t> |
6586 |
<t>load_instr_args = |
<t>load_instr_args = |
6703 |
</t> |
</t> |
6704 |
<t>filename = |
<t>filename = |
6705 |
<list> |
<list> |
6706 |
<t>stringval |
<t>path |
6707 |
|
</t> |
6708 |
|
</list> |
6709 |
|
</t> |
6710 |
|
<t>db_path = |
6711 |
|
<list> |
6712 |
|
<t>path |
6713 |
</t> |
</t> |
6714 |
</list> |
</list> |
6715 |
</t> |
</t> |
6739 |
</t> |
</t> |
6740 |
</list> |
</list> |
6741 |
</t> |
</t> |
6742 |
|
|
6743 |
<t>param_val = |
<t>param_val = |
6744 |
<list> |
<list> |
6745 |
<t>string |
<t>string |
6752 |
</t> |
</t> |
6753 |
</list> |
</list> |
6754 |
</t> |
</t> |
6755 |
|
<t>query_val_list = |
6756 |
|
<list> |
6757 |
|
<t>string '=' query_val |
6758 |
|
</t> |
6759 |
|
<t>/ query_val_list SP string '=' query_val |
6760 |
|
</t> |
6761 |
|
</list> |
6762 |
|
</t> |
6763 |
|
<t>query_val = |
6764 |
|
<list> |
6765 |
|
<t>raw_path_base |
6766 |
|
</t> |
6767 |
|
<t>/ raw_path |
6768 |
|
</t> |
6769 |
|
</list> |
6770 |
|
</t> |
6771 |
|
<t>scan_mode = |
6772 |
|
<list> |
6773 |
|
<t>RECURSIVE |
6774 |
|
</t> |
6775 |
|
<t>/ NON_RECURSIVE |
6776 |
|
</t> |
6777 |
|
<t>/ FLAT |
6778 |
|
</t> |
6779 |
|
</list> |
6780 |
|
</t> |
6781 |
|
|
6782 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
6783 |
|
|
6784 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
6785 |
|
<t>Older versions of this protocol up to and including v1.1 only |
6786 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
6787 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
6788 |
|
however support the Extended ASCII character set (ASCII code |
6789 |
|
0 - 255). The same group of younger protocols also support |
6790 |
|
escape sequences, but only for certain, explicitly declared |
6791 |
|
parts of the protocol. The supported escape sequences are |
6792 |
|
defined as follows:</t> |
6793 |
|
<texttable> |
6794 |
|
<ttcol>ASCII Character Sequence</ttcol> |
6795 |
|
<ttcol>Translated into (Name)</ttcol> |
6796 |
|
<c>\n</c> <c>new line</c> |
6797 |
|
<c>\r</c> <c>carriage return</c> |
6798 |
|
<c>\f</c> <c>form feed</c> |
6799 |
|
<c>\t</c> <c>horizontal tab</c> |
6800 |
|
<c>\v</c> <c>vertical tab</c> |
6801 |
|
<c>\'</c> <c>apostrophe</c> |
6802 |
|
<c>\"</c> <c>quotation mark</c> |
6803 |
|
<c>\\</c> <c>backslash</c> |
6804 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
6805 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
6806 |
|
</texttable> |
6807 |
|
<t>Notice: due to the transition of certain parts of the |
6808 |
|
protocol which now support escape sequences, a slight backward |
6809 |
|
incompatibility to protocols version v1.1 and younger has been |
6810 |
|
introduced. The only difference is that in parts of the protocol |
6811 |
|
where escape characters are now supported, a backslash characters |
6812 |
|
MUST be escaped as well (that is as double backslash), whereas |
6813 |
|
in the old versions a single backslash was sufficient.</t> |
6814 |
|
</section> |
6815 |
</section> |
</section> |
6816 |
|
|
6817 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
6997 |
</section> |
</section> |
6998 |
|
|
6999 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
7000 |
<t>Client may want to be notified when the number of effect sends on |
<t>Client may want to be notified when the number of effect sends on |
7001 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
7002 |
<t> |
<t> |
7003 |
<list> |
<list> |
7153 |
</t> |
</t> |
7154 |
</section> |
</section> |
7155 |
|
|
7156 |
|
<section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"> |
7157 |
|
<t>Client may want to be notified when the number of instrument |
7158 |
|
directories in a particular directory in the instruments database |
7159 |
|
is changed by issuing the following command:</t> |
7160 |
|
<t> |
7161 |
|
<list> |
7162 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t> |
7163 |
|
</list> |
7164 |
|
</t> |
7165 |
|
<t>Server will start sending the following notification messages:</t> |
7166 |
|
<t> |
7167 |
|
<list> |
7168 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"</t> |
7169 |
|
</list> |
7170 |
|
</t> |
7171 |
|
<t>where <dir-path> will be replaced by the absolute path |
7172 |
|
name of the directory in the instruments database, |
7173 |
|
in which the number of directories is changed.</t> |
7174 |
|
<t>Note that when a non-empty directory is removed, this event |
7175 |
|
is not sent for the subdirectories in that directory.</t> |
7176 |
|
</section> |
7177 |
|
|
7178 |
|
<section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"> |
7179 |
|
<t>Client may want to be notified when changes were made to directories |
7180 |
|
in the instruments database by issuing the following command:</t> |
7181 |
|
<t> |
7182 |
|
<list> |
7183 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t> |
7184 |
|
</list> |
7185 |
|
</t> |
7186 |
|
<t>Server will start sending the following notification messages:</t> |
7187 |
|
<t> |
7188 |
|
<list> |
7189 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"</t> |
7190 |
|
</list> |
7191 |
|
</t> |
7192 |
|
<t>where <dir-path> will be replaced by the absolute path name |
7193 |
|
of the directory, for which information changes occurred. The front-end will have to send |
7194 |
|
the respective command to actually get the updated directory info. Because these messages |
7195 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7196 |
|
time events happening on the server, it is believed that an empty notification |
7197 |
|
message is sufficient here.</t> |
7198 |
|
<t> |
7199 |
|
<list> |
7200 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-name>"</t> |
7201 |
|
</list> |
7202 |
|
</t> |
7203 |
|
<t>where <old-dir-path> is the old absolute path name of the directory |
7204 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
7205 |
|
the new name of the directory, encapsulated into apostrophes.</t> |
7206 |
|
</section> |
7207 |
|
|
7208 |
|
<section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT"> |
7209 |
|
<t>Client may want to be notified when the number of instruments |
7210 |
|
in a particular directory in the instruments database |
7211 |
|
is changed by issuing the following command:</t> |
7212 |
|
<t> |
7213 |
|
<list> |
7214 |
|
<t>SUBSCRIBE DB_INSTRUMENT_COUNT</t> |
7215 |
|
</list> |
7216 |
|
</t> |
7217 |
|
<t>Server will start sending the following notification messages:</t> |
7218 |
|
<t> |
7219 |
|
<list> |
7220 |
|
<t>"NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"</t> |
7221 |
|
</list> |
7222 |
|
</t> |
7223 |
|
<t>where <dir-path> will be replaced by the absolute path |
7224 |
|
name of the directory in the instruments database, |
7225 |
|
in which the number of instruments is changed.</t> |
7226 |
|
<t>Note that when a non-empty directory is removed, this event |
7227 |
|
is not sent for the instruments in that directory.</t> |
7228 |
|
</section> |
7229 |
|
|
7230 |
|
<section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO"> |
7231 |
|
<t>Client may want to be notified when changes were made to instruments |
7232 |
|
in the instruments database by issuing the following command:</t> |
7233 |
|
<t> |
7234 |
|
<list> |
7235 |
|
<t>SUBSCRIBE DB_INSTRUMENT_INFO</t> |
7236 |
|
</list> |
7237 |
|
</t> |
7238 |
|
<t>Server will start sending the following notification messages:</t> |
7239 |
|
<t> |
7240 |
|
<list> |
7241 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"</t> |
7242 |
|
</list> |
7243 |
|
</t> |
7244 |
|
<t>where <instr-path> will be replaced by the absolute path name |
7245 |
|
of the instrument, which settings are changed. The front-end will have to send |
7246 |
|
the respective command to actually get the updated directory info. Because these messages |
7247 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7248 |
|
time events happening on the server, it is believed that an empty notification |
7249 |
|
message is sufficient here.</t> |
7250 |
|
<t> |
7251 |
|
<list> |
7252 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"</t> |
7253 |
|
</list> |
7254 |
|
</t> |
7255 |
|
<t>where <old-instr-path> is the old absolute path name of the instrument |
7256 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
7257 |
|
the new name of the instrument, encapsulated into apostrophes.</t> |
7258 |
|
</section> |
7259 |
|
|
7260 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
7261 |
|
<t>Client may want to be notified when the status of particular database |
7262 |
|
instruments job is changed by issuing the following command:</t> |
7263 |
|
<t> |
7264 |
|
<list> |
7265 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
7266 |
|
</list> |
7267 |
|
</t> |
7268 |
|
<t>Server will start sending the following notification messages:</t> |
7269 |
|
<t> |
7270 |
|
<list> |
7271 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
7272 |
|
</list> |
7273 |
|
</t> |
7274 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
7275 |
|
which status is changed. The front-end will have to send the respective |
7276 |
|
command to actually get the status info. Because these messages |
7277 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7278 |
|
time events happening on the server, it is believed that an empty notification |
7279 |
|
message is sufficient here.</t> |
7280 |
|
</section> |
7281 |
|
|
7282 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
7283 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
7284 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
7357 |
</front> |
</front> |
7358 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
7359 |
</reference> |
</reference> |
7360 |
|
<reference anchor="RFC20"> |
7361 |
|
<front> |
7362 |
|
<title>ASCII format for Network Interchange</title> |
7363 |
|
<author> |
7364 |
|
<organization>UCLA</organization> |
7365 |
|
</author> |
7366 |
|
<date year="1969"></date> |
7367 |
|
</front> |
7368 |
|
<seriesInfo name="RFC" value="20" /> |
7369 |
|
</reference> |
7370 |
</references> |
</references> |
7371 |
</back> |
</back> |
7372 |
|
|