105
105
session, and use interactive mode commands to control and
106
106
observe ecasound processing.
108
The NetECI protocol is defined in
109
<a href="http://eca.cx/ecasound/Documentation/programmers_guide/ecasound_programmers_guide.html#neteci-various">Ecasound's Programmer Guide</a>
108
111
One example client using this feature is ecamonitor(1). This
109
112
utility is included in the Ecasound distribution package (requires
110
113
a working Python environment).
125
128
Disable ecasound's daemon mode. This is the default.
126
129
This option replaces '--nodaemon' (deprecated in 2.6.0).
131
<p><dt><strong>--osc-udp-port=NNN</strong><dd>
132
Enables support for Open Source Control (OSC). Ecasound will listen
133
for incoming OSC messages on UDP port NNN. Ecasound's OSC interface
135
<http://ecasound.git.sourceforge.net/git/gitweb.cgi?p=ecasound/ecasound;a=blob;f=Documentation/ecasound_osc_interface.txt;hb=HEAD>
137
Note that OSC support is still experimental and the interface
138
might change in later versions of Ecasound.
140
This option was added to ecasound 2.7.0.
128
142
<p><dt><strong>--keep-running,-K</strong><dd>
129
143
Do not exit when processing is finished/stopped. Only affects
130
144
non-interactive operating mode (see -c/-C).
645
659
<p><dt><strong>-ev</strong><dd>
646
660
Analyzes sample data to find out how much the signal can
647
661
be amplified without clipping. The resulting percent value
648
can be used as a parameter to -ea and -eas effects. Also prints
649
a statistics table containing info about stereo-image and
650
how different sample values are used.
662
can be used as a parameter to '-ea' (amplify). A statistical
663
summary, containing info about the stereo-image and
664
distribution of sample values, is printed out at the end
652
667
<p><dt><strong>-evp</strong><dd>
653
668
Peak amplitude watcher. Maintains peak information for
667
682
it using id 'stamp-id' (integer number). This data can later be
668
683
used by controllers and other operators.
670
<p><dt><strong>-ea:amplify-%</strong><dd>
671
Amplifies signal by amplify-% percent (linear scale, i.e. individual
672
samples are multiplied by 'amplify-%/100').
685
<p><dt><strong>-ea:amplify%</strong><dd>
686
Adjusts the signal amplitude to 'amplify%' percent (linear scale, i.e.
687
individual samples are multiplied by 'amplify%/100'). See also
674
<p><dt><strong>-eac:amplify-%,channel</strong><dd>
690
<p><dt><strong>-eac:amplify%,channel</strong><dd>
675
691
Amplifies signal of channel 'channel' by amplify-% percent (linear
676
scale, i.e. individual samples are multiplied by 'amplify-%/100').
692
scale, i.e. individual samples are multiplied by 'amplify%/100').
677
693
'channel' ranges from 1...n where n is the total number of channels.
679
<p><dt><strong>-eaw:amplify-%,max-clipped-samples</strong><dd>
680
Amplifies signal by amplify-% percent. If number of consecutive
681
clipped samples (resulting sample has the largest amplitude
682
possible) reaches 'max-clipped-samples', a warning will be issued.
696
<p><dt><strong>-eadb:gain-dB[,channel]</strong><dd>
697
Adjusts signal level by 'gain-dB', with a gain of 0dB having no effect
698
to the signal, negative gains attenuating the signal and positive
699
gain values amplifying it. The 'channel' parameter (1...n) is optional.
700
If 'channel' parameter is specified, and its value is nonzero, gain is
701
only applied to the given channel (1...n).
703
<p><dt><strong>-eaw:amplify%,max-clipped-samples</strong><dd>
704
Amplifies signal by amplify-% percent (linear scale, i.e. individual
705
samples are multiplied by 'amplify%/100'). If number of consecutive
706
clipped samples (resulting sample value is outside the nominal
707
[-1,1] range), a warning will be issued.
684
709
<p><dt><strong>-eal:limit-%</strong><dd>
685
Limiter effect. Limits audio level to 'limit-%'.
710
Limiter effect. Limits audio level to 'limit-%' (linear scale) with
711
values equal or greater than 100% resulting in no change to
687
714
<p><dt><strong>-ec:rate,threshold-%</strong><dd>
688
715
Compressor (a simple one). 'rate' is the compression rate in
817
844
channel 'from_channel'. Channel indexing starts from 1.
818
845
Option added to ecasound 2.4.5.
847
<p><dt><strong>-chorder:ch1,...,chN</strong><dd>
848
Reorder, omit and/r duplicate chain channels. The resulting
849
audio stream has total of 'N' channels. Each parameter specifies
850
the source channel to use for given output channel. As an
851
example, '-chorder:2,1' would reverse the channels of
852
a stereo stream ('out1,out2' = 'in2,in1'). Specifying the same
853
source channel multiple times is allowed. For example, '-chorder:2,2'
854
would route the second channel to both two output channels
855
('out1,out2' = 'in2,in2'). If 'chX' is zero, the given channel 'X'
856
will be muted in the output stream. Option added to ecasound 2.7.0.
820
858
<p><dt><strong>-chmix:to-channel</strong><dd>
821
Mix all channels to channel 'to_channel'. If 'to_channel'
859
Mix all source channels to channel 'to_channel'. If 'to_channel'
822
860
doesn't exist, it is created. Channel indexing starts from 1.
823
861
Option added to ecasound 2.4.5.
1041
1079
<em>ECASOUND_LOGFILE</em>. The syntax for <em>-d:level</em> is used. If not
1042
1080
defined, all messages are written. Defaults to -d:319 (everything else
1043
1081
but 'functions (64)' and 'continuous (128)' class messages).
1083
<p><dt><strong>COLUMNS</strong><dd>
1084
Ecasound honors the <em>COLUMNS</em> environment variable when
1085
formatting printed trace messages. If <em>COLUMNS</em> is not set,
1086
a default of 74 is used.
1046
1089
<h2>RETURN VALUES</h2>
1063
1106
Error during processing. Possible causes: output object has run
1064
1107
out of free disk space, etc.
1109
<p><dt><strong>4</strong><dd>
1110
Error during process termination and/or cleanup. See section
1111
on 'SIGNALS' for further details.
1115
When ecasound receives any of the POSIX signals SIGINT (ctrl-c),
1116
SIGHUP, SIGTERM or SIGQUIT, normal cleanup and exit procedure is
1117
initiated. Here normal exit means that e.g. file headers are
1118
updated before closing, helper processes are terminated in normal
1121
If, while doing the cleanup described above, ecasound receives
1122
another signal (of the same set of POSIX signals), ecasound
1123
will skip the normal cleanup procedure, and terminate
1124
immediately. Any remaining cleanup tasks will be skipped.
1125
Depending on the runtime state and configuration, this brute
1126
force exit may have some side-effects. Ecasound will return
1127
exit code of '4' if normal cleanup was skipped.
1129
Special case handling is applied to the SIGINT (ctrl-c) signal.
1130
If a SIGINT signal is received during the cleanup procedure,
1131
ecasound will ignore the signal once, and emit a notice to 'stderr'
1132
that cleanup is already in progress. Any subsequent SIGINT signals
1133
will no longer get special handling, and instead process will
1134
terminate immediately (and possibly without proper cleanup).
1068
1138
<em>~/.ecasound</em>
added
removed
Documentation/ecasound_manpage.html
