Debian Codegraph @

Documentation/ecasoundrc_manpage.html

raw
1 <html><head>
2 <title>ecasoundrc</title>
3 <link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
4 </head>
5 <body>
6 <hr>
7 <h1>ecasoundrc</h1>
8 <h2>22.03.2009</h2>
9
10 <html><head>
11 <link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
12 </head>
13 <body>
14 <hr>
15 <h1></h1>
16
17 <html><head>
18 <title>ecasoundrc(5)</title>
19 <link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
20 </head>
21 <body>
22 <hr>
23 <h1>ecasoundrc(5)</h1>
24 <h2> Multimedia software</h2>
25 <h2>22.03.2009</h2>
26
27
28 <p>
29 <h2>NAME</h2>ecasoundrc - ecasound rcfile
30 <p>
31 <h2>SYNOPSIS</h2>
32 {prefix}/share/ecasound/ecasoundrc (for instance '/usr/local/share/ecasound/ecasoundrc')
33 $HOME/.ecasound/ecasoundrc
34 <p>
35 <h2>DESCRIPTION</h2>
36 <p>
37 <strong>ecasoundrc</strong> is the main configuration file for ecasound.
38 Any user-specific modification should be done to
39 $HOME/.ecasound/ecasoundrc, not to the global resource file. Ecasound
40 also allows one to disable the normal policy and only read from a specific
41 resource file (see ecasound (1) and documentation for the <strong>-R</strong> option).
42 <p>
43 The format is quite simple. One line consists of
44 a configuration variable and its value. Variable and value
45 are separated with either '=' or ' '. Lines beginning with a
46 "#" are ignored (comment lines).
47 <p>
48 <h2>VARIABLES</h2>
49 <p>
50 <dl>
51 <p>
52 <p><dt><strong>midi-device</strong><dd>
53 MIDI-device. If the device name is given in <em>rawmidi,/dev/midi*</em>
54 format, OSS/Linux or OSS/Lite drivers are used.
55 Device <em>rawmidi,/dev/snd/midiCxDy</em> opens an ALSA raw-MIDI
56 device with card number 'x' and device number 'y'.
57 See ecasound (1) man page (the '-Md option) for more info.
58 Defaults to <em>rawmidi,/dev/midi</em>.
59 <p>
60 <p><dt><strong>default-output</strong><dd>
61 Output device to use by default. If a chainsetup with zero
62 outputs, but with one or more inputs, is connected, a default output
63 is added and all the chains are connected to it. If the special-case
64 value 'autodetect' is specified, ecasound will try to auto-detect
65 a suitable device (JACK -&gt; ALSA -&gt; OSS -&gt; rtnull).
66 Defaults to <em>autodetect</em>.
67 <p>
68 <p><dt><strong>default-audio-format</strong><dd>
69 Default values for sample format, channel count, sampling rate
70 and channel interleaving. Syntax is the same as used by
71 ecasound's <em>-f</em> option (see ecasound (1)).
72 Defaults to <em>s16_le,2,44100,i</em>.
73 <p>
74 <p><dt><strong>default-to-precise-sample-rates</strong><dd>
75 Whether to ignore sample rate differences (and possibly avoid
76 resampling). Currently only affects OSS-devices. Defaults to <em>false</em>.
77 <p>
78 <p><dt><strong>default-mix-mode</strong><dd>
79 If <em>default-mix-mode</em> is <em>sum</em>, engine will mix multiple channels into
80 one output channel by summing all input channels. In mode <em>avg</em>,
81 mixing is done by taking the average of all input channels. The
82 <em>avg</em> mode is safe from clipping, while <em>sum</em> is closer
83 to the way analog mixers work. Defaults to <em>avg</em>.
84 <p>
85 <p><dt><strong>bmode-defaults-nonrt</strong><dd>
86 Selects the default parameters to use with buffering
87 mode 'nonrt' (other modes are 'rt' and 'rtlowlatency).
88 Parameters are given as a comma-separated tuple of values:
89 1) buffersize (number,-b), 2) raised priority (true/false,-r),
90 3) sched_priority (number,-r:X), 4) double buffering
91 (true/false,-z:db), 5) db-bufsize (number,-z:db,X), and
92 6) max intbuf (true/false,-z:intbuf). Defaults to
93 <em>1024,false,50,false,100000,true</em>.
94 <p>
95 <p><dt><strong>bmode-defaults-rt</strong><dd>
96 See 'bmode-defaults-nonrt'. Defaults to
97 <em>1024,true,50,true,100000,true</em>.
98 <p>
99 <p><dt><strong>bmode-defaults-rtlowlatency</strong><dd>
100 See 'bmode-defaults-nonrt'. Defaults to
101 <em>256,true,50,true,100000,false</em>.
102 <p>
103 <p><dt><strong>resource-directory</strong><dd>
104 Directory for global ecasound configuration files.
105 Defaults to <em>{prefix-dir}/share/ecasound</em>.
106 Note! User-specific resource files can be be stored
107 to '$(HOME)/.ecasound/'. For instance you can
108 add your own presets definitions to
109 '$(HOME)/.ecasound/effect_presets'.
110 <p>
111 <p><dt><strong>resource-file-genosc-envelopes</strong><dd>
112 Configuration file for generic oscillators. Is located in the
113 resource directory. Defaults to <em>generic_oscillators</em>.
114 <p>
115 <p><dt><strong>resource-file-effect-presets</strong><dd>
116 Configuration file for effect presets. Is located in the
117 resource directory. Defaults to <em>effect_presets</em>.
118 <p>
119 <p><dt><strong>ladspa-plugin-directory</strong><dd>
120 Directory containing LADSPA effect plugins. Defaults to <em>{prefix-dir}/lib/ladspa</em>.
121 If environment variable <em>LADSPA_PATH</em> exists, directories
122 specified in it are automatically searched for plugins.
123 Note! To match the syntax of the <em>LADSPA_PATH</em> environment
124 variable, 'ladspa-plugin-directory' can contain multiple
125 directories, separated by ':' characters.
126 <p>
127 <p><dt><strong>ext-cmd-text-editor</strong><dd>
128 If <em>ext-cmd-text-editor-use-getenv</em> is <em>false</em> or "EDITOR"
129 is null, value of this field is used.
130 <p>
131 <p><dt><strong>ext-cmd-text-editor-use-getenv</strong><dd>
132 Should ecasound try to query environment variable "EDITOR".
133 Defaults to <em>true</em>.
134 <p>
135 <p><dt><strong>ext-cmd-mp3-input</strong><dd>
136 Command for starting mp3 input. Ecasound expects to read signed,
137 16bit, little-endian stereo audio samples from its standard
138 input. Ecsound will query other audio format parameters by parsing
139 the mp3 file header. Before execution, %f is replaced with
140 path to the input mp3. If exists, "%o" is replaced with he
141 start offset in mp3 frames. Double-quotes and backslash-espacing
142 can be used to include white-space to individual parameters.
143 By default, <em>mpg123</em> is launched.
144 <p>
145 <p><dt><strong>ext-cmd-mp3-output</strong><dd>
146 Command for starting mp3 output. Ecasound will write stereo,
147 signed, 16bit, little-endian samples to standard output. Sample
148 rate is configurable. Before execution, %f is replaced with
149 path to the output mp3, %S with sample rate in kHz, and
150 %B with encoding bitrate in kbps. Double-quotes and
151 backslash-espacing can be used to include white-space to
152 individual parameters. By default Ecasound will try to
153 launch <em>lame</em>. As a special exception (added to Ecasound
154 2.7.0), if the output program is "lame" and options
155 include "--big-endian", Ecasound will detect this and output
156 big-endian samples.
157 <p>
158 <p><dt><strong>ext-cmd-ogg-input</strong><dd>
159 Command for starting Ogg Vorbis input. Ecasound expects that audio samples
160 are written to standard output. It should be noted that
161 Ecasound is not able to query the audio format parameters from
162 ogg files, so these need to be set manually by the user.
163 Before execution, %f is replaced with path to the input ogg.
164 Double-quotes and backslash-espacing can be used to include white-space
165 to individual parameters. By default Ecasound will try to
166 launch (ogg123).
167 <p>
168 <p><dt><strong>ext-cmd-ogg-output</strong><dd>
169 Command for starting Ogg Vorbis output. Ecasound will write
170 samples in little-endian format to standard output. Other
171 audio parameters are configurable. Before execution, %f is
172 replaced with path to the output ogg, %c, %s and %b with matching audio
173 format parameters, and %B with encoding bitrate in kbps.
174 Double-quotes and backslash-espacing can be used to include white-space to
175 individual parameters. By default Ecasound will try to
176 launch (oggenc).
177 <p>
178 <p><dt><strong>ext-cmd-mikmod</strong><dd>
179 Command for starting mikmod input. Ecasound expects that
180 signed, 16bit, stereo audio samples are written to standard
181 output. Before execution, %f is replaced with
182 file path, and %s with selected sample rate. Double-quotes
183 and backslash-espacing can be used to include white-space to
184 individual parameters. By default Ecasound will try to launch
185 <em>mikmod</em>.
186 <p>
187 <p><dt><strong>ext-cmd-timidity</strong><dd>
188 Command for starting timidity++ input. Ecasound expects that
189 signed, 16bit, stereo audio samples are written to standard
190 output. Before execution, %f is replaced with file path, and
191 %s with sample rate. Double-quotes and backslash-espacing can
192 be used to include white-space to individual parameters.
193 By default Ecasound will try to launch <em>timidity</em>.
194 <p>
195 <p><dt><strong>ext-cmd-flac-input</strong><dd>
196 Command for starting FLAC input. Ecasound expects that audio samples
197 are written to standard output. It should be noted that
198 Ecasound is not able to query the audio format parameters from
199 FLAC files, so these need to be set manually by the user.
200 Before execution, %f is replaced with path to the input FLAC
201 file. Double-quotes and backslash-espacing can be used to include
202 white-space to individual parameters. By default Ecasound will
203 try to launch (flac).
204 <p>
205 <p><dt><strong>ext-cmd-flac-output</strong><dd>
206 Command for starting FLAC output. Ecasound will write
207 samples to standard output. All audio parameters are
208 configurable. Before execution, %f is replaced with path to
209 the output flac, %c, %b and %s with matching audio
210 format parameters, %I with either 'signed' or 'unsigned', and
211 %E with either 'little' or 'big'. Double-quotes and backslash-espacing
212 can be used to include white-space to individual parameters. By default
213 Ecasound will try to launch (flac).
214 <p>
215 <p><dt><strong>ext-cmd-aac-input</strong><dd>
216 Command for starting AAC input. Ecasound expects that signed,
217 16bit, stereo, big-endian audio samplesare written to standard
218 output. It should be noted that Ecasound is not able to query
219 the input sample rate, so this needs to be set manually by the user.
220 Before execution, %f is replaced with path to the input AAC
221 file. Note! FAAC must be compiled with MP4 support. Double-quotes
222 and backslash-espacing can be used to include white-space to
223 individual parameters. By default Ecasound will try to
224 laucnh <em>faad</em>.
225 <p>
226 <p><dt><strong>ext-cmd-aac-output</strong><dd>
227 Command for starting AAC output. Ecasound will write big-endian
228 audio samples to standard output. All other audio parameters are
229 configurable. Before execution, %f is replaced with path to
230 the output AAC file, %c, %b and %s with matching audio format
231 parameters. Note! FAAC must be compiled with MP4 support. Double-quotes
232 and backslash-espacing can be used to include white-space to
233 individual parameters. By default Ecasound will try to launch
234 <em>faac</em>.
235 <p>
236 </dl>
237 <p>
238 <h2>DEPRECATED</h2>
239 <p>
240 <dl>
241 <p>
242 <p><dt><strong>ext-cmd-wave-editor</strong><dd>
243 <p>
244 </dl>
245 <p>
246 <h2>SEE ALSO</h2>
247 <p>
248 ecasound (1), ecatools (1), ecasound-iam (1)
249 <p>
250 <h2>AUTHOR</h2>
251 <p>
252 Kai Vehmanen, &lt;<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>&gt;