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

« back to all changes in this revision

Viewing changes to Documentation/ecatools_manpage.yo

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2005-04-14 09:15:48 UTC
  • Revision ID: james.westby@ubuntu.com-20050414091548-o7kgb47z0tcunh0s
Tags: upstream-2.4.1
ImportĀ upstreamĀ versionĀ 2.4.1

Show diffs side-by-side

added added

removed removed

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