File: ecatools_manpage.html

package info (click to toggle)
ecasound 2.9.1-7
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 5,652 kB
  • ctags: 6,128
  • sloc: cpp: 39,403; sh: 10,512; ansic: 2,040; lisp: 1,918; makefile: 909; python: 611; ruby: 202
file content (248 lines) | stat: -rw-r--r-- 7,658 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<html><head>
<title>ecatools</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecatools</h1>
<h2>12.11.2005</h2>

<html><head>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1></h1>

<html><head>
<title>ecatools(1)</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecatools(1)</h1>
<h2> Multimedia software</h2>
<h2>12.11.2005</h2>


<p>
<h2>NAME</h2>ecatools - audio processing utils based on ecasound
<p>
<h2>SYNOPSIS</h2>
<strong>ecaconvert</strong> .extension file1 [ file2 ... fileN ]
<p>
<strong>ecafixdc</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecalength</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecamonitor</strong> [host][:port]
<p>
<strong>ecanormalize</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecaplay</strong> [-dfhklopq] [ file1 file2 ... fileN ]
<p>
<strong>ecasignalview</strong> [ options ] [ input ] [ output ]
<p>
<h2>DESCRIPTION</h2>
<p>
Ecatools are simple command line utils for audio file processing.
Each tool is designed to perform one specific operation. Most of 
the tools also support batch processing.
<p>
<strong>ECACONVERT</strong>
<p>
A tool for converting a set of files to a common target format.
This target format is given as the first command line
argument, and its syntax is <em>.ext</em>.
<p>
<strong>ECAFIXDC</strong>
<p>
A simple command-line tool for fixing DC-offset.
<p>
<strong>ECALENGTH</strong>
<p>
See the separate ecalength(1) man page.
<p>
<strong>ECAMONITOR</strong>
<p>
Ecamonitor is a util program that can be used 
to monitor an active ecasound session. Ecamonitor 
is able to show information about the current 
chainsetup such as list of inputs, outputs, 
current position, effects, the engine status 
and numerous other things.
<p>
By default ecamonitor will try to connect 
to IP4 address "localhost", to port "2868". 
A different address can be specified when 
starting ecamonitor, for example 
"ecamonitor foo.mynetwork.com" or
"ecamonitor foo.mynetwork.com:4500".
<p>
To enable inbound connections, ecasound has to be 
started with the <em>--daemon</em> option. Ecamonitor is 
implemented in Python using the NetECI API.
<p>
<strong>ECANORMALIZE</strong>
<p>
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution. Ecanormalize
first finds out how much the input file can be amplified without 
clipping and if there is room for increase, a static gain will 
be applied to the file.
<p>
<strong>ECAPLAY</strong>
<p>
Ecaplay is a command-line tool for playing audio files. Ecaplay 
uses the libecasound engine and is thus able to handle all audio formats
supported by the library. 
<p>
Files can be selected for playback either by specifying the 
filenames on the command-line, or by using the playlist 
mechanism. In playlist mode, files can be added to the playlist
using the <em>-q</em> option. The <em>-p</em> option can then be used
to play all tracks on the playlist. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C).
Playlist can be flushed with <em>-f</em> and its contents listed
with <em>-l</em> option.
<p>
If not otherwise specified, ecaplay will use the audio output device 
specified in <em>~/.ecasound/ecasoundrc</em> for playback. A different 
output device can be selected with <em>ECAPLAY_OUTPUT_DEVICE</em> shell 
environment variable or with the <em>-o:output_device</em> command-line
option.
<p>
Playback can be stopped at any time with Ctrl-C. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one. Issuing Ctrl-C twice (within one second), 
will cause ecaplay to exit.
<p>
<dl>
<p><dt><strong>-d:debuglevel</strong><dd>
Set libecasound debug level. See ecasound(1).
<p>
<p><dt><strong>-f</strong><dd>
Flush the playlist contents. See also 
options <em>-l, -p and -q</em>.
<p>
<p><dt><strong>-h</strong><dd>
Print usage information and exit.
<p>
<p><dt><strong>-k:number</strong><dd>
Skip 'number' of files.
<p>
<p><dt><strong>-l</strong><dd>
List the current playlist contents to stdout. See also 
options <em>-f, -p and -q</em>.
<p>
<p><dt><strong>-o:output_device</strong><dd>
Use 'output_device' instead of the default output device 
(as specified in <em>~/.ecasound/ecasoundrc</em>). Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page).
This option overrides the <em>ECAPLAY_OUTPUT_DEVICE</em> environment
variable (more info below).
<p>
<p><dt><strong>-p</strong><dd>
Play tracks in the playlist (in looped mode). See also 
options <em>-f, -l and -q</em>.
<p>
<p><dt><strong>-q</strong><dd> 
Queue new tracks to the playlist. All filenames given on
the command-line will be added to the the playlist. It is 
possible to queue new tracks while another instance of 
ecaplay is using the playlist. See also options <em>-f, -l 
and -p</em>.
<p>
</dl>
<p>
<strong>ECASIGNALVIEW</strong>
<p>
Ecasignalview is meant for monitoring signal amplitude and peak 
statistics. It accepts the following options:
<p>
<dl>
<p><dt><strong>input</strong><dd>
The first option not starting with a '-' is interpreted 
as an input string. This can be a device or a filename. All formats
supported by libecasound are accepted. Defaults to '/dev/dsp'.
<p>
<p><dt><strong>output</strong><dd>
Similarly to input, second option not starting with a '-'
is interpreted as output. Defaults to 'null'.
<p>
<p><dt><strong>-b:buffersize</strong><dd>
Buffersize in sample frames. Defaults to 128.
<p>
<p><dt><strong>-c</strong><dd>
Enable cumulative mode. Counters are not reseted after refresh.
<em>*deprecated*</em>
<p>
<p><dt><strong>-d</strong><dd>
Enable debug mode.
<p>
<p><dt><strong>-f:format_string</strong><dd>
Specify default audio format. See ecasound(1) for details.
<p>
<p><dt><strong>-r:rate_msec</strong><dd>
Specify screen refresh rate in milliseconds.
<p>
<p><dt><strong>-I</strong><dd>
Use linear scale for showing audio sample amplitude.
<p>
<p><dt><strong>-L</strong><dd>
Use logarithmic scale for showing audio sample amplitude.
<p>
<p><dt><strong>-G, -B, -M*, -r, -z</strong><dd>
Ecasound options use to modify the engine behaviour, see 
ecasound(1) manpage for details.
<p>
</dl>
<p>
When ecasignalview is running, the following keyboard 
commands can be used to control the operation (requires 
system support for UNIX terminal interface control):
<p>
<dl>
<p><dt><strong>spacebar</strong><dd>
Reset statistics (max-peak, avg-amplitude and clipped
samples count).
<p>
<p><dt><strong>q or Q or Esc</strong><dd>
Quit ecasignalview.
<p>
</dl>
<p>
It is also possible to reset the max-peak and clipped-samples 
counters by sending a SIGHUP signal to the process (i.e.
from another console: "killall -v -HUP ecasignalview").
<p>
More complete documentation for ecasignalview can be found 
from "Ecasound User's Guide" (see ''http://nosignal.fi/ecasound 
-&gt; Documentation'').
<p>
<h2>ENVIRONMENT</h2>
<p>
<em>ECASOUND</em>
	Path to the ecasound executable. Used by many ecatools.
<p>
<em>ECAPLAY_OUTPUT_DEVICE</em>
	Device ecaplay should use for audio output. Same syntax
	as for ecaplay/ecasound "-o" option.
<p>
<h2>FILES</h2>
<p>
<em>~/.ecasound/ecasoundrc</em>
	The default ecasound resource file. See ecasoundrc(5)
	for details.
<p>
<em>~/.ecasound/ecaplay_queue</em>
	File used to store the ecaplay playlist (one track per
	line with full path).
<p>
<h2>SEE ALSO</h2>
<p>
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
<p>
<h2>AUTHOR</h2>
<p>
Kai Vehmanen, &lt;<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>&gt;