← Back to branch summary

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

« back to all changes in this revision

Viewing changes to Documentation/ecasoundrc_manpage.html

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2008-03-23 21:42:49 UTC
  • mfrom: (3.1.6 hardy)
  • Revision ID: james.westby@ubuntu.com-20080323214249-evlfv3y1o8q747la
Tags: 2.4.6.1-2
http://bugs.debian.org/454890
* Bug fix: "FTBFS with GCC 4.3: missing #includes", thanks to Martin
  Michlmayr (Closes: #454890).
- 13_gcc4: updated

Show diffs side-by-side

added added

removed removed

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