« back to all changes in this revision
Viewing changes to Documentation/ecasound_manpage.html
- browse files at revision 4
- compare with another revision
- download diff
- download tarball
- view history from revision 4
- Committer: Bazaar Package Importer
- Author(s): Junichi Uekawa
- Date: 2008-03-23 21:42:49 UTC
- mfrom: (3.1.6 hardy)
- Revision ID: james.westby@ubuntu.com-20080323214249-evlfv3y1o8q747la
Tags: 2.4.6.1-2
* Bug fix: "FTBFS with GCC 4.3: missing #includes", thanks to Martin
Michlmayr (Closes: #454890).
- 13_gcc4: updated
Michlmayr (Closes: #454890).
- 13_gcc4: updated
- files added:
- debian/patches/13_gcc4.3.dpatch
- files removed:
- debian/patches/10_unprotect_filename_with_comma.dpatch
- readline-4.0
- files modified:
- AUTHORS
added
removed
Documentation/ecasound_manpage.html
1
2
3
4
5
6
7
<html><head><title>ecasound</title>
8
1
<html><head>
2
<title>ecasound</title>
9
3
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
10
4
</head>
11
5
<body>
12
13
6
<hr>
14
15
7
<h1>ecasound</h1>
16
<h2>19.08.2005</h2>
17
18
19
20
<p><h2>NAME</h2>
21
ecasound - sample editor, multitrack recorder, fx-processor, etc.
22
<p><h2>SYNOPSIS</h2>
23
8
<h2>13.08.2007</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>ecasound(1)</title>
19
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
20
</head>
21
<body>
22
<hr>
23
<h1>ecasound(1)</h1>
24
<h2> Multimedia software</h2>
25
<h2>13.08.2007</h2>
26
27
28
<p>
29
<h2>NAME</h2>ecasound - sample editor, multitrack recorder, fx-processor, etc.
30
<p>
31
<h2>SYNOPSIS</h2>
24
32
<strong>ecasound</strong> [ general_options ] { [ chain_setup ] [ effect_setup ] [ input_setup ] [ output_setup ] }
25
<p><h2>DESCRIPTION</h2>
26
27
<p>Ecasound is a software package designed for multitrack audio
33
<p>
34
<h2>DESCRIPTION</h2>
35
<p>
36
Ecasound is a software package designed for multitrack audio
28
37
processing. It can be used for simple tasks like audio playback,
29
38
recording and format conversions, as well as for multitrack effect
30
39
processing, mixing, recording and signal recycling. Ecasound supports
33
42
parameters can be controlled by operator objects like oscillators
34
43
and MIDI-CCs. A versatile console mode user-interface is included
35
44
in the package.
36
<p><h2>OPTIONS</h2>
37
38
<p>Note! All options except those mentioned in <em>Global options</em>, can
45
<p>
46
<h2>OPTIONS</h2>
47
<p>
48
Note! All options except those mentioned in <em>Global options</em>, can
39
49
be used in ecasound chainsetup files (.ecs).
40
50
<p>
51
41
52
<strong>GLOBAL OPTIONS</strong>
42
<p><dl>
43
<p></p><dt><strong>-c</strong><dd>
53
<p>
54
<dl>
55
<p><dt><strong>-c</strong><dd>
44
56
Starts ecasound in interactive mode. In interactive mode you can
45
57
control ecasound with simple commands ("start", "stop", "pause",
46
etc.). See <a href="ecasound-iam_manpage.html">ecasound-iam(1)</a>.
47
<p><p></p><dt><strong>-C</strong><dd>
58
etc.). See <a href="ecasound-iam_manpage.html">ecasound-iam </a>.
59
<p>
60
<p><dt><strong>-C</strong><dd>
48
61
Disables ecasound's interactive mode (see '-c' and '-K').
49
<p><p></p><dt><strong>-d, -dd, -ddd</strong><dd>
62
<p>
63
<p><dt><strong>-d, -dd, -ddd</strong><dd>
50
64
Increase the amount of printed debug messages. <em>-d</em> adds
51
65
some verbosity, while <em>-ddd</em> results in very detailed
52
66
output.
53
<p><p></p><dt><strong>-d:debug_level</strong><dd>
54
Set the debug level mask to 'debug_level'. This a bitmasked value,
55
that defaults to 271. See ECA_LOGGER class documentation for
56
more detailed info about various debug_level values.
57
<p><p></p><dt><strong>-D</strong><dd>
67
<p>
68
<p><dt><strong>-d:debug_level</strong><dd>
69
Set the debug level mask to 'debug_level'. This a bitmasked value with
70
the following classes: errors (1), info (2), subsystems (4), module_names (8),
71
user_objects (16), system_objects 32, functions (64), continuous (128) and
72
eiam_return_values (256). Default is 271 (1+2+4+8+256). See sourcode
73
documentation for the ECA_LOGGER class for more detailed information.
74
<p>
75
<p><dt><strong>-D</strong><dd>
58
76
Print all debug information to stderr (unbuffered, plain output
59
77
without ncurses).
60
<p><p></p><dt><strong>-q</strong><dd>
78
<p>
79
<p><dt><strong>-R[:]path-to-file</strong><dd>
80
Use ecasound resource file (see ecasoundrc man page) 'path-to-file' as
81
the only source of setting resource value. Specifying this option
82
will disable the normal policy of querying both global and user (if exists)
83
resource files.
84
<p>
85
<p><dt><strong>-q</strong><dd>
61
86
Quiet mode, no output. Same as <em>-d:0</em>.
62
<p><p></p><dt><strong>-s[:]chainsetup-file</strong><dd>
87
<p>
88
<p><dt><strong>-s[:]chainsetup-file</strong><dd>
63
89
Create a new chainsetup from file 'chainsetup-file' and add
64
90
it to the current session. Chainsetup can contain inputs, outputs,
65
91
chains, effects, controllers, etc. A session, on the other hand,
66
92
contains all the chainsetups. Although only one chainsetup can
67
93
be connected at a time, you can switch between them on-the-fly.
68
<p><p></p><dt><strong>--daemon</strong><dd>
94
<p>
95
<p><dt><strong>--daemon</strong><dd>
69
96
Enable ecasound's daemon mode. If this option is given,
70
97
ecasound will allow clients to connect to the running
71
98
ecasound session using a TCP/IP network connection.
72
99
The clients can both observe and control the session.
73
<p><em>Warning!</em> As there is no access control implemented,
100
<p>
101
<em>Warning!</em> As there is no access control implemented,
74
102
be sure to block ecasound's port in your firewall
75
103
if the machine running ecasound is connected to
76
104
a public network! Otherwise anyone can connect to
77
105
your ecasound sessions.
78
<p><p></p><dt><strong>--daemon-port</strong><dd>
106
<p>
107
<p><dt><strong>--daemon-port</strong><dd>
79
108
Set the TCP port used by the daemon mode. By default
80
109
ecasound will use port number <em>2868</em>.
81
<p><p></p><dt><strong>--nodaemon</strong><dd>
110
<p>
111
<p><dt><strong>--nodaemon</strong><dd>
82
112
Disable ecasound's daemon mode. This is the default.
83
<p><p></p><dt><strong>--keep-running,-K</strong><dd>
113
<p>
114
<p><dt><strong>--keep-running,-K</strong><dd>
84
115
Do not exit when processing is finished/stopped. Only affects
85
116
non-interactive operating mode (see -c/-C).
86
<p><p></p><dt><strong>--help,-h</strong><dd>
117
Option added to ecasound 2.4.2.
118
<p>
119
<p><dt><strong>--help,-h</strong><dd>
87
120
Show this help.
88
<p><p></p><dt><strong>--version</strong><dd>
121
<p>
122
<p><dt><strong>--version</strong><dd>
89
123
Print version info.
90
<p></dl>
91
<p>
124
<p>
125
</dl>
126
<p>
127
92
128
<strong>GENERAL CHAINSETUP OPTIONS</strong>
93
129
<dl>
94
<p><p></p><dt><strong>-a:chainname1, chainname2, ...</strong><dd>
130
<p>
131
<p><dt><strong>-a:chainname1, chainname2, ...</strong><dd>
95
132
Selects active signal chains. All inputs and outputs following
96
133
this '-a' option are assigned to selected chains (until a new -a
97
134
option is specified). When adding effects, controllers and other
101
138
to be selected. By giving multiple -a options, you can control to which
102
139
chains effects, inputs and outputs are assigned to. Look at the <strong>EXAMPLES</strong>
103
140
section for more detailed info about the usage of this option.
104
<p><p></p><dt><strong>-n:name</strong><dd>
141
<p>
142
<p><dt><strong>-n:name</strong><dd>
105
143
Sets the name of chainsetup to 'name'. If not specified, defaults
106
144
either to "command-line-setup" or to the file name from which
107
145
chainsetup was loaded. Whitespaces are not allowed.
108
<p><p></p><dt><strong>-x</strong><dd>
146
<p>
147
<p><dt><strong>-x</strong><dd>
109
148
Truncate outputs. All output object are opened in overwrite mode.
110
149
Any existing files will be truncated.
111
<p><p></p><dt><strong>-X</strong><dd>
150
<p>
151
<p><dt><strong>-X</strong><dd>
112
152
Open outputs for updating. Ecasound opens all outputs - if target
113
153
format allows it - in readwrite mode.
114
<p><p></p><dt><strong>-z:feature</strong><dd>
154
<p>
155
<p><dt><strong>-z:feature</strong><dd>
115
156
Enables 'feature'. Most features can be disabled using notation
116
157
<em>-z:nofeature</em>. '-z:db,dbsize' enables double-buffering for audio
117
158
objects that support it (dbsize=0 for default, otherwise buffer
127
168
real-time inputs. '-z:psr' enables the <em>precise-sample-rates</em> mode
128
169
for OSS-devices. '-z:mixmode,sum' enables mixing mode where channels
129
170
are mixed by summing all channels. The default is '-z:mixmode,avg',
130
in which channels are mixed by averaging.
131
See <a href="ecasoundrc_manpage.html">ecasoundrc(5)</a>.
132
<p></dl>
133
<p>
171
in which channels are mixed by averaging. Mixmode selection was first
172
added to ecasound 2.4.0.
173
See <a href="ecasoundrc_manpage.html">ecasoundrc man page</a>.
174
<p>
175
</dl>
176
<p>
177
134
178
<strong>CHAINSETUP BUFFERING AND PERFORMANCE OPTIONS</strong>
135
179
<dl>
136
<p><p></p><dt><strong>-B:buffering_mode</strong><dd>
180
<p>
181
<p><dt><strong>-B:buffering_mode</strong><dd>
137
182
Selects the default buffering mode. Mode is one of: 'auto' (default),
138
183
'nonrt', 'rt', 'rtlowlatency'.
139
<p><p></p><dt><strong>-b:buffer size</strong><dd>
184
<p>
185
<p><dt><strong>-b:buffer size</strong><dd>
140
186
Sets the size of buffer in samples (must be an exponent of 2). This
141
187
is quite an important option. For real-time processing, you should
142
188
set this as low as possible to reduce the processing delay. Some
145
191
buffer sizes will make envelopes act more smoothly. When not processing
146
192
in real-time (all inputs and outputs are normal files), values between
147
193
512 - 4096 often give better results. Default is 1024.
148
<p><p></p><dt><strong>-r:sched_priority</strong><dd>
194
<p>
195
<p><dt><strong>-r:sched_priority</strong><dd>
149
196
Use realtime scheduling policy (SCHED_FIFO). This is impossible if
150
197
ecasound doesn't have root priviledges. Beware! This gives better
151
198
performance, but can cause total lock-ups if something goes wrong.
153
200
this is the static priority to the highest priority ecasound thread.
154
201
Other ecasound threads run with priority 'sched_priority-1...n'.
155
202
Value '-1' can be used to disable raised-priority mode.
156
<p><p></p><dt><strong>-z:feature</strong><dd>
203
<p>
204
<p><dt><strong>-z:feature</strong><dd>
157
205
Relevant features are -z:db,xxx (-z:nodb) and -z:intbuf (-z:nointbuf).
158
206
See section <em>General chainsetup options</em> for details.
159
<p></dl>
160
<p>
207
<p>
208
</dl>
209
<p>
210
161
211
<strong>PROCESSING CONTROL</strong>
162
212
<dl>
163
<p></p><dt><strong>-t:seconds</strong><dd>
213
<p><dt><strong>-t:seconds</strong><dd>
164
214
Sets processing time in seconds (doesn't have to be an integer value).
165
215
If processing time isn't set, engine stops when all inputs are
166
216
finished. This option is equivalent to the 'cs-set-length' EIAM
167
217
command. A special-case value of '-1' will set the chainsetup length
168
218
according to the longest input object.
169
<p><p></p><dt><strong>-tl</strong><dd>
219
<p>
220
<p><dt><strong>-tl</strong><dd>
170
221
Enables looping. When processing is finished, engine will start
171
222
again from beginning. This option is equivalent to the 'cs-loop'
172
223
EIAM command.
173
<p></dl>
174
<p>
224
<p>
225
</dl>
226
<p>
227
175
228
<strong>INPUT/OUTPUT SETUP</strong>
176
<p>See <a href="users_guide/users_guide.html">ecasound user's guide</a> for
229
<p>
230
See <a href="users_guide/html_uguide/users_guide.html">ecasound user's guide</a> for
177
231
more detailed documentation.
178
<p><dl>
179
<p></p><dt><strong>-G:mgrtype,optstring</strong><dd>
232
<p>
233
<dl>
234
<p><dt><strong>-G:mgrtype,optstring</strong><dd>
180
235
Sets options for audio object manager type 'mgrtype'.
181
236
For available options, see "OBJECT TYPE SPECIFIC NOTES" below.
182
<p><p></p><dt><strong>-f:sample_format,channel,sample-rate,interleaving</strong><dd>
237
<p>
238
<p><dt><strong>-f:sample_format,channel,sample-rate,interleaving</strong><dd>
183
239
Sets default sampling parameters. These are used for all following
184
240
input and output files or until another -f is specified. If no -f
185
241
option is present, ecasound will use the default audio parameters (see
186
ecasoundrc(5) man page). Notice that when opening existing audio objects,
242
ecasoundrc man page). Notice that when opening existing audio objects,
187
243
either for input or output, the default audio parameters set with -f are
188
244
ignored if objects provide sufficient header information (as
189
245
is the case for wav, aiff, etc formats). For output objects, the
190
246
-x option can be used to completely overwrite existing files
191
247
(in other words, with -x, default audio parameters set with -f are used).
192
<p>Sample format is given as a a formatted string. The first letter is
248
<p>
249
Sample format is given as a a formatted string. The first letter is
193
250
either "u", "s" and "f" (unsigned, signed, floating point). The
194
251
following number specifies sample size in bits. If sample is
195
252
little endian, "_le" is added to the end. Similarly if big endian,
197
254
Currently supported formats are "u8" (same as "8"), "s16_le" (same
198
255
as "16"), "s16_be", "s24_le", "s24_be", "s32_le", "s32_be", "f32_le"
199
256
and "f32_be".
200
<p>The 4th parameter 'interleaving' should either be 'i' (default) for
257
<p>
258
The 4th parameter 'interleaving' should either be 'i' (default) for
201
259
interleaved stream format, or 'n' for noninterleaved.
202
<p><p></p><dt><strong>-y:seconds</strong><dd>
260
<p>
261
<p><dt><strong>-y:seconds</strong><dd>
203
262
Sets starting position for last specified input/output. If
204
263
you need more flexible control over audio objects, you should
205
264
use the <em>.ewf</em> format.
206
<p><p></p><dt><strong>-i[:]input-file-or-device</strong><dd>
265
<p>
266
<p><dt><strong>-i[:]input-file-or-device[,params]</strong><dd>
207
267
Specifies a new input source that is connected to all selected chains.
208
268
Connecting multiple inputs to the same chain isn't possible. Input
209
269
can be a a file, device or some other audio object (see below).
210
270
If the input is a file, its type is determined using the file name
211
extension. Currently supported formats are RIFF WAVE files (.wav),
212
audio-cd tracks (.cdr), ecasound ewf-files (.ewf), RAW audio data
213
(.raw) and MPEG files (.mp2,.mp3). Also, formats supported by the
214
SGI audiofile library: AIFF (.aiff, .aifc, .aif) and Sun/NeXT audio
215
files (.au, .snd). MikMod is also supported (.xm, .mod, .s3m,
271
extension. If the object name contains any commas, the name must be
272
enclosed in backquotes to avoid confusing the parser. Currently supported
273
formats are RIFF WAVE files (.wav), audio-cd tracks (.cdr), ecasound
274
ewf-files (.ewf), RAW audio data (.raw) and MPEG files (.mp2,.mp3). Also,
275
formats supported by the SGI audiofile library: AIFF (.aiff, .aifc, .aif) and
276
Sun/NeXT audio files (.au, .snd). MikMod is also supported (.xm, .mod, .s3m,
216
277
.it, etc). MIDI files (.mid) are supported using Timidity++. Similarly
217
278
Ogg Vorbis (.ogg) can be read and written if ogg123 and vorbize tools
218
are installed, FLAC files (.flac) with flac command-line tools,
219
and AAC files (.aac/.m4a/.mp4) with faad2/faac tools. Supported realtime
220
devices are OSS audio devices (/dev/dsp*), ALSA audio and loopback
279
are installed, FLAC files (.flac) with flac command-line tools or using
280
libsndfile, and AAC files (.aac/.m4a/.mp4) with faad2/faac tools. Supported
281
realtime devices are OSS audio devices (/dev/dsp*), ALSA audio and loopback
221
282
devices and JACK audio subsystem. If no inputs are specified, the first
222
283
non-option (doesn't start with '-') command line argument is considered
223
284
to be an input.
224
<p><p></p><dt><strong>-o[:]output-file-or-device</strong><dd>
285
<p>
286
<p><dt><strong>-o[:]output-file-or-device[,params]</strong><dd>
225
287
Works in the same way as the -i option. If no outputs are specified,
226
the default output device is used (see ~/.ecasoundrc). Note!
227
you can't output to module formats supported by MikMod (this should
228
be obvious).
229
<p><em>OBJECT TYPE SPECIFIC NOTES</em>
230
<p></p><dt><strong>ALSA devices</strong><dd>
288
the default output device is used (see ~/.ecasoundrc). If the object
289
name contains any commas, the name must be enclosed in backquotes to
290
avoid confusing the parser. Note, you can't output to module formats
291
supported by MikMod (this should be obvious).
292
<p>
293
<em>OBJECT TYPE SPECIFIC NOTES</em>
294
<p><dt><strong>ALSA devices</strong><dd>
231
295
When using ALSA drivers, instead of a device filename, you need to
232
296
use the following option syntax: <strong>-i[:]alsa,pcm_device_name</strong>.
233
<p><p></p><dt><strong>ALSA direct-hw and plugin access</strong><dd>
297
<p>
298
<p><dt><strong>ALSA direct-hw and plugin access</strong><dd>
234
299
It's also possible to use a specific card and device combination
235
300
using the following notation: <strong>-i[:]alsahw,card_number,device_number,subdevice_number</strong>.
236
301
Another option is the ALSA PCM plugin layer. It works just like
237
302
the normal ALSA pcm-devices, but with automatic channel count and
238
303
sample format conversions. Option syntax is
239
304
<strong>-i[:]alsaplugin,card_number,device_number,subdevice_number</strong>.
240
<p><p></p><dt><strong>aRts input/output</strong><dd>
305
<p>
306
<p><dt><strong>aRts input/output</strong><dd>
241
307
If enabled at compile-time, ecasound supports audio input and
242
308
output using aRts audio server. Option syntax is <strong>-i:arts</strong>,
243
309
<strong>-o:arts</strong>.
244
<p><p></p><dt><strong>Ecasound Wave Files - .ewf</strong><dd>
310
<p>
311
<p><dt><strong>Ecasound Wave Files - .ewf</strong><dd>
245
312
A simple wrapper class for handling other audio objects.
246
See <a href="users_guide/users_guide.html">ecasound user's guide</a> for more
313
See <a href="users_guide/html_uguide/users_guide.html">ecasound user's guide</a> for more
247
314
detailed information.
248
<p><p></p><dt><strong>JACK input/outputs</strong><dd>
315
<p>
316
<p><dt><strong>JACK input/outputs</strong><dd>
249
317
JACK is a low-latency audio server that can be used to connect
250
318
multiple independent audio application to each other.
251
319
It is different from other audio server efforts in that
252
320
it has been designed from the ground up to be suitable for low-latency
253
321
professional audio work.
254
<p>Ecasound provides multiple ways to communicate with JACK servers. To
322
<p>
323
Ecasound provides multiple ways to communicate with JACK servers. To
255
324
directly input or output to soundcard, use <strong>-i jack_alsa</strong> and <strong>-o
256
325
jack_alsa</strong>. To communicate with other apps, use
257
326
<strong>jack_auto,remote_clientname</strong>. To just create ports without making
258
327
any automatic connections, there are <strong>jack</strong> and
259
328
<strong>jack_generic,local_portprefix</strong>.
260
<p>Additionally global JACK options can be set using
329
<p>
330
Additionally global JACK options can be set using
261
331
<strong>-G:jack,client_name,operation_mode</strong>. 'client_name'
262
332
is the name used when registering ecasound to the JACK system.
263
333
If 'operation_mode' is "notransport", ecasound will ignore
267
337
mode "recv" ecasound will follow JACK start, stop and
268
338
position-change events; and mode "sendrecv" (the default) which
269
339
is a combination of the two previous modes.
270
<p>More details about ecasound's JACK support can be found
340
<p>
341
More details about ecasound's JACK support can be found
271
342
from ecasound user's guide.
272
<p><p></p><dt><strong>Libaudiofile</strong><dd>
343
<p>
344
<p><dt><strong>Libaudiofile</strong><dd>
273
345
If libaudiofile support was enabled at compile-time, this
274
346
option allows you to force Ecasound to use libaudiofile
275
347
for reading/writing a certain audio file. Option syntax
276
348
is <strong>-i:audiofile,foobar.ext</strong> (same for <strong>-o</strong>).
277
<p><p></p><dt><strong>Libsndfile</strong><dd>
349
<p>
350
<p><dt><strong>Libsndfile</strong><dd>
278
351
If libsndfile support was enabled at compile-time, this
279
352
option allows you to force Ecasound to use libsndfile
280
353
for reading/writing a certain audio file. Option syntax
282
355
The optional third parameter "format" can be used to
283
356
override the audio format (for example you can create an
284
357
AIFF file with filename "foo.wav").
285
<p><p></p><dt><strong>Loop device</strong><dd>
358
<p>
359
<p><dt><strong>Loop device</strong><dd>
286
360
Loop devices make it possible to route data between chains.
287
361
Option syntax is <strong>-[io][:]loop,id_number</strong>. If you add a loop
288
362
output with id '1', all data written to this output is routed
289
363
to all loop inputs with id '1'. You can attach the same loop
290
364
device to multiple inputs and outputs.
291
<p><p></p><dt><strong>Mikmod</strong><dd>
365
<p>
366
<p><dt><strong>Mikmod</strong><dd>
292
367
If mikmod support was enabled at compile-time, this
293
368
option allows you to force Ecasound to use Mikmod
294
369
for reading/writing a certain module file. Option syntax
295
370
is <strong>-i:mikmod,foobar.ext</strong>.
296
<p><p></p><dt><strong>Null inputs/outputs</strong><dd>
371
<p>
372
<p><dt><strong>Null inputs/outputs</strong><dd>
297
373
If you specify "null" or "/dev/null" as the input or output,
298
374
a null audio device is created. This is useful if you just want
299
375
to analyze sample data without writing it to a file. There's
300
376
also a realtime variant, "rtnull", which behaves just like "null"
301
377
objects, except all i/o is done at realtime speed.
302
<p><p></p><dt><strong>Resample - access object of different sample rates</strong><dd>
378
<p>
379
<p><dt><strong>Resample - access object of different sample rates</strong><dd>
303
380
Object type 'resample' can be used to resample audio
304
381
object's audio data to match the sampling rate used
305
382
in the active chainsetup. For example,
311
388
files formats such as .wav which store meta information about
312
389
the audio file format. To use 'auto' in the previous example,
313
390
<strong>ecasound -f:16,2,44100 -i resample,auto,foo.wav -o /dev/dsp</strong>.
314
<p>If ecasound was compiled with support for libsamplerate, you can
391
<p>
392
If ecasound was compiled with support for libsamplerate, you can
315
393
use 'resample-hq' to use the highest quality resampling algorithm
316
394
available. To force ecasound to use the internal resampler,
317
395
'resampler-lq' (low-quality) can be used.
318
<p><p></p><dt><strong>Reverse - process audio data backwards</strong><dd>
396
<p>
397
<p><dt><strong>Reverse - process audio data backwards</strong><dd>
319
398
Object type 'reverse' can be used to reverse audio
320
399
data coming from an audio object. As an example,
321
400
<strong>ecasound -i reverse,foo.wav -o /dev/dsp</strong> will play
324
403
slow seek operation (like mp3), works extremely badly.
325
404
Try converting to an uncompressed format (wav or raw)
326
405
first, and then do reversation.
327
<p><p></p><dt><strong>System standard streams and named pipes</strong><dd>
406
<p>
407
<p><dt><strong>System standard streams and named pipes</strong><dd>
328
408
You can use standard streams (stdin and stdout) by giving <strong>stdin</strong>
329
409
or <strong>stdout</strong> as the file name. Audio data is assumed to be in
330
410
raw/headerless (.raw) format. If you want to use named pipes,
331
411
create them with the proper file name extension before use.
332
<p><p></p><dt><strong>Typeselect - overriding object type settings</strong><dd>
412
<p>
413
<p><dt><strong>Typeselect - overriding object type settings</strong><dd>
333
414
The special 'typeselect' object type can be used to override
334
415
how ecasound maps filename extensions and object types. For
335
416
instance <strong>ecasound -i typeselect,.mp3,an_mp3_file.wav -o /dev/dsp</strong>.
336
417
would play the file 'an_mp3_file.wav' as an mp3-file and not
337
418
as an wav-file as would happen without typeselect.
338
<p></dl>
339
<p>
419
<p>
420
</dl>
421
<p>
422
340
423
<strong>MIDI SETUP</strong>
341
<p><dl>
342
<p></p><dt><strong>MIDI I/O devices - general</strong><dd>
424
<p>
425
<dl>
426
<p><dt><strong>MIDI I/O devices - general</strong><dd>
343
427
If no MIDI-device is specified, the default MIDI-device is
344
used (see ecasoundrc(5)).
345
<p><p></p><dt><strong>-Md:rawmidi,device_name</strong><dd>
428
used (see ecasoundrc ).
429
<p>
430
<p><dt><strong>-Md:rawmidi,device_name</strong><dd>
346
431
Add a rawmidi MIDI I/O device to the setup. 'device_name' can be anything
347
432
that can be accessed using the normal UNIX file operations and
348
433
produces raw MIDI bytes. Valid devices are for example OSS rawmidi
349
434
devices (/dev/midi00), ALSA rawmidi devices (/dev/snd/midiC2D0), named
350
pipes (see mkfifo(1) man page), and normal files.
351
<p><p></p><dt><strong>-Md:alsaseq,sequencer-port</strong><dd>
435
pipes (see mkfifo man page), and normal files.
436
<p>
437
<p><dt><strong>-Md:alsaseq,sequencer-port</strong><dd>
352
438
Adds a ALSA MIDI sequencer port to the setup. 'sequencer-port' identifies
353
439
a port to connect to. It can be numerical (e.g. 128:1), or a client
354
440
name (e.g. "KMidimon").
355
<p><p></p><dt><strong>-Mms:device_id</strong><dd>
441
<p>
442
<p><dt><strong>-Mms:device_id</strong><dd>
356
443
Sends MMC start and stop to MIDI device-id 'device_id'.
357
<p><p></p><dt><strong>-Mss</strong><dd>
444
<p>
445
<p><dt><strong>-Mss</strong><dd>
358
446
Sends MIDI-sync to the selected MIDI-device. Note! Ecasound will not
359
447
send <em>MIDI-clock</em>, but only <em>start</em> and <em>stop</em> messages.
360
<p></dl>
361
<p>
448
<p>
449
</dl>
450
<p>
451
362
452
<strong>EFFECT SETUP</strong>
363
<p><em>PRESETS</em>
364
<p>Ecasound has a powerful effect preset system that allows you create
453
<p>
454
<em>PRESETS</em>
455
<p>
456
Ecasound has a powerful effect preset system that allows you create
365
457
new effects by combining basic effects and controllers. See
366
<a href="users_guide/users_guide.html">ecasound user's guide</a> for more
458
<a href="users_guide/html_uguide/users_guide.html">ecasound user's guide</a> for more
367
459
detailed information.
368
<p><dl>
369
<p><p></p><dt><strong>-pf:preset_file.eep</strong><dd>
460
<p>
461
<dl>
462
<p>
463
<p><dt><strong>-pf:preset_file.eep</strong><dd>
370
464
Uses the first preset found from file 'preset_file.eep' as
371
465
a chain operator.
372
<p><p></p><dt><strong>-pn:preset_name</strong><dd>
466
<p>
467
<p><dt><strong>-pn:preset_name</strong><dd>
373
468
Find preset 'preset_name' from global preset database and use
374
it as a chain operator. See ecasoundrc(5) for info about the
469
it as a chain operator. See ecasoundrc man page for info about the
375
470
preset database.
376
<p></dl>
377
<p><em>SIGNAL ANALYSIS</em>
378
<p><dl>
379
<p><p></p><dt><strong>-ev</strong><dd>
471
<p>
472
</dl>
473
<p>
474
<em>SIGNAL ANALYSIS</em>
475
<p>
476
<dl>
477
<p>
478
<p><dt><strong>-ev</strong><dd>
380
479
Analyzes sample data to find out how much the signal can
381
480
be amplified without clipping. The resulting percent value
382
481
can be used as a parameter to -ea and -eas effects. Also prints
383
482
a statistics table containing info about stereo-image and
384
483
how different sample values are used.
385
<p><p></p><dt><strong>-evp</strong><dd>
484
<p>
485
<p><dt><strong>-evp</strong><dd>
386
486
Peak amplitude watcher. Maintains peak information for
387
487
each processed channels. Peak information is resetted
388
488
on every read.
389
<p><p></p><dt><strong>-ezf</strong><dd>
489
<p>
490
<p><dt><strong>-ezf</strong><dd>
390
491
Finds the optimal value for DC-adjusting. You can use the result
391
492
as a parameter to -ezx effect.
392
<p></dl>
393
<p><em>GENERAL SIGNAL PROCESSING ALGORITHMS</em>
493
<p>
494
</dl>
495
<p>
496
<em>GENERAL SIGNAL PROCESSING ALGORITHMS</em>
394
497
<dl>
395
<p></p><dt><strong>-eS:stamp-id</strong><dd>
498
<p><dt><strong>-eS:stamp-id</strong><dd>
396
499
Audio stamp. Takes a snapshot of passing audio data and stores
397
500
it using id 'stamp-id' (integer number). This data can later be
398
501
used by controllers and other operators.
399
<p><p></p><dt><strong>-ea:amplify-%</strong><dd>
502
<p>
503
<p><dt><strong>-ea:amplify-%</strong><dd>
400
504
Amplifies signal by amplify-% percent.
401
<p><p></p><dt><strong>-eac:amplify-%,channel</strong><dd>
505
<p>
506
<p><dt><strong>-eac:amplify-%,channel</strong><dd>
402
507
Amplifies signal of channel 'channel' by amplify-% percent. 'channel'
403
508
ranges from 1...n where n is the total number of channels.
404
<p><p></p><dt><strong>-eaw:amplify-%,max-clipped-samples</strong><dd>
509
<p>
510
<p><dt><strong>-eaw:amplify-%,max-clipped-samples</strong><dd>
405
511
Amplifies signal by amplify-% percent. If number of consecutive
406
512
clipped samples (resulting sample has the largest amplitude
407
513
possible) reaches 'max-clipped-samples', a warning will be issued.
408
<p><p></p><dt><strong>-eal:limit-%</strong><dd>
514
<p>
515
<p><dt><strong>-eal:limit-%</strong><dd>
409
516
Limiter effect. Limits audio level to 'limit-%'.
410
<p><p></p><dt><strong>-ec:rate,threshold-%</strong><dd>
517
<p>
518
<p><dt><strong>-ec:rate,threshold-%</strong><dd>
411
519
Compressor (a simple one). 'rate' is the compression rate in
412
520
decibels ('rate' dB change in input signal causes 1dB change
413
521
in output). 'threshold' varies between 0.0 (silence) and
414
522
1.0 (max amplitude).
415
<p><p></p><dt><strong>-eca:peak-level-%, release-time-sec, fast-crate, crate</strong><dd>
523
<p>
524
<p><dt><strong>-eca:peak-level-%, release-time-sec, fast-crate, crate</strong><dd>
416
525
A more advanced compressor (original algorithm by John S. Dyson).
417
526
If you give a value of 0 to any parameter, the default is used.
418
527
'peak-level-%' essentially specifies how hard the peak limiter
429
538
The default is 1.0, and holds the volume very constant without many nasty
430
539
side effects. However the dynamics in music are severely restricted,
431
540
and a value of 0.5 might keep the music more intact.
432
<p><p></p><dt><strong>-enm:threshold-level-%,pre-hold-time-msec,attack-time-msec,post-hold-time-msec,release-time-msec</strong><dd>
541
<p>
542
<p><dt><strong>-enm:threshold-level-%,pre-hold-time-msec,attack-time-msec,post-hold-time-msec,release-time-msec</strong><dd>
433
543
Noise gate. Supports multichannel processing (each channel
434
544
processed separately). When signal amplitude falls below
435
545
'threshold_level_%' percent (100% means maximum amplitude), gate
438
548
'attack' ms. If the signal raises above the 'threshold_level'
439
549
and stays there over 'hold' ms the gate is released during
440
550
'release' ms.
441
<p><p></p><dt><strong>-ei:pitch-shift-%</strong><dd>
551
<p>
552
<p><dt><strong>-ei:pitch-shift-%</strong><dd>
442
553
Pitch shifter. Modifies audio pitch by altering its length.
443
<p><p></p><dt><strong>-epp:right-%</strong><dd>
554
<p>
555
<p><dt><strong>-epp:right-%</strong><dd>
444
556
Stereo panner. Changes the relative balance between the first
445
557
two channels. When 'right-%' is 0, only signal on the left
446
558
(1st) channel is passed through. Similarly if it is '100',
447
559
only right (2nd) channel is let through.
448
<p><p></p><dt><strong>-ezx:channel-count,delta-ch1,...,delta-chN</strong><dd>
560
<p>
561
<p><dt><strong>-ezx:channel-count,delta-ch1,...,delta-chN</strong><dd>
449
562
Adjusts the signal DC by 'delta-chX', where X is the
450
563
channel number. Use -ezf to find the optimal delta
451
564
values.
452
<p></dl>
453
<p><em>ENVELOPE MODULATION</em>
565
<p>
566
</dl>
567
<p>
568
<em>ENVELOPE MODULATION</em>
454
569
<dl>
455
<p><p></p><dt><strong>-eemb:bpm,on-time-%</strong><dd>
570
<p>
571
<p><dt><strong>-eemb:bpm,on-time-%</strong><dd>
456
572
Pulse gate (pulse frequency given as beats-per-minute).
457
<p><p></p><dt><strong>-eemp:freq-Hz,on-time-%</strong><dd>
573
<p>
574
<p><dt><strong>-eemp:freq-Hz,on-time-%</strong><dd>
458
575
Pulse gate.
459
<p><p></p><dt><strong>-eemt:bpm,depth-%</strong><dd>
576
<p>
577
<p><dt><strong>-eemt:bpm,depth-%</strong><dd>
460
578
Tremolo effect (tremolo speed given as beats-per-minute).
461
<p></dl>
462
<p><em>FILTER EFFECTS</em>
579
<p>
580
</dl>
581
<p>
582
<em>FILTER EFFECTS</em>
463
583
<dl>
464
<p></p><dt><strong>-ef1:center_freq, width</strong><dd>
584
<p><dt><strong>-ef1:center_freq, width</strong><dd>
465
585
Resonant bandpass filter. 'center_freq' is the center frequency. Width
466
586
is specified in Hz.
467
<p><p></p><dt><strong>-ef3:cutoff_freq, reso, gain</strong><dd>
587
<p>
588
<p><dt><strong>-ef3:cutoff_freq, reso, gain</strong><dd>
468
589
Resonant lowpass filter. 'cutoffr_freq' is the filter cutoff
469
590
frequency. 'reso' means resonance. Usually the best values for
470
591
resonance are between 1.0 and 2.0, but you can use even bigger values.
471
592
'gain' is the overall gain-factor. It's a simple multiplier (1.0
472
593
is the normal level). With high resonance values it often is useful
473
594
to reduce the gain value.
474
<p><p></p><dt><strong>-ef4:cutoff, resonance</strong><dd>
595
<p>
596
<p><dt><strong>-ef4:cutoff, resonance</strong><dd>
475
597
Resonant lowpass filter (3rd-order, 36dB, original algorithm by Stefan
476
598
M. Fendt). Simulates an analog active RC-lowpass design. Cutoff is a
477
599
value between [0,1], while resonance is between [0,infinity).
478
<p><p></p><dt><strong>-efa:delay-samples,feedback-%</strong><dd>
600
<p>
601
<p><dt><strong>-efa:delay-samples,feedback-%</strong><dd>
479
602
Allpass filter. Passes all frequencies with no change in amplitude.
480
603
However, at the same time it imposes a frequency-dependent
481
604
phase-shift.
482
<p><p></p><dt><strong>-efc:delay-samples,radius</strong><dd>
605
<p>
606
<p><dt><strong>-efc:delay-samples,radius</strong><dd>
483
607
Comb filter. Allows the spikes of the comb to pass through.
484
608
Value of 'radius' should be between [0, 1.0).
485
<p><p></p><dt><strong>-efb:center-freq,width</strong><dd>
609
<p>
610
<p><dt><strong>-efb:center-freq,width</strong><dd>
486
611
Bandpass filter. 'center_freq' is the center frequency. Width
487
612
is specified in Hz.
488
<p><p></p><dt><strong>-efh:cutoff-freq</strong><dd>
613
<p>
614
<p><dt><strong>-efh:cutoff-freq</strong><dd>
489
615
Highpass filter. Only frequencies above 'cutoff_freq' are passed
490
616
through.
491
<p><p></p><dt><strong>-efi:delay-samples,radius</strong><dd>
617
<p>
618
<p><dt><strong>-efi:delay-samples,radius</strong><dd>
492
619
Inverse comb filter. Filters out the spikes of the comb. There
493
620
are 'delay_in_samples-2' spikes. Value of 'radius' should be
494
621
between [0, 1.0). The closer it is to the maximum value,
495
622
the deeper the dips of the comb are.
496
<p><p></p><dt><strong>-efl:cutoff-freq</strong><dd>
623
<p>
624
<p><dt><strong>-efl:cutoff-freq</strong><dd>
497
625
Lowpass filter. Only frequencies below 'cutoff_freq' are passed
498
626
through.
499
<p><p></p><dt><strong>-efr:center-freq,width</strong><dd>
627
<p>
628
<p><dt><strong>-efr:center-freq,width</strong><dd>
500
629
Bandreject filter. 'center_freq' is the center frequency. Width
501
630
is specified in Hz.
502
<p><p></p><dt><strong>-efs:center-freq,width</strong><dd>
631
<p>
632
<p><dt><strong>-efs:center-freq,width</strong><dd>
503
633
Resonator. 'center_freq' is the center frequency. Width is specified
504
634
in Hz. Basicly just another resonating bandpass filter.
505
<p></dl>
506
<p><em>CHANNEL MIXING / ROUTING</em>
635
<p>
636
</dl>
637
<p>
638
<em>CHANNEL MIXING / ROUTING</em>
507
639
<dl>
508
<p><p></p><dt><strong>-erc:from-channel, to-channel</strong><dd>
640
<p>
641
<p><dt><strong>-chcopy:from-channel, to-channel</strong><dd>
509
642
Copy channel 'from_channel' to 'to_channel'. If 'to_channel'
510
doesn't exist, it is created. Channel indexing is started from 1.
511
<p><p></p><dt><strong>-erm:to-channel</strong><dd>
643
doesn't exist, it is created. Channel indexing starts from 1.
644
Option added to ecasound 2.4.5.
645
<p>
646
<p><dt><strong>-chmove:from-channel, to-channel</strong><dd>
647
Copy channel 'from_channel' to 'to_channel', and mutes the source
648
channel 'from_channel'. Channel indexing starts from 1.
649
Option added to ecasound 2.4.5.
650
<p>
651
<p><dt><strong>-chmix:to-channel</strong><dd>
512
652
Mix all channels to channel 'to_channel'. If 'to_channel'
513
doesn't exist, it is created. Channel indexing is started from 1.
514
<p></dl>
515
<p><em>TIME-BASED EFFECTS</em>
653
doesn't exist, it is created. Channel indexing starts from 1.
654
Option added to ecasound 2.4.5.
655
<p>
656
<p><dt><strong>-chmute:channel</strong><dd>
657
Mutes the channel 'channel'. Channel indexing starts from 1.
658
Option added to ecasound 2.4.5.
659
<p>
660
<p><dt><strong>-erc:from-channel,to-channel</strong><dd>
661
Deprecated, see <em>-chcopy</em>.
662
<p>
663
<p><dt><strong>-erm:to-channel</strong><dd>
664
Deprecated, see <em>-chmix</em>.
665
<p>
666
</dl>
667
<p>
668
<em>TIME-BASED EFFECTS</em>
516
669
<dl>
517
<p><p></p><dt><strong>-etc:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
670
<p>
671
<p><dt><strong>-etc:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
518
672
Chorus.
519
<p><p></p><dt><strong>-etd:delay-time-msec,surround-mode,number-of-delays,mix-%,feedback-%</strong><dd>
673
<p>
674
<p><dt><strong>-etd:delay-time-msec,surround-mode,number-of-delays,mix-%,feedback-%</strong><dd>
520
675
Delay effect. 'delay time' is the delay time in milliseconds.
521
676
'surround-mode' is a integer with following meanings: 0 = normal,
522
677
1 = surround, 2 = stereo-spread. 'number_of_delays' should be
529
684
lesser than what you have specified for 'number_of_delays', especially
530
685
if you have set a low value for 'mix-%'. By default the value for this
531
686
parameter is 100% (No signal loss.).
532
<p><p></p><dt><strong>-ete:room_size,feedback-%,wet-%</strong><dd>
687
<p>
688
<p><dt><strong>-ete:room_size,feedback-%,wet-%</strong><dd>
533
689
A more advanced reverb effect (original algorithm by Stefan M. Fendt).
534
690
'room_size' is given in meters, 'feedback-%' is the feedback level
535
691
given in percents and 'wet-%' is the amount of reverbed signal added
536
692
to the original signal.
537
<p><p></p><dt><strong>-etf:delay-time-msec</strong><dd>
693
<p>
694
<p><dt><strong>-etf:delay-time-msec</strong><dd>
538
695
Fake-stereo effect. The input signal is summed to mono. The
539
696
original signal goes to the left channels while a delayed
540
697
version (with delay of 'delay time' milliseconds) is goes to
541
698
the right. With a delay time of 1-40 milliseconds this
542
699
adds a stereo-feel to mono-signals.
543
<p><p></p><dt><strong>-etl:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
700
<p>
701
<p><dt><strong>-etl:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
544
702
Flanger.
545
<p><p></p><dt><strong>-etm:delay-time-msec,number-of-delays,mix-%</strong><dd>
703
<p>
704
<p><dt><strong>-etm:delay-time-msec,number-of-delays,mix-%</strong><dd>
546
705
Multitap delay. 'delay time' is the delay time in milliseconds.
547
706
'number_of_delays' should be obvious. 'mix-%' determines how much
548
707
effected (wet) signal is mixed to the original.
549
<p><p></p><dt><strong>-etp:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
708
<p>
709
<p><dt><strong>-etp:delay-time-msec,variance-time-samples,feedback-%,lfo-freq</strong><dd>
550
710
Phaser.
551
<p><p></p><dt><strong>-etr:delay-time,surround-mode,feedback-%</strong><dd>
711
<p>
712
<p><dt><strong>-etr:delay-time,surround-mode,feedback-%</strong><dd>
552
713
Reverb effect. 'delay time' is the delay time in milliseconds.
553
714
If 'surround-mode' is 'surround', reverbed signal moves around the
554
715
stereo image. 'feedback-%' determines how much effected (wet)
555
716
signal is fed back to the reverb.
556
<p></dl>
557
<p><em>LADSPA-PLUGINS</em>
717
<p>
718
</dl>
719
<p>
720
<em>LADSPA-PLUGINS</em>
558
721
<dl>
559
<p></p><dt><strong>-el:plugin_unique_name,param-1,...,param-N</strong><dd>
722
<p><dt><strong>-el:plugin_unique_name,param-1,...,param-N</strong><dd>
560
723
Ecasound supports LADSPA-effect plugins (Linux Audio Developer's Simple
561
724
Plugin API). Plugins are located in shared library (.so) files in
562
/usr/local/share/ladspa (configured in ecasoundrc(5)). One shared
725
/usr/local/share/ladspa (configured in ecasoundrc man page). One shared
563
726
library file can contain multiple plugin objects, but every plugin
564
727
has a unique plugin name. This name is used for selecting plugins.
565
728
See <a href="http://www.linuxdj.com/audio/lad">LAD mailing list web site</a> for
566
729
more info about LADSPA. Other useful sites are <a href="http://www.ladspa.org">LADSPA home
567
730
page</a> and <a href="http://www.ffem.org/gdam/ladspa-doc/ladspa.html">LADSPA
568
731
documentation</a>.
569
<p><p></p><dt><strong>-eli:plugin_unique_number,param-1,...,param-N</strong><dd>
732
<p>
733
<p><dt><strong>-eli:plugin_unique_number,param-1,...,param-N</strong><dd>
570
734
Same as above expect plugin's unique id-number is used. It
571
735
is guaranteed that these id-numbers are unique among all
572
736
LADSPA plugins.
573
<p></dl>
574
<p><strong>GATE SETUP</strong>
575
<p><dl>
576
<p><p></p><dt><strong>-gc:start-time,len</strong><dd>
737
<p>
738
</dl>
739
<p>
740
<strong>GATE SETUP</strong>
741
<p>
742
<dl>
743
<p>
744
<p><dt><strong>-gc:start-time,len</strong><dd>
577
745
Time crop gate. Initially gate is closed. After 'start-time' seconds
578
746
has elapsed, gate opens and remains open for 'len' seconds. When
579
747
closed, passing audio buffers are trucated to zero length.
580
<p><p></p><dt><strong>-ge:open-threshold-%, close-thold-%,volume-mode</strong><dd>
748
<p>
749
<p><dt><strong>-ge:open-threshold-%, close-thold-%,volume-mode</strong><dd>
581
750
Threshold gate. Initially gate is closed. It is opened when volume
582
751
goes over 'othreshold' percent. After this, if volume drops below
583
752
'cthold' percent, gate is closed and won't be opened again.
584
753
If 'value_mode' is 'rms', average RMS volume is used. Otherwise
585
754
peak average is used. When closed, passing audio buffers are trucated
586
755
to zero length.
587
<p></dl>
588
<p>
756
<p>
757
</dl>
758
<p>
759
589
760
<strong>CONTROL ENVELOPE SETUP</strong>
590
761
<dl>
591
<p>Controllers can be used to dynamically change effect parameters
762
<p>
763
Controllers can be used to dynamically change effect parameters
592
764
during processing. All controllers are attached to the selected
593
765
(=usually the last specified effect/controller) effect. The first
594
766
three parameters are common for all controllers. 'fx_param'
595
767
specifies the parameter to be controlled. Value '1' means
596
768
the first parameter, '2' the second and so on. 'start_value'
597
and 'end_value' set the value range. You really should see
598
<em>examples.html</em> for some more info.
599
<p><p></p><dt><strong>-kos:fx-param,start-value,end-value,freq,i-phase</strong><dd>
769
and 'end_value' set the value range. For examples, look at the
770
the <strong>EXAMPLES</strong> section.
771
<p>
772
<p><dt><strong>-kos:fx-param,start-value,end-value,freq,i-phase</strong><dd>
600
773
Sine oscillator with frequency of 'freq' Hz and initial phase
601
774
of 'i_phase' times pi.
602
<p><p></p><dt><strong>-kog:fx-param,freq,mode,point-pairs,start-value,end-value,pos1,value1,...</strong><dd>
775
<p>
776
<p><dt><strong>-kog:fx-param,freq,mode,point-pairs,start-value,end-value,pos1,value1,...</strong><dd>
603
777
Generic oscillator. Frequency 'freq' Hz, mode either '0' for
604
778
static values or '1' for linear interpolation. 'point-pairs'
605
779
specifies the number of 'posN' - 'valueN' pairs to include.
606
780
'start-value' and 'end-value' are used as border values.
607
781
All 'posN' and 'valueN' must be between 0.0 and 1.0. Also,
608
782
for all 'posN' values 'pos1 < pos2 < ... < posN' must be true.
609
<p><p></p><dt><strong>-kf:fx-param,start-value,end-value,freq,mode,genosc-number</strong><dd>
783
<p>
784
<p><dt><strong>-kf:fx-param,start-value,end-value,freq,mode,genosc-number</strong><dd>
610
785
Generic oscillator. 'genosc_number' is the number of the
611
786
oscillator preset to be loaded. Mode is either '0' for
612
787
static values or '1' for linear interpolation. The location for
613
the preset file is taken from ./ecasoundrc (see <em>ecasoundrc(5)</em>).
614
<p><p></p><dt><strong>-kl:fx-param,start-value,end-value,time-seconds</strong><dd>
788
the preset file is taken from ./ecasoundrc (see <em>ecasoundrc man page</em>).
789
<p>
790
<p><dt><strong>-kl:fx-param,start-value,end-value,time-seconds</strong><dd>
615
791
Linear envelope that starts from 'start_value' and linearly
616
792
changes to 'end_value' during 'time_in_seconds'. Can
617
793
be used for fadeins and fadeouts.
618
<p><p></p><dt><strong>-kl2:fx-param,start-value,end-value,1st-stage-length-sec,2nd-stage-length-sec</strong><dd>
794
<p>
795
<p><dt><strong>-kl2:fx-param,start-value,end-value,1st-stage-length-sec,2nd-stage-length-sec</strong><dd>
619
796
Two-stage linear envelope, a more versatile tool for doing fade-ins
620
797
and fade-outs. Stays at 'start_value' for '1st_stage_length' seconds
621
798
and then linearly changes towards 'end_value' during
622
799
'2nd_stage_length' seconds.
623
<p><p></p><dt><strong>-klg:fx-param,start-value,end-value,point_count,pos1,value1,...,posN,valueN</strong><dd>
800
<p>
801
<p><dt><strong>-klg:fx-param,start-value,end-value,point_count,pos1,value1,...,posN,valueN</strong><dd>
624
802
Generic linear envelope. This controller source can be
625
803
used to map custom envelopes to chain operator parameters.
626
804
All 'posX' parameters are given as seconds (from start of the stream).
627
805
'valueX' parameters must be in the range [0,1].
628
<p><p></p><dt><strong>-km:fx-param,start-value,end-value,controller,channel</strong><dd>
806
<p>
807
<p><dt><strong>-km:fx-param,start-value,end-value,controller,channel</strong><dd>
629
808
MIDI continuous controller (control change messages).
630
809
Messages on the MIDI-channel 'channel' that are coming from
631
810
controller number 'controller' are used as the controller
634
813
are values from 0 to 127. The MIDI-device where bytes
635
814
are read from can be specified using <em>-Md</em> option.
636
815
Otherwise the default MIDI-device is used as specified in
637
<em>~ecasound/ecasoundrc</em> (see <em>ecasoundrc(5)</em>).
816
<em>~ecasound/ecasoundrc</em> (see <em>ecasoundrc man page</em>).
638
817
Defaults to <em>/dev/midi</em>.
639
<p><p></p><dt><strong>-ksv:fx-param,start-value,end-value,stamp-id,rms-toggle</strong><dd>
818
<p>
819
<p><dt><strong>-ksv:fx-param,start-value,end-value,stamp-id,rms-toggle</strong><dd>
640
820
Volume analyze controller. Analyzes the audio stored in
641
821
stamp 'stamp-id' (see '-eS:id' docs), and creates
642
822
control data based on the results. If 'rms-toggle' is non-zero,
643
823
RMS-volume is used to calculate the control value. Otherwise
644
824
average peak-amplitude is used.
645
<p><p></p><dt><strong>-kx</strong><dd>
825
<p>
826
<p><dt><strong>-kx</strong><dd>
646
827
This is a special switch that can be used when you need
647
828
to control controller parameters with another controller.
648
829
When you specify <em>-kx</em>, the last specified controller
650
831
another controller as usual.
651
832
</dl>
652
833
<p>
834
653
835
<strong>INTERACTIVE MODE</strong>
654
<p>See <em>ecasound-iam(1)</em>.
655
<p><h2>ENVIRONMENT</h2>
656
657
<p><em>ECASOUND</em>
836
<p>
837
See <em>ecasound-iam man page</em>.
838
<p>
839
<h2>ENVIRONMENT</h2>
840
<p>
841
<dl>
842
<p><dt><strong>ECASOUND</strong><dd>
658
843
If defined, some utility programs and scripts will use
659
844
the <em>ECASOUND</em> environment as the default path to
660
845
ecasound executable.
661
<p><h2>FILES</h2>
662
663
<p><em>~/.ecasound</em>
846
<p>
847
<p><dt><strong>ECASOUND_LOGFILE</strong><dd>
848
Output all debugging messages to a separate log file. If defined,
849
<em>ECASOUND_LOGFILE</em> defines the logfile path. This is a good tool for
850
debugging ECI/EIAM scripts and applications.
851
<p>
852
<p><dt><strong>ECASOUND_LOGLEVEL</strong><dd>
853
Select which messages are written to the logfile defined by
854
<em>ECASOUND_LOGFILE</em>. The syntax for <em>-d:level</em> is used. If not
855
defined, all messages are written. Defaults to -d:319 (everything else
856
but 'functions (64)' and 'continuous (128)' class messages).
857
</dl>
858
<p>
859
<h2>RETURN VALUES</h2>
860
<p>
861
In interactive mode, ecasound always returns zero.
862
<p>
863
In non-interactive (batch) mode, a non-zero value is returned
864
for the following errors:
865
<p>
866
<dl>
867
<p><dt><strong>1</strong><dd>
868
Unable to create a valid chainsetup with the given parameters. Can be
869
caused by invalid option syntax, etc.
870
<p>
871
<p><dt><strong>2</strong><dd>
872
Unable to start processing. This can be caused by insufficient file
873
permissions, inability to access some system resources, etc.
874
<p>
875
<p><dt><strong>3</strong><dd>
876
Error during processing. Possible causes: output object has run
877
out of free disk space, etc.
878
<p>
879
<h2>FILES</h2>
880
<p>
881
<em>~/.ecasound</em>
664
882
The default directory for ecasound user resource files.
665
See the <a href="ecasoundrc_manpage.html">ecasoundrc(5)</a> man page.
666
<p><em>*.ecs</em>
883
See the <a href="ecasoundrc_manpage.html">ecasoundrc (5) man page</a> man page.
884
<p>
885
<em>*.ecs</em>
667
886
Ecasound Chainsetup files. Syntax is more or less the
668
887
same as with command-line arguments.
669
<p><em>*.ecp</em>
888
<p>
889
<em>*.ecp</em>
670
890
Ecasound Chain Preset files. Used for storing effect
671
891
and chain operator presets. See <a href="users_guide/html_uguide/users_guide.html">ecasound user's guide</a> for
672
892
more better documentation.
673
<p><em>*.ews</em>
893
<p>
894
<em>*.ews</em>
674
895
Ecasound Wave Stats. These files are used to cache
675
896
waveform data.
676
<p><h2>SEE ALSO</h2>
677
678
<p><a href="ecatools_manpage.html">ecatools(1)</a>,
679
<a href="ecasound-iam_manpage.html">ecasound-iam(1)</a>
680
<a href="ecasoundrc_manpage.html">ecasoundrc(5)</a>,
897
<p>
898
<h2>EXAMPLES</h2>
899
<p>
900
Examples of how to perform common tasks with ecasound can
901
be found at
902
<a href="http://eca.cx/ecasound/Documentation/examples.html">http://eca.cx/ecasound/Documentation/examples.html</a>.
903
<p>
904
<h2>SEE ALSO</h2>
905
<p>
906
<a href="ecatools_manpage.html">ecatools (1) man page</a>,
907
<a href="ecasound-iam_manpage.html">ecasound-iam (1) man page</a>
908
<a href="ecasoundrc_manpage.html">ecasoundrc (5) man page</a>,
681
909
<a href="index.html">"HTML docs in the Documentation subdirectory"</a>
682
<p><h2>BUGS</h2>
683
684
<p>See file BUGS. If ecasound behaves weirdly, try to
910
<p>
911
<h2>BUGS</h2>
912
<p>
913
See file BUGS. If ecasound behaves weirdly, try to
685
914
increase the debug level to see what's going on.
686
<p><h2>AUTHOR</h2>
687
688
<p>Kai Vehmanen, <<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>>
689
</body>
690
</html>
915
<p>
916
<h2>AUTHOR</h2>
917
<p>
918
Kai Vehmanen, <<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1