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

« back to all changes in this revision

Viewing changes to Documentation/ecasoundrc.5

  • 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
.TH "ecasoundrc" "5" "22\&.12\&.2004" "" "Multimedia software" 
 
2
.PP 
 
3
.SH "NAME" 
 
4
ecasoundrc \- ecasound rcfile
 
5
.PP 
 
6
.SH "SYNOPSIS" 
 
7
{prefix}/share/ecasound/ecasoundrc (for instance \'/usr/local/share/ecasound/ecasoundrc\')
 
8
$HOME/\&.ecasound/ecasoundrc
 
9
.PP 
 
10
.SH "DESCRIPTION" 
 
11
.PP 
 
12
\fBecasoundrc\fP is the main configuration file for ecasound\&. 
 
13
Any user-specific modification should be done to 
 
14
$HOME/\&.ecasound/ecasoundrc, not to the global resource file\&.
 
15
.PP 
 
16
The format is quite simple\&. One line consists of 
 
17
a configuration variable and its value\&. Variable and value 
 
18
are separated with either \'=\' or \' \'\&. Lines beginning with a
 
19
"#" are ignored (comment lines)\&. 
 
20
.PP 
 
21
.SH "VARIABLES" 
 
22
.PP 
 
23
.IP 
 
24
.IP "midi-device" 
 
25
MIDI-device\&. If the device name is given in \fIrawmidi,/dev/midi*\fP 
 
26
format, OSS/Linux or OSS/Lite drivers are used\&. 
 
27
Device \fIrawmidi,/dev/snd/midiCxDy\fP opens an ALSA raw-MIDI 
 
28
device with card number \'x\' and device number \'y\'\&. 
 
29
See ecasound(5) man page (the \'-Md option) for more info\&.
 
30
Defaults to \fIrawmidi,/dev/midi\fP\&.
 
31
.IP 
 
32
.IP "default-output" 
 
33
Output device to use by default\&. If a chainsetup with zero
 
34
outputs, but with one or more inputs, is connected, a default output
 
35
is added and all the chains are connected to it\&. If the special-case
 
36
value \'autodetect\' is specified, ecasound will try to auto-detect 
 
37
a suitable device (JACK -> ALSA -> OSS -> rtnull)\&. 
 
38
Defaults to \fIautodetect\fP\&.
 
39
.IP 
 
40
.IP "default-audio-format" 
 
41
Default values for sample format, channel count, sampling rate
 
42
and channel interleaving\&. Syntax is the same as used by
 
43
ecasound\'s \fI-f\fP option (see ecasound(1))\&. 
 
44
Defaults to \fIs16_le,2,44100,i\fP\&.
 
45
.IP 
 
46
.IP "default-to-precise-sample-rates" 
 
47
Whether to ignore sample rate differences (and possibly avoid 
 
48
resampling)\&. Currently only affects OSS-devices\&. Defaults to \fIfalse\fP\&.
 
49
.IP 
 
50
.IP "default-mix-mode" 
 
51
If \fIdefault-mix-mode\fP is \fIsum\fP, engine will mix multiple channels into
 
52
one output channel by summing all input channels\&. In mode \fIavg\fP, 
 
53
mixing is done by taking the average of all input channels\&. The
 
54
\fIavg\fP mode is safe from clipping, while \fIsum\fP is closer
 
55
to the way analog mixers work\&. Defaults to \fIavg\fP\&.
 
56
.IP 
 
57
.IP "bmode-defaults-nonrt" 
 
58
Selects the default parameters to use with buffering 
 
59
mode \'nonrt\' (other modes are \'rt\' and \'rtlowlatency)\&. 
 
60
Parameters are given as a comma-separated tuple of values:
 
61
1) buffersize (number,-b), 2) raised priority (true/false,-r), 
 
62
3) sched_priority (number,-r:X), 4) double buffering
 
63
(true/false,-z:db), 5) db-bufsize (number,-z:db,X), and
 
64
6) max intbuf (true/false,-z:intbuf)\&. Defaults to
 
65
\fI1024,false,50,false,100000,true\fP\&.
 
66
.IP 
 
67
.IP "bmode-defaults-rt" 
 
68
See \'bmode-defaults-nonrt\'\&. Defaults to 
 
69
\fI1024,true,50,true,100000,true\fP\&.
 
70
.IP 
 
71
.IP "bmode-defaults-rtlowlatency" 
 
