~ubuntu-branches/ubuntu/natty/ecasound2.2/natty

« back to all changes in this revision

Viewing changes to Documentation/ecatools_manpage.man

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2008-09-26 09:58:52 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20080926095852-k3v9ewhmxpaltusw
Tags: 2.5.2-3
yodl 2.13.1 removed --unique-output option. Remove --unique-output
accordingly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
2
 
 
3
 
.PP 
4
 
.SH "NAME"
5
 
ecatools \- audio processing utils based on ecasound
6
 
.PP 
7
 
.SH "SYNOPSIS"
8
 
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
9
 
.PP 
10
 
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
11
 
.PP 
12
 
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
13
 
.PP 
14
 
\fBecamonitor\fP [host][:port]
15
 
.PP 
16
 
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
17
 
.PP 
18
 
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
19
 
.PP 
20
 
\fBecasignalview\fP [ options ] [ input ] [ output ]
21
 
.PP 
22
 
.SH "DESCRIPTION"
23
 
 
24
 
.PP 
25
 
Ecatools are simple command line utils for audio file processing\&.
26
 
Each tool is designed to perform one specific operation\&. Most of 
27
 
the tools also support batch processing\&.
28
 
.PP 
29
 
\fBECACONVERT\fP
30
 
.PP 
31
 
A tool for converting a set of files to a common target format\&.
32
 
This target format is given as the first command line
33
 
argument, and its syntax is \fI\&.ext\fP\&.
34
 
.PP 
35
 
\fBECAFIXDC\fP
36
 
.PP 
37
 
A simple command-line tool for fixing DC-offset\&.
38
 
.PP 
39
 
\fBECALENGTH\fP
40
 
.PP 
41
 
See the separate ecalength(1) man page\&.
42
 
.PP 
43
 
\fBECAMONITOR\fP
44
 
.PP 
45
 
Ecamonitor is a util program that can be used 
46
 
to monitor an active ecasound session\&. Ecamonitor 
47
 
is able to show information about the current 
48
 
chainsetup such as list of inputs, outputs, 
49
 
current position, effects, the engine status 
50
 
and numerous other things\&.
51
 
.PP 
52
 
By default ecamonitor will try to connect 
53
 
to IP4 address "localhost", to port "2868"\&. 
54
 
A different address can be specified when 
55
 
starting ecamonitor, for example 
56
 
"ecamonitor foo\&.mynetwork\&.com" or
57
 
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
58
 
.PP 
59
 
To enable inbound connections, ecasound has to be 
60
 
started with the \fI--daemon\fP option\&. Ecamonitor is 
61
 
implemented in Python using the NetECI API\&.
62
 
.PP 
63
 
\fBECANORMALIZE\fP
64
 
.PP 
65
 
Ecanormalize is a command-line tool for normalizing audio
66
 
files to utilize the full available sample resolution\&. Ecanormalize
67
 
first finds out how much the input file can be amplified without 
68
 
clipping and if there is room for increase, a static gain will 
69
 
be applied to the file\&.
70
 
.PP 
71
 
\fBECAPLAY\fP
72
 
.PP 
73
 
Ecaplay is a command-line tool for playing audio files\&. Ecaplay 
74
 
uses the libecasound engine and is thus able to handle all audio formats
75
 
supported by the library\&. 
76
 
.PP 
77
 
Files can be selected for playback either by specifying the 
78
 
filenames on the command-line, or by using the playlist 
79
 
mechanism\&. In playlist mode, files can be added to the playlist
80
 
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
81
 
to play all tracks on the playlist\&. Ecaplay will repeat the
82
 
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
83
 
Playlist can be flushed with \fI-f\fP and its contents listed
84
 
with \fI-l\fP option\&.
85
 
.PP 
86
 
If not otherwise specified, ecaplay will use the audio output device 
87
 
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different 
88
 
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell 
89
 
environment variable or with the \fI-o:output_device\fP command-line
90
 
option\&.
91
 
.PP 
92
 
Playback can be stopped at any time with Ctrl-C\&. If multiple
93
 
files are played, first Ctrl-C will stop the current file and move
94
 
on to play the next one\&. Issuing Ctrl-C twice (within one second), 
95
 
will cause ecaplay to exit\&.
96
 
.PP 
97
 
.IP "-d:debuglevel"
98
 
Set libecasound debug level\&. See ecasound(1)\&.
99
 
.IP 
100
 
.IP "-f"
101
 
Flush the playlist contents\&. See also 
102
 
options \fI-l, -p and -q\fP\&.
103
 
.IP 
104
 
.IP "-h"
105
 
Print usage information and exit\&.
106
 
.IP 
107
 
.IP "-k:number"
108
 
