18
20
and MIDI-CCs\&. A versatile console mode user-interface is included
23
26
Note! All options except those mentioned in \fIGlobal options\fP, can
24
27
be used in ecasound chainsetup files (\&.ecs)\&.
26
29
\fBGLOBAL OPTIONS\fP
29
32
Starts ecasound in interactive mode\&. In interactive mode you can
30
33
control ecasound with simple commands ("start", "stop", "pause",
31
etc\&.)\&. See ecasound-iam(1)\&.
34
etc\&.)\&. See ecasound-iam \&.
34
37
Disables ecasound\&'s interactive mode (see \&'-c\&' and \&'-K\&')\&.
37
40
Increase the amount of printed debug messages\&. \fI-d\fP adds
38
41
some verbosity, while \fI-ddd\fP results in very detailed
42
Set the debug level mask to \&'debug_level\&'\&. This a bitmasked value,
43
that defaults to 271\&. See ECA_LOGGER class documentation for
44
more detailed info about various debug_level values\&.
45
Set the debug level mask to \&'debug_level\&'\&. This a bitmasked value with
46
the following classes: errors (1), info (2), subsystems (4), module_names (8),
47
user_objects (16), system_objects 32, functions (64), continuous (128) and
48
eiam_return_values (256)\&. Default is 271 (1+2+4+8+256)\&. See sourcode
49
documentation for the ECA_LOGGER class for more detailed information\&.
47
52
Print all debug information to stderr (unbuffered, plain output
48
53
without ncurses)\&.
55
.IP "-R[:]path-to-file"
56
Use ecasound resource file (see ecasoundrc man page) \&'path-to-file\&' as
57
the only source of setting resource value\&. Specifying this option
58
will disable the normal policy of querying both global and user (if exists)
51
62
Quiet mode, no output\&. Same as \fI-d:0\fP\&.
53
.IP "-s[:]chainsetup-file"
64
.IP "-s[:]chainsetup-file"
54
65
Create a new chainsetup from file \&'chainsetup-file\&' and add
55
66
it to the current session\&. Chainsetup can contain inputs, outputs,
56
67
chains, effects, controllers, etc\&. A session, on the other hand,
57
68
contains all the chainsetups\&. Although only one chainsetup can
58
69
be connected at a time, you can switch between them on-the-fly\&.
61
72
Enable ecasound\&'s daemon mode\&. If this option is given,
62
73
ecasound will allow clients to connect to the running
63
74
ecasound session using a TCP/IP network connection\&.
69
80
a public network! Otherwise anyone can connect to
70
81
your ecasound sessions\&.
73
84
Set the TCP port used by the daemon mode\&. By default
74
85
ecasound will use port number \fI2868\fP\&.
77
88
Disable ecasound\&'s daemon mode\&. This is the default\&.
79
.IP "--keep-running,-K"
90
.IP "--keep-running,-K"
80
91
Do not exit when processing is finished/stopped\&. Only affects
81
92
non-interactive operating mode (see -c/-C)\&.
93
Option added to ecasound 2\&.4\&.2\&.
87
99
Print version info\&.
90
101
\fBGENERAL CHAINSETUP OPTIONS\fP
92
.IP "-a:chainname1, chainname2, \&.\&.\&."
104
.IP "-a:chainname1, chainname2, \&.\&.\&."
93
105
Selects active signal chains\&. All inputs and outputs following
94
106
this \&'-a\&' option are assigned to selected chains (until a new -a
95
107
option is specified)\&. When adding effects, controllers and other
100
112
chains effects, inputs and outputs are assigned to\&. Look at the \fBEXAMPLES\fP
101
113
section for more detailed info about the usage of this option\&.
104
116
Sets the name of chainsetup to \&'name\&'\&. If not specified, defaults
105
117
either to "command-line-setup" or to the file name from which
106
118
chainsetup was loaded\&. Whitespaces are not allowed\&.
109
121
Truncate outputs\&. All output object are opened in overwrite mode\&.
110
122
Any existing files will be truncated\&.
113
125
Open outputs for updating\&. Ecasound opens all outputs - if target
114
126
format allows it - in readwrite mode\&.
117
129
Enables \&'feature\&'\&. Most features can be disabled using notation
118
130
\fI-z:nofeature\fP\&. \&'-z:db,dbsize\&' enables double-buffering for audio
119
131
objects that support it (dbsize=0 for default, otherwise buffer
129
141
real-time inputs\&. \&'-z:psr\&' enables the \fIprecise-sample-rates\fP mode
130
142
for OSS-devices\&. \&'-z:mixmode,sum\&' enables mixing mode where channels
131
143
are mixed by summing all channels\&. The default is \&'-z:mixmode,avg\&',
132
in which channels are mixed by averaging\&.
144
in which channels are mixed by averaging\&. Mixmode selection was first
145
added to ecasound 2\&.4\&.0\&.
146
See ecasoundrc man page\&.
136
148
\fBCHAINSETUP BUFFERING AND PERFORMANCE OPTIONS\fP
138
.IP "-B:buffering_mode"
151
.IP "-B:buffering_mode"
139
152
Selects the default buffering mode\&. Mode is one of: \&'auto\&' (default),
140
153
\&'nonrt\&', \&'rt\&', \&'rtlowlatency\&'\&.
143
156
Sets the size of buffer in samples (must be an exponent of 2)\&. This
144
157
is quite an important option\&. For real-time processing, you should
145
158
set this as low as possible to reduce the processing delay\&. Some
158
171
Other ecasound threads run with priority \&'sched_priority-1\&.\&.\&.n\&'\&.
159
172
Value \&'-1\&' can be used to disable raised-priority mode\&.
162
175
Relevant features are -z:db,xxx (-z:nodb) and -z:intbuf (-z:nointbuf)\&.
163
176
See section \fIGeneral chainsetup options\fP for details\&.
166
178
\fBPROCESSING CONTROL\fP
168
180
Sets processing time in seconds (doesn\&'t have to be an integer value)\&.
169
181
If processing time isn\&'t set, engine stops when all inputs are
170
182
finished\&. This option is equivalent to the \&'cs-set-length\&' EIAM
171
183
command\&. A special-case value of \&'-1\&' will set the chainsetup length
172
184
according to the longest input object\&.
175
187
Enables looping\&. When processing is finished, engine will start
176
188
again from beginning\&. This option is equivalent to the \&'cs-loop\&'
180
191
\fBINPUT/OUTPUT SETUP\fP
182
193
See ecasound user\&'s guide for
183
194
more detailed documentation\&.
185
.IP "-G:mgrtype,optstring"
196
.IP "-G:mgrtype,optstring"
186
197
Sets options for audio object manager type \&'mgrtype\&'\&.
187
198
For available options, see "OBJECT TYPE SPECIFIC NOTES" below\&.
189
.IP "-f:sample_format,channel,sample-rate,interleaving"
200
.IP "-f:sample_format,channel,sample-rate,interleaving"
190
201
Sets default sampling parameters\&. These are used for all following
191
202
input and output files or until another -f is specified\&. If no -f
192
203
option is present, ecasound will use the default audio parameters (see
193
ecasoundrc(5) man page)\&. Notice that when opening existing audio objects,
204
ecasoundrc man page)\&. Notice that when opening existing audio objects,
194
205
either for input or output, the default audio parameters set with -f are
195
206
ignored if objects provide sufficient header information (as
196
207
is the case for wav, aiff, etc formats)\&. For output objects, the
209
220
The 4th parameter \&'interleaving\&' should either be \&'i\&' (default) for
210
221
interleaved stream format, or \&'n\&' for noninterleaved\&.
213
224
Sets starting position for last specified input/output\&. If
214
225
you need more flexible control over audio objects, you should
215
226
use the \fI\&.ewf\fP format\&.
217
.IP "-i[:]input-file-or-device"
228
.IP "-i[:]input-file-or-device[,params]"
218
229
Specifies a new input source that is connected to all selected chains\&.
219
230
Connecting multiple inputs to the same chain isn\&'t possible\&. Input
220
231
can be a a file, device or some other audio object (see below)\&.
221
232
If the input is a file, its type is determined using the file name
222
extension\&. Currently supported formats are RIFF WAVE files (\&.wav),
223
audio-cd tracks (\&.cdr), ecasound ewf-files (\&.ewf), RAW audio data
224
(\&.raw) and MPEG files (\&.mp2,\&.mp3)\&. Also, formats supported by the
225
SGI audiofile library: AIFF (\&.aiff, \&.aifc, \&.aif) and Sun/NeXT audio
226
files (\&.au, \&.snd)\&. MikMod is also supported (\&.xm, \&.mod, \&.s3m,
233
extension\&. If the object name contains any commas, the name must be
234
enclosed in backquotes to avoid confusing the parser\&. Currently supported
235
formats are RIFF WAVE files (\&.wav), audio-cd tracks (\&.cdr), ecasound
236
ewf-files (\&.ewf), RAW audio data (\&.raw) and MPEG files (\&.mp2,\&.mp3)\&. Also,
237
formats supported by the SGI audiofile library: AIFF (\&.aiff, \&.aifc, \&.aif) and
238
Sun/NeXT audio files (\&.au, \&.snd)\&. MikMod is also supported (\&.xm, \&.mod, \&.s3m,
227
239
\&.it, etc)\&. MIDI files (\&.mid) are supported using Timidity++\&. Similarly
228
240
Ogg Vorbis (\&.ogg) can be read and written if ogg123 and vorbize tools
229
are installed, FLAC files (\&.flac) with flac command-line tools,
230
and AAC files (\&.aac/\&.m4a/\&.mp4) with faad2/faac tools\&. Supported realtime
231
devices are OSS audio devices (/dev/dsp*), ALSA audio and loopback
241
are installed, FLAC files (\&.flac) with flac command-line tools or using
242
libsndfile, and AAC files (\&.aac/\&.m4a/\&.mp4) with faad2/faac tools\&. Supported
243
realtime devices are OSS audio devices (/dev/dsp*), ALSA audio and loopback
232
244
devices and JACK audio subsystem\&. If no inputs are specified, the first
233
245
non-option (doesn\&'t start with \&'-\&') command line argument is considered
234
246
to be an input\&.
236
.IP "-o[:]output-file-or-device"
248
.IP "-o[:]output-file-or-device[,params]"
237
249
Works in the same way as the -i option\&. If no outputs are specified,
238
the default output device is used (see ~/\&.ecasoundrc)\&. Note!
239
you can\&'t output to module formats supported by MikMod (this should
250
the default output device is used (see ~/\&.ecasoundrc)\&. If the object
251
name contains any commas, the name must be enclosed in backquotes to
252
avoid confusing the parser\&. Note, you can\&'t output to module formats
253
supported by MikMod (this should be obvious)\&.
242
255
\fIOBJECT TYPE SPECIFIC NOTES\fP
244
257
When using ALSA drivers, instead of a device filename, you need to
245
258
use the following option syntax: \fB-i[:]alsa,pcm_device_name\fP\&.
247
.IP "ALSA direct-hw and plugin access"
260
.IP "ALSA direct-hw and plugin access"
248
261
It\&'s also possible to use a specific card and device combination
249
262
using the following notation: \fB-i[:]alsahw,card_number,device_number,subdevice_number\fP\&.
250
263
Another option is the ALSA PCM plugin layer\&. It works just like
252
265
sample format conversions\&. Option syntax is
253
266
\fB-i[:]alsaplugin,card_number,device_number,subdevice_number\fP\&.
255
.IP "aRts input/output"
268
.IP "aRts input/output"
256
269
If enabled at compile-time, ecasound supports audio input and
257
270
output using aRts audio server\&. Option syntax is \fB-i:arts\fP,
260
.IP "Ecasound Wave Files - \&.ewf"
273
.IP "Ecasound Wave Files - \&.ewf"
261
274
A simple wrapper class for handling other audio objects\&.
262
275
See ecasound user\&'s guide for more
263
276
detailed information\&.
265
.IP "JACK input/outputs"
278
.IP "JACK input/outputs"
266
279
JACK is a low-latency audio server that can be used to connect
267
280
multiple independent audio application to each other\&.
268
281
It is different from other audio server efforts in that
305
318
override the audio format (for example you can create an
306
319
AIFF file with filename "foo\&.wav")\&.
309
322
Loop devices make it possible to route data between chains\&.
310
323
Option syntax is \fB-[io][:]loop,id_number\fP\&. If you add a loop
311
324
output with id \&'1\&', all data written to this output is routed
312
325
to all loop inputs with id \&'1\&'\&. You can attach the same loop
313
326
device to multiple inputs and outputs\&.
316
329
If mikmod support was enabled at compile-time, this
317
330
option allows you to force Ecasound to use Mikmod
318
331
for reading/writing a certain module file\&. Option syntax
319
332
is \fB-i:mikmod,foobar\&.ext\fP\&.
321
.IP "Null inputs/outputs"
334
.IP "Null inputs/outputs"
322
335
If you specify "null" or "/dev/null" as the input or output,
323
336
a null audio device is created\&. This is useful if you just want
324
337
to analyze sample data without writing it to a file\&. There\&'s
325
338
also a realtime variant, "rtnull", which behaves just like "null"
326
339
objects, except all i/o is done at realtime speed\&.
328
.IP "Resample - access object of different sample rates"
341
.IP "Resample - access object of different sample rates"
329
342
Object type \&'resample\&' can be used to resample audio
330
343
object\&'s audio data to match the sampling rate used
331
344
in the active chainsetup\&. For example,
353
366
Try converting to an uncompressed format (wav or raw)
354
367
first, and then do reversation\&.
356
.IP "System standard streams and named pipes"
369
.IP "System standard streams and named pipes"
357
370
You can use standard streams (stdin and stdout) by giving \fBstdin\fP
358
371
or \fBstdout\fP as the file name\&. Audio data is assumed to be in
359
372
raw/headerless (\&.raw) format\&. If you want to use named pipes,
360
373
create them with the proper file name extension before use\&.
362
.IP "Typeselect - overriding object type settings"
375
.IP "Typeselect - overriding object type settings"
363
376
The special \&'typeselect\&' object type can be used to override
364
377
how ecasound maps filename extensions and object types\&. For
365
378
instance \fBecasound -i typeselect,\&.mp3,an_mp3_file\&.wav -o /dev/dsp\fP\&.
366
379
would play the file \&'an_mp3_file\&.wav\&' as an mp3-file and not
367
380
as an wav-file as would happen without typeselect\&.
372
.IP "MIDI I/O devices - general"
384
.IP "MIDI I/O devices - general"
373
385
If no MIDI-device is specified, the default MIDI-device is
374
used (see ecasoundrc(5))\&.
386
used (see ecasoundrc )\&.
376
.IP "-Md:rawmidi,device_name"
388
.IP "-Md:rawmidi,device_name"
377
389
Add a rawmidi MIDI I/O device to the setup\&. \&'device_name\&' can be anything
378
390
that can be accessed using the normal UNIX file operations and
379
391
produces raw MIDI bytes\&. Valid devices are for example OSS rawmidi
380
392
devices (/dev/midi00), ALSA rawmidi devices (/dev/snd/midiC2D0), named
381
pipes (see mkfifo(1) man page), and normal files\&.
393
pipes (see mkfifo man page), and normal files\&.
383
.IP "-Md:alsaseq,sequencer-port"
395
.IP "-Md:alsaseq,sequencer-port"
384
396
Adds a ALSA MIDI sequencer port to the setup\&. \&'sequencer-port\&' identifies
385
397
a port to connect to\&. It can be numerical (e\&.g\&. 128:1), or a client
386
398
name (e\&.g\&. "KMidimon")\&.
389
401
Sends MMC start and stop to MIDI device-id \&'device_id\&'\&.
392
404
Sends MIDI-sync to the selected MIDI-device\&. Note! Ecasound will not
393
405
send \fIMIDI-clock\fP, but only \fIstart\fP and \fIstop\fP messages\&.
396
407
\fBEFFECT SETUP\fP
402
413
ecasound user\&'s guide for more
403
414
detailed information\&.
406
.IP "-pf:preset_file\&.eep"
416
.IP "-pf:preset_file\&.eep"
407
417
Uses the first preset found from file \&'preset_file\&.eep\&' as
408
418
a chain operator\&.
410
.IP "-pn:preset_name"
420
.IP "-pn:preset_name"
411
421
Find preset \&'preset_name\&' from global preset database and use
412
it as a chain operator\&. See ecasoundrc(5) for info about the
422
it as a chain operator\&. See ecasoundrc man page for info about the
413
423
preset database\&.
416
425
\fISIGNAL ANALYSIS\fP
420
428
Analyzes sample data to find out how much the signal can
421
429
be amplified without clipping\&. The resulting percent value
422
430
can be used as a parameter to -ea and -eas effects\&. Also prints
423
431
a statistics table containing info about stereo-image and
424
432
how different sample values are used\&.
427
435
Peak amplitude watcher\&. Maintains peak information for
428
436
each processed channels\&. Peak information is resetted
432
440
Finds the optimal value for DC-adjusting\&. You can use the result
433
441
as a parameter to -ezx effect\&.
436
443
\fIGENERAL SIGNAL PROCESSING ALGORITHMS\fP
438
445
Audio stamp\&. Takes a snapshot of passing audio data and stores
439
446
it using id \&'stamp-id\&' (integer number)\&. This data can later be
440
447
used by controllers and other operators\&.
443
450
Amplifies signal by amplify-% percent\&.
445
.IP "-eac:amplify-%,channel"
452
.IP "-eac:amplify-%,channel"
446
453
Amplifies signal of channel \&'channel\&' by amplify-% percent\&. \&'channel\&'
447
454
ranges from 1\&.\&.\&.n where n is the total number of channels\&.
449
.IP "-eaw:amplify-%,max-clipped-samples"
456
.IP "-eaw:amplify-%,max-clipped-samples"
450
457
Amplifies signal by amplify-% percent\&. If number of consecutive
451
458
clipped samples (resulting sample has the largest amplitude
452
459
possible) reaches \&'max-clipped-samples\&', a warning will be issued\&.
455
462
Limiter effect\&. Limits audio level to \&'limit-%\&'\&.
457
.IP "-ec:rate,threshold-%"
464
.IP "-ec:rate,threshold-%"
458
465
Compressor (a simple one)\&. \&'rate\&' is the compression rate in
459
466
decibels (\&'rate\&' dB change in input signal causes 1dB change
460
467
in output)\&. \&'threshold\&' varies between 0\&.0 (silence) and
461
468
1\&.0 (max amplitude)\&.
463
.IP "-eca:peak-level-%, release-time-sec, fast-crate, crate"
470
.IP "-eca:peak-level-%, release-time-sec, fast-crate, crate"
464
471
A more advanced compressor (original algorithm by John S\&. Dyson)\&.
465
472
If you give a value of 0 to any parameter, the default is used\&.
466
473
\&'peak-level-%\&' essentially specifies how hard the peak limiter
488
495
and stays there over \&'hold\&' ms the gate is released during
489
496
\&'release\&' ms\&.
491
.IP "-ei:pitch-shift-%"
498
.IP "-ei:pitch-shift-%"
492
499
Pitch shifter\&. Modifies audio pitch by altering its length\&.
495
502
Stereo panner\&. Changes the relative balance between the first
496
503
two channels\&. When \&'right-%\&' is 0, only signal on the left
497
504
(1st) channel is passed through\&. Similarly if it is \&'100\&',
498
505
only right (2nd) channel is let through\&.
500
.IP "-ezx:channel-count,delta-ch1,\&.\&.\&.,delta-chN"
507
.IP "-ezx:channel-count,delta-ch1,\&.\&.\&.,delta-chN"
501
508
Adjusts the signal DC by \&'delta-chX\&', where X is the
502
509
channel number\&. Use -ezf to find the optimal delta
506
512
\fIENVELOPE MODULATION\fP
508
.IP "-eemb:bpm,on-time-%"
515
.IP "-eemb:bpm,on-time-%"
509
516
Pulse gate (pulse frequency given as beats-per-minute)\&.
511
.IP "-eemp:freq-Hz,on-time-%"
518
.IP "-eemp:freq-Hz,on-time-%"
514
.IP "-eemt:bpm,depth-%"
521
.IP "-eemt:bpm,depth-%"
515
522
Tremolo effect (tremolo speed given as beats-per-minute)\&.
518
524
\fIFILTER EFFECTS\fP
519
.IP "-ef1:center_freq, width"
525
.IP "-ef1:center_freq, width"
520
526
Resonant bandpass filter\&. \&'center_freq\&' is the center frequency\&. Width
521
527
is specified in Hz\&.
523
.IP "-ef3:cutoff_freq, reso, gain"
529
.IP "-ef3:cutoff_freq, reso, gain"
524
530
Resonant lowpass filter\&. \&'cutoffr_freq\&' is the filter cutoff
525
531
frequency\&. \&'reso\&' means resonance\&. Usually the best values for
526
532
resonance are between 1\&.0 and 2\&.0, but you can use even bigger values\&.
528
534
is the normal level)\&. With high resonance values it often is useful
529
535
to reduce the gain value\&.
531
.IP "-ef4:cutoff, resonance"
537
.IP "-ef4:cutoff, resonance"
532
538
Resonant lowpass filter (3rd-order, 36dB, original algorithm by Stefan
533
539
M\&. Fendt)\&. Simulates an analog active RC-lowpass design\&. Cutoff is a
534
540
value between [0,1], while resonance is between [0,infinity)\&.
536
.IP "-efa:delay-samples,feedback-%"
542
.IP "-efa:delay-samples,feedback-%"
537
543
Allpass filter\&. Passes all frequencies with no change in amplitude\&.
538
544
However, at the same time it imposes a frequency-dependent
541
.IP "-efc:delay-samples,radius"
547
.IP "-efc:delay-samples,radius"
542
548
Comb filter\&. Allows the spikes of the comb to pass through\&.
543
549
Value of \&'radius\&' should be between [0, 1\&.0)\&.
545
.IP "-efb:center-freq,width"
551
.IP "-efb:center-freq,width"
546
552
Bandpass filter\&. \&'center_freq\&' is the center frequency\&. Width
547
553
is specified in Hz\&.
549
.IP "-efh:cutoff-freq"
555
.IP "-efh:cutoff-freq"
550
556
Highpass filter\&. Only frequencies above \&'cutoff_freq\&' are passed
553
.IP "-efi:delay-samples,radius"
559
.IP "-efi:delay-samples,radius"
554
560
Inverse comb filter\&. Filters out the spikes of the comb\&. There
555
561
are \&'delay_in_samples-2\&' spikes\&. Value of \&'radius\&' should be
556
562
between [0, 1\&.0)\&. The closer it is to the maximum value,
557
563
the deeper the dips of the comb are\&.
559
.IP "-efl:cutoff-freq"
565
.IP "-efl:cutoff-freq"
560
566
Lowpass filter\&. Only frequencies below \&'cutoff_freq\&' are passed
563
.IP "-efr:center-freq,width"
569
.IP "-efr:center-freq,width"
564
570
Bandreject filter\&. \&'center_freq\&' is the center frequency\&. Width
565
571
is specified in Hz\&.
567
.IP "-efs:center-freq,width"
573
.IP "-efs:center-freq,width"
568
574
Resonator\&. \&'center_freq\&' is the center frequency\&. Width is specified
569
575
in Hz\&. Basicly just another resonating bandpass filter\&.
572
577
\fICHANNEL MIXING / ROUTING\fP
574
.IP "-erc:from-channel, to-channel"
580
.IP "-chcopy:from-channel, to-channel"
575
581
Copy channel \&'from_channel\&' to \&'to_channel\&'\&. If \&'to_channel\&'
576
doesn\&'t exist, it is created\&. Channel indexing is started from 1\&.
578
.IP "-erm:to-channel"
582
doesn\&'t exist, it is created\&. Channel indexing starts from 1\&.
583
Option added to ecasound 2\&.4\&.5\&.
585
.IP "-chmove:from-channel, to-channel"
586
Copy channel \&'from_channel\&' to \&'to_channel\&', and mutes the source
587
channel \&'from_channel\&'\&. Channel indexing starts from 1\&.
588
Option added to ecasound 2\&.4\&.5\&.
590
.IP "-chmix:to-channel"
579
591
Mix all channels to channel \&'to_channel\&'\&. If \&'to_channel\&'
580
doesn\&'t exist, it is created\&. Channel indexing is started from 1\&.
592
doesn\&'t exist, it is created\&. Channel indexing starts from 1\&.
593
Option added to ecasound 2\&.4\&.5\&.
595
.IP "-chmute:channel"
596
Mutes the channel \&'channel\&'\&. Channel indexing starts from 1\&.
597
Option added to ecasound 2\&.4\&.5\&.
599
.IP "-erc:from-channel,to-channel"
600
Deprecated, see \fI-chcopy\fP\&.
602
.IP "-erm:to-channel"
603
Deprecated, see \fI-chmix\fP\&.
583
605
\fITIME-BASED EFFECTS\fP
585
.IP "-etc:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
608
.IP "-etc:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
588
.IP "-etd:delay-time-msec,surround-mode,number-of-delays,mix-%,feedback-%"
611
.IP "-etd:delay-time-msec,surround-mode,number-of-delays,mix-%,feedback-%"
589
612
Delay effect\&. \&'delay time\&' is the delay time in milliseconds\&.
590
613
\&'surround-mode\&' is a integer with following meanings: 0 = normal,
591
614
1 = surround, 2 = stereo-spread\&. \&'number_of_delays\&' should be
599
622
if you have set a low value for \&'mix-%\&'\&. By default the value for this
600
623
parameter is 100% (No signal loss\&.)\&.
602
.IP "-ete:room_size,feedback-%,wet-%"
625
.IP "-ete:room_size,feedback-%,wet-%"
603
626
A more advanced reverb effect (original algorithm by Stefan M\&. Fendt)\&.
604
627
\&'room_size\&' is given in meters, \&'feedback-%\&' is the feedback level
605
628
given in percents and \&'wet-%\&' is the amount of reverbed signal added
606
629
to the original signal\&.
608
.IP "-etf:delay-time-msec"
631
.IP "-etf:delay-time-msec"
609
632
Fake-stereo effect\&. The input signal is summed to mono\&. The
610
633
original signal goes to the left channels while a delayed
611
634
version (with delay of \&'delay time\&' milliseconds) is goes to
612
635
the right\&. With a delay time of 1-40 milliseconds this
613
636
adds a stereo-feel to mono-signals\&.
615
.IP "-etl:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
638
.IP "-etl:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
618
.IP "-etm:delay-time-msec,number-of-delays,mix-%"
641
.IP "-etm:delay-time-msec,number-of-delays,mix-%"
619
642
Multitap delay\&. \&'delay time\&' is the delay time in milliseconds\&.
620
643
\&'number_of_delays\&' should be obvious\&. \&'mix-%\&' determines how much
621
644
effected (wet) signal is mixed to the original\&.
623
.IP "-etp:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
646
.IP "-etp:delay-time-msec,variance-time-samples,feedback-%,lfo-freq"
626
.IP "-etr:delay-time,surround-mode,feedback-%"
649
.IP "-etr:delay-time,surround-mode,feedback-%"
627
650
Reverb effect\&. \&'delay time\&' is the delay time in milliseconds\&.
628
651
If \&'surround-mode\&' is \&'surround\&', reverbed signal moves around the
629
652
stereo image\&. \&'feedback-%\&' determines how much effected (wet)
630
653
signal is fed back to the reverb\&.
633
655
\fILADSPA-PLUGINS\fP
634
.IP "-el:plugin_unique_name,param-1,\&.\&.\&.,param-N"
656
.IP "-el:plugin_unique_name,param-1,\&.\&.\&.,param-N"
635
657
Ecasound supports LADSPA-effect plugins (Linux Audio Developer\&'s Simple
636
658
Plugin API)\&. Plugins are located in shared library (\&.so) files in
637
/usr/local/share/ladspa (configured in ecasoundrc(5))\&. One shared
659
/usr/local/share/ladspa (configured in ecasoundrc man page)\&. One shared
638
660
library file can contain multiple plugin objects, but every plugin
639
661
has a unique plugin name\&. This name is used for selecting plugins\&.
640
662
See LAD mailing list web site for
645
.IP "-eli:plugin_unique_number,param-1,\&.\&.\&.,param-N"
667
.IP "-eli:plugin_unique_number,param-1,\&.\&.\&.,param-N"
646
668
Same as above expect plugin\&'s unique id-number is used\&. It
647
669
is guaranteed that these id-numbers are unique among all
648
670
LADSPA plugins\&.
654
.IP "-gc:start-time,len"
674
.IP "-gc:start-time,len"
655
675
Time crop gate\&. Initially gate is closed\&. After \&'start-time\&' seconds
656
676
has elapsed, gate opens and remains open for \&'len\&' seconds\&. When
657
677
closed, passing audio buffers are trucated to zero length\&.
659
.IP "-ge:open-threshold-%, close-thold-%,volume-mode"
679
.IP "-ge:open-threshold-%, close-thold-%,volume-mode"
660
680
Threshold gate\&. Initially gate is closed\&. It is opened when volume
661
681
goes over \&'othreshold\&' percent\&. After this, if volume drops below
662
682
\&'cthold\&' percent, gate is closed and won\&'t be opened again\&.
673
693
three parameters are common for all controllers\&. \&'fx_param\&'
674
694
specifies the parameter to be controlled\&. Value \&'1\&' means
675
695
the first parameter, \&'2\&' the second and so on\&. \&'start_value\&'
676
and \&'end_value\&' set the value range\&. You really should see
677
\fIexamples\&.html\fP for some more info\&.
696
and \&'end_value\&' set the value range\&. For examples, look at the
697
the \fBEXAMPLES\fP section\&.
679
.IP "-kos:fx-param,start-value,end-value,freq,i-phase"
699
.IP "-kos:fx-param,start-value,end-value,freq,i-phase"
680
700
Sine oscillator with frequency of \&'freq\&' Hz and initial phase
681
701
of \&'i_phase\&' times pi\&.
683
.IP "-kog:fx-param,freq,mode,point-pairs,start-value,end-value,pos1,value1,\&.\&.\&."
703
.IP "-kog:fx-param,freq,mode,point-pairs,start-value,end-value,pos1,value1,\&.\&.\&."
684
704
Generic oscillator\&. Frequency \&'freq\&' Hz, mode either \&'0\&' for
685
705
static values or \&'1\&' for linear interpolation\&. \&'point-pairs\&'
686
706
specifies the number of \&'posN\&' - \&'valueN\&' pairs to include\&.
688
708
All \&'posN\&' and \&'valueN\&' must be between 0\&.0 and 1\&.0\&. Also,
689
709
for all \&'posN\&' values \&'pos1 < pos2 < \&.\&.\&. < posN\&' must be true\&.
691
.IP "-kf:fx-param,start-value,end-value,freq,mode,genosc-number"
711
.IP "-kf:fx-param,start-value,end-value,freq,mode,genosc-number"
692
712
Generic oscillator\&. \&'genosc_number\&' is the number of the
693
713
oscillator preset to be loaded\&. Mode is either \&'0\&' for
694
714
static values or \&'1\&' for linear interpolation\&. The location for
695
the preset file is taken from \&./ecasoundrc (see \fIecasoundrc(5)\fP)\&.
715
the preset file is taken from \&./ecasoundrc (see \fIecasoundrc man page\fP)\&.
697
.IP "-kl:fx-param,start-value,end-value,time-seconds"
717
.IP "-kl:fx-param,start-value,end-value,time-seconds"
698
718
Linear envelope that starts from \&'start_value\&' and linearly
699
719
changes to \&'end_value\&' during \&'time_in_seconds\&'\&. Can
700
720
be used for fadeins and fadeouts\&.
702
.IP "-kl2:fx-param,start-value,end-value,1st-stage-length-sec,2nd-stage-length-sec"
722
.IP "-kl2:fx-param,start-value,end-value,1st-stage-length-sec,2nd-stage-length-sec"
703
723
Two-stage linear envelope, a more versatile tool for doing fade-ins
704
724
and fade-outs\&. Stays at \&'start_value\&' for \&'1st_stage_length\&' seconds
705
725
and then linearly changes towards \&'end_value\&' during
706
726
\&'2nd_stage_length\&' seconds\&.
708
.IP "-klg:fx-param,start-value,end-value,point_count,pos1,value1,\&.\&.\&.,posN,valueN"
728
.IP "-klg:fx-param,start-value,end-value,point_count,pos1,value1,\&.\&.\&.,posN,valueN"
709
729
Generic linear envelope\&. This controller source can be
710
730
used to map custom envelopes to chain operator parameters\&.
711
731
All \&'posX\&' parameters are given as seconds (from start of the stream)\&.
712
732
\&'valueX\&' parameters must be in the range [0,1]\&.
714
.IP "-km:fx-param,start-value,end-value,controller,channel"
734
.IP "-km:fx-param,start-value,end-value,controller,channel"
715
735
MIDI continuous controller (control change messages)\&.
716
736
Messages on the MIDI-channel \&'channel\&' that are coming from
717
737
controller number \&'controller\&' are used as the controller
720
740
are values from 0 to 127\&. The MIDI-device where bytes
721
741
are read from can be specified using \fI-Md\fP option\&.
722
742
Otherwise the default MIDI-device is used as specified in
723
\fI~ecasound/ecasoundrc\fP (see \fIecasoundrc(5)\fP)\&.
743
\fI~ecasound/ecasoundrc\fP (see \fIecasoundrc man page\fP)\&.
724
744
Defaults to \fI/dev/midi\fP\&.
726
.IP "-ksv:fx-param,start-value,end-value,stamp-id,rms-toggle"
746
.IP "-ksv:fx-param,start-value,end-value,stamp-id,rms-toggle"
727
747
Volume analyze controller\&. Analyzes the audio stored in
728
748
stamp \&'stamp-id\&' (see \&'-eS:id\&' docs), and creates
729
749
control data based on the results\&. If \&'rms-toggle\&' is non-zero,
730
750
RMS-volume is used to calculate the control value\&. Otherwise
731
751
average peak-amplitude is used\&.
734
754
This is a special switch that can be used when you need
735
755
to control controller parameters with another controller\&.
736
756
When you specify \fI-kx\fP, the last specified controller
737
757
will be set as the control target\&. Then you just add
738
758
another controller as usual\&.
740
761
\fBINTERACTIVE MODE\fP
742
See \fIecasound-iam(1)\fP\&.
763
See \fIecasound-iam man page\fP\&.
747
769
If defined, some utility programs and scripts will use
748
770
the \fIECASOUND\fP environment as the default path to
749
771
ecasound executable\&.
773
.IP "ECASOUND_LOGFILE"
774
Output all debugging messages to a separate log file\&. If defined,
775
\fIECASOUND_LOGFILE\fP defines the logfile path\&. This is a good tool for
776
debugging ECI/EIAM scripts and applications\&.
778
.IP "ECASOUND_LOGLEVEL"
779
Select which messages are written to the logfile defined by
780
\fIECASOUND_LOGFILE\fP\&. The syntax for \fI-d:level\fP is used\&. If not
781
defined, all messages are written\&. Defaults to -d:319 (everything else
782
but \&'functions (64)\&' and \&'continuous (128)\&' class messages)\&.
788
In interactive mode, ecasound always returns zero\&.
790
In non-interactive (batch) mode, a non-zero value is returned
791
for the following errors:
794
Unable to create a valid chainsetup with the given parameters\&. Can be
795
caused by invalid option syntax, etc\&.
798
Unable to start processing\&. This can be caused by insufficient file
799
permissions, inability to access some system resources, etc\&.
802
Error during processing\&. Possible causes: output object has run
803
out of free disk space, etc\&.
753
808
\fI~/\&.ecasound\fP
754
809
The default directory for ecasound user resource files\&.
755
See the ecasoundrc(5) man page\&.
810
See the ecasoundrc (5) man page man page\&.
758
813
Ecasound Chainsetup files\&. Syntax is more or less the
759
814
same as with command-line arguments\&.
762
817
Ecasound Chain Preset files\&. Used for storing effect
763
818
and chain operator presets\&. See ecasound user\&'s guide for
764
819
more better documentation\&.
767
822
Ecasound Wave Stats\&. These files are used to cache
828
Examples of how to perform common tasks with ecasound can
830
http://eca\&.cx/ecasound/Documentation/examples\&.html\&.
835
ecatools (1) man page,
836
ecasound-iam (1) man page
837
ecasoundrc (5) man page,
775
838
"HTML docs in the Documentation subdirectory"
779
843
See file BUGS\&. If ecasound behaves weirdly, try to
780
844
increase the debug level to see what\&'s going on\&.
784
Kai Vehmanen, <kvehmanen -at- eca -dot- cx>
849
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>
added
removed
Documentation/ecasound.1