72
See \'bmode-defaults-nonrt\'\&. Defaults to 
 
73
\fI256,true,50,true,100000,false\fP\&.
 
74
.IP 
 
75
.IP "resource-directory" 
 
76
Directory for global ecasound configuration files\&. 
 
77
Defaults to \fI{prefix-dir}/share/ecasound\fP\&.
 
78
Note! User-specific resource files can be be stored 
 
79
to \'$(HOME)/\&.ecasound/\'\&. For instance you can 
 
80
add your own presets definitions to 
 
81
\'$(HOME)/\&.ecasound/effect_presets\'\&.
 
82
.IP 
 
83
.IP "resource-file-genosc-envelopes" 
 
84
Configuration file for generic oscillators\&. Is located in the 
 
85
resource directory\&. Defaults to \fIgeneric_oscillators\fP\&.
 
86
.IP 
 
87
.IP "resource-file-effect-presets" 
 
88
Configuration file for effect presets\&. Is located in the 
 
89
resource directory\&. Defaults to \fIeffect_presets\fP\&.
 
90
.IP 
 
91
.IP "ladspa-plugin-directory" 
 
92
Directory containing LADSPA effect plugins\&. Defaults to \fI{prefix-dir}/lib/ladspa\fP\&.
 
93
If environment variable \fILADSPA_PATH\fP exists, directories
 
94
specified in it are automatically searched for plugins\&.
 
95
Note! To match the syntax of the \fILADSPA_PATH\fP environment 
 
96
variable, \'ladspa-plugin-directory\' can contain multiple
 
97
directories, separated by \':\' characters\&.
 
98
.IP 
 
99
.IP "ext-cmd-text-editor" 
 
100
If \fIext-cmd-text-editor-use-getenv\fP is \fIfalse\fP or "EDITOR" 
 
101
is null, value of this field is used\&. Defaults to \fIpico\fP\&.
 
102
.IP 
 
103
.IP "ext-cmd-text-editor-use-getenv" 
 
104
Should ecasound try to query environment variable "EDITOR"\&.
 
105
Defaults to \fItrue\fP\&.
 
106
.IP 
 
107
.IP "ext-cmd-wave-editor" 
 
108
Command line for executing an external wave editor\&. Defaults
 
109
to \fIsnd\fP\&.
 
110
.IP 
 
111
.IP "ext-cmd-mp3-input" 
 
112
Command for starting mp3 input\&. Ecasound expects that signed,
 
113
16bit, stereo audio samples are written to standard output\&.
 
114
Ecasound will query other audio format parameters by parsing 
 
115
the mp3 file header\&. Before execution, %f is replaced with
 
116
path to the input mp3\&. If exists, "%o" is replaced with he
 
117
start offset in mp3 frames\&. Double-quotes and backslash-espacing 
 
118
can be used to include white-space to individual parameters\&.
 
119
Defaults to \fImpg123 --stereo -r -b 0 -q -s -k %o %f\fP\&.
 
120
.IP 
 
121
.IP "ext-cmd-mp3-output" 
 
122
Command for starting mp3 output\&. Ecasound will write stereo, 
 
123
signed, 16bit, little-endian samples to standard output\&. Sample
 
124
rate is configurable\&. Before execution, %f is replaced with 
 
125
path to the output mp3, %S with sample rate in kHz, and 
 
126
%B with encoding bitrate in kbps\&. Double-quotes and 
 
127
backslash-espacing can be used to include white-space to 
 
128
individual parameters\&.Defaults to \fIlame -b %B -s %S -x -S - %f\fP\&.
 
129
.IP 
 
130
.IP "ext-cmd-ogg-input" 
 
131
Command for starting Ogg Vorbis input\&. Ecasound expects that audio samples
 
132
are written to standard output\&. It should be noted that
 
133
Ecasound is not able to query the audio format parameters from
 
134
ogg files, so these need to be set manually by the user\&.
 
135
Before execution, %f is replaced with path to the input ogg\&. 
 
136
Double-quotes and backslash-espacing can be used to include white-space 
 
137
to individual parameters\&. Defaults to 
 
138
\fIogg123 -d raw -o byteorder:%E --file=- %f\fP\&.
 
139
.IP 
 
140
.IP "ext-cmd-ogg-output" 
 
141
Command for starting Ogg Vorbis output\&. Ecasound will write
 