Skip \&'number\&' of files\&.
109
 
.IP 
110
 
.IP "-l"
111
 
List the current playlist contents to stdout\&. See also 
112
 
options \fI-f, -p and -q\fP\&.
113
 
.IP 
114
 
.IP "-o:output_device"
115
 
Use \&'output_device\&' instead of the default output device 
116
 
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
117
 
as used by "-o" ecasound option (see ecasound(1) man page)\&.
118
 
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
119
 
variable (more info below)\&.
120
 
.IP 
121
 
.IP "-p"
122
 
Play tracks in the playlist (in looped mode)\&. See also 
123
 
options \fI-f, -l and -q\fP\&.
124
 
.IP 
125
 
.IP "-q"
126
 
Queue new tracks to the playlist\&. All filenames given on
127
 
the command-line will be added to the the playlist\&. It is 
128
 
possible to queue new tracks while another instance of 
129
 
ecaplay is using the playlist\&. See also options \fI-f, -l 
130
 
and -p\fP\&.
131
 
.IP 
132
 
\fBECASIGNALVIEW\fP
133
 
.PP 
134
 
Ecasignalview is meant for monitoring signal amplitude and peak 
135
 
statistics\&. It accepts the following options:
136
 
.PP 
137
 
.IP "input"
138
 
The first option not starting with a \&'-\&' is interpreted 
139
 
as an input string\&. This can be a device or a filename\&. All formats
140
 
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
141
 
.IP 
142
 
.IP "output"
143
 
Similarly to input, second option not starting with a \&'-\&'
144
 
is interpreted as output\&. Defaults to \&'null\&'\&.
145
 
.IP 
146
 
.IP "-b:buffersize"
147
 
Buffersize in sample frames\&. Defaults to 128\&.
148
 
.IP 
149
 
.IP "-c"
150
 
Enable cumulative mode\&. Counters are not reseted after refresh\&.
151
 
\fI*deprecated*\fP
152
 
.IP 
153
 
.IP "-d"
154
 
Enable debug mode\&.
155
 
.IP 
156
 
.IP "-f:format_string"
157
 
Specify default audio format\&. See ecasound(1) for details\&.
158
 
.IP 
159
 
.IP "-r:rate_msec"
160
 
Specify screen refresh rate in milliseconds\&.
161
 
.IP 
162
 
.IP "-I"
163
 
Use linear scale for showing audio sample amplitude\&.
164
 
.IP 
165
 
.IP "-L"
166
 
Use logarithmic scale for showing audio sample amplitude\&.
167
 
.IP 
168
 
.IP "-G, -B, -M*, -r, -z"
169
 
Ecasound options use to modify the engine behaviour, see 
170
 
ecasound(1) manpage for details\&.
171
 
.IP 
172
 
When ecasignalview is running, the following keyboard 
173
 
commands can be used to control the operation (requires 
174
 
system support for UNIX terminal interface control):
175
 
.PP 
176
 
.IP "spacebar"
177
 
Reset statistics (max-peak, avg-amplitude and clipped
178
 
samples count)\&.
179
 
.IP 
180
 
.IP "q or Q or Esc"
181
 
Quit ecasignalview\&.
182
 
.IP 
183
 
It is also possible to reset the max-peak and clipped-samples 
184
 
counters by sending a SIGHUP signal to the process (i\&.e\&.
185
 
from another console: "killall -v -HUP ecasignalview")\&.
186
 
.PP 
187
 
More complete documentation for ecasignalview can be found 
188
 
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound 
189
 
-> Documentation\&'\&')\&.
190
 
.PP 
191
 
.SH "ENVIRONMENT"
192
 
 
193
 
.PP 
194
 
\fIECASOUND\fP
195
 
Path to the ecasound executable\&. Used by many ecatools\&.
196
 
.PP 
197
 
\fIECAPLAY_OUTPUT_DEVICE\fP
198
 
Device ecaplay should use for audio output\&. Same syntax
199
 
as for ecaplay/ecasound "-o" option\&.
200
 
.PP 
201
 
.SH "FILES"
202
 
 
203
 
.PP 
204
 
\fI~/\&.ecasound/ecasoundrc\fP
205
 
The default ecasound resource file\&. See ecasoundrc(5)
206
 
for details\&.
207
 
.PP 
208
 
\fI~/\&.ecasound/ecaplay_queue\fP
209
 
File used to store the ecaplay playlist (one track per
210
 
line with full path)\&.
211
 
.PP 
212
 
.SH "SEE ALSO"
213
 
 
214
 
.PP 
215
 
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
216
 
.PP 
217
 
.SH "AUTHOR"
218
 
 
219
 
.PP 
220
 
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>