142
samples in little-endian format to standard output\&. Other 
 
143
audio parameters are configurable\&. Before execution, %f is
 
144
replaced with path to the output ogg, %c, %s and %b with matching audio
 
145
format parameters, and %B with encoding bitrate in kbps\&.
 
146
Double-quotes and backslash-espacing can be used to include white-space to 
 
147
individual parameters\&. Defaults to 
 
148
\fIoggenc -b %B --raw --raw-bits=%b --raw-chan=%c --raw-rate=%s --raw-endianness 0 --output=%f -\fP\&.
 
149
.IP 
 
150
.IP "ext-cmd-mikmod" 
 
151
Command for starting mikmod input\&. Ecasound expects that 
 
152
signed, 16bit, stereo audio samples are written to standard 
 
153
output\&. Before execution, %f is replaced with 
 
154
file path, and %s with selected sample rate\&. Double-quotes 
 
155
and backslash-espacing can be used to include white-space to 
 
156
individual parameters\&. Defaults to \fImikmod -d stdout -o 16s -q -f %s -p 0 --noloops %f\fP\&.
 
157
.IP 
 
158
.IP "ext-cmd-timidity" 
 
159
Command for starting timidity++ input\&. Ecasound expects that
 
160
signed, 16bit, stereo audio samples are written to standard
 
161
output\&. Before execution, %f is replaced with file path, and
 
162
%s with sample rate\&. Double-quotes and backslash-espacing can 
 
163
be used to include white-space to individual parameters\&.
 
164
Defaults to \fItimidity -Or1S -id -s %s -o - %f\fP\&.
 
165
.IP 
 
166
.IP "ext-cmd-flac-input" 
 
167
Command for starting FLAC input\&. Ecasound expects that audio samples
 
168
are written to standard output\&. It should be noted that
 
169
Ecasound is not able to query the audio format parameters from
 
170
FLAC files, so these need to be set manually by the user\&. 
 
171
Before execution, %f is replaced with path to the input FLAC
 
172
file\&. Double-quotes and backslash-espacing can be used to include 
 
173
white-space to individual parameters\&.Defaults to \fIflac -d -c %f\fP\&.
 
174
.IP 
 
175
.IP "ext-cmd-flac-output" 
 
176
Command for starting FLAC output\&. Ecasound will write
 
177
samples to standard output\&. All audio parameters are
 
178
configurable\&. Before execution, %f is replaced with path to
 
179
the output flac, %c, %b and %s with matching audio
 
180
format parameters, %I with either \'signed\' or \'unsigned\', and
 
181
%E with either \'little\' or \'big\'\&. Double-quotes and backslash-espacing 
 
182
can be used to include white-space to individual parameters\&. Defaults 
 
183
to \fIflac -o %f --force-raw-format --channels=%c --bps=%b --sample-rate=%s --sign=%I --endian=%E -\fP\&.
 
184
.IP 
 
185
.IP "ext-cmd-aac-input" 
 
186
Command for starting AAC input\&. Ecasound expects that signed,
 
187
16bit, stereo, big-endian audio samplesare written to standard 
 
188
output\&. It should be noted that       Ecasound is not able to query 
 
189
the input sample rate, so this needs to be set manually by the user\&. 
 
190
Before execution, %f is replaced with path to the input AAC
 
191
file\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
 
192
and backslash-espacing can be used to include white-space to 
 
193
individual parameters\&. Defaults to \fIfaad -w -b 1 -f 2 -d %f\fP\&.
 
194
.IP 
 
195
.IP "ext-cmd-aac-output" 
 
196
Command for starting AAC output\&. Ecasound will write big-endian
 
197
audio samples to standard output\&. All other audio parameters are
 
198
configurable\&. Before execution, %f is replaced with path to
 
199
the output AAC file, %c, %b and %s with matching audio format 
 
200
parameters\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
 
201
and backslash-espacing can be used to include white-space to 
 
202
individual parameters\&. Defaults to \fIfaac -P -o %f -R %s -B %b -C %c -\fP\&.
 
203
.IP 
 
204
.PP 
 
205
.SH "SEE ALSO" 
 
206
.PP 
 
207
ecasound(1), ecatools (1), ecasound-iam(1)
 
208
.PP 
 
209
.SH "AUTHOR" 
 
210
.PP 
 
211
Kai Vehmanen, <kvehmanen -at- eca -dot- cx>