Mix the proper size for every update, and notify disconnects
[openal-soft.git] / alsoftrc.sample
blob45d5ba07f1accba507fc8259cdbd73d36cdfbabb
1 # OpenAL config file. Options that are not under a block or are under the
2 # [general] block are for general, non-backend-specific options. Blocks may
3 # appear multiple times, and duplicated options will take the last value
4 # specified.
5 # The system-wide settings can be put in /etc/openal/alsoft.conf and user-
6 # specific override settings in ~/.alsoftrc.
7 # For Windows, these settings should go into %AppData%\alsoft.ini
8 # The environment variable ALSOFT_CONF can be used to specify another config
9 # override
11 # Option and block names are case-insenstive. The supplied values are only
12 # hints and may not be honored (though generally it'll try to get as close as
13 # possible). Note: options that are left unset may default to app- or system-
14 # specified values. These are the current available settings:
16 ## format:
17 #  Sets the output format. Can be one of:
18 #  AL_FORMAT_MONO8    (8-bit mono)
19 #  AL_FORMAT_STEREO8  (8-bit stereo)
20 #  AL_FORMAT_QUAD8    (8-bit 4-channel)
21 #  AL_FORMAT_51CHN8   (8-bit 5.1 output)
22 #  AL_FORMAT_61CHN8   (8-bit 6.1 output)
23 #  AL_FORMAT_71CHN8   (8-bit 7.1 output)
24 #  AL_FORMAT_MONO16   (16-bit mono)
25 #  AL_FORMAT_STEREO16 (16-bit stereo)
26 #  AL_FORMAT_QUAD16   (16-bit 4-channel)
27 #  AL_FORMAT_51CHN16  (16-bit 5.1 output)
28 #  AL_FORMAT_61CHN16  (16-bit 6.1 output)
29 #  AL_FORMAT_71CHN16  (16-bit 7.1 output)
30 #  AL_FORMAT_MONO32   (32-bit float mono)
31 #  AL_FORMAT_STEREO32 (32-bit float stereo)
32 #  AL_FORMAT_QUAD32   (32-bit float 4-channel)
33 #  AL_FORMAT_51CHN32  (32-bit float 5.1 output)
34 #  AL_FORMAT_61CHN32  (32-bit float 6.1 output)
35 #  AL_FORMAT_71CHN32  (32-bit float 7.1 output)
36 #format = AL_FORMAT_STEREO16
38 ## cf_level:
39 #  Sets the crossfeed level for stereo output. Valid values are:
40 #  0 - No crossfeed
41 #  1 - Low crossfeed
42 #  2 - Middle crossfeed
43 #  3 - High crossfeed (virtual speakers are closer to itself)
44 #  4 - Low easy crossfeed
45 #  5 - Middle easy crossfeed
46 #  6 - High easy crossfeed
47 #  Users of headphones may want to try various settings. Has no effect on non-
48 #  stereo modes.
49 #cf_level = 0
51 ## frequency:
52 #  Sets the output frequency.
53 #frequency = 44100
55 ## refresh:
56 #  Sets the buffer size, in frames. Note that the actual granularity may or may
57 #  not be less than this.
58 #refresh = 4096
60 ## sources:
61 #  Sets the maximum number of allocatable sources. Lower values may help for
62 #  systems with apps that try to play more sounds than the CPU can handle.
63 #sources = 256
65 ## stereodup:
66 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
67 #  channel output. This can make stereo sources substantially louder than mono
68 #  or even 4+ channel sources, but provides a "fuller" playback quality. True,
69 #  yes, on, and non-0 values will duplicate stereo sources. 0 and anything else
70 #  will cause stereo sounds to only play out the front speakers.
71 #stereodup = false
73 ## drivers:
74 #  Sets the backend driver list order, comma-seperated. Unknown backends and
75 #  duplicated names are ignored, and unlisted backends won't be considered for
76 #  use. An empty list means the default.
77 #drivers = alsa,oss,solaris,dsound,winmm,port,pulse,wave
79 ## excludefx:
80 #  Sets which effects to exclude, preventing apps from using them. This can
81 #  help for apps that try to use effects which are too CPU intensive for the
82 #  system to handle. Available effects are: eaxreverb,reverb,echo
83 #excludefx =
85 ## slots:
86 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
87 #  can use a non-negligible amount of CPU time if an effect is set on it even
88 #  if no sources are feeding it, so this may help when apps use more than the
89 #  system can handle.
90 #slots = 4
92 ## sends:
93 #  Sets the maximum number of auxiliary sends per source. The total number of
94 #  sends possible is defined at compile time and thus can not be increased
95 #  beyond the default (2).
96 #sends = 2
98 ## layout_STEREO:
99 #  Sets the speaker layout when using stereo output. Values are specified in
100 #  degrees, where 0 is straight in front, negative goes left, and positive goes
101 #  right. The values must define a circular pattern, starting with the back-
102 #  left at the most negative, around the front to back-center. Unspecified
103 #  speakers will remain at their default position. Available speakers are
104 #  front-left(fl) and front-right(fr).
105 #layout_STEREO = fl=-90, fr=90
107 ## laytout_QUAD:
108 #  Sets the speaker layout when using quadriphonic output. Available speakers
109 #  are back-left(bl), front-left(fl), front-right(fr), and back-right(br).
110 #layout_QUAD = bl=-135, fl=-45, fr=45, br=135
112 ## layout_51CHN:
113 #  Sets the speaker layout when using 5.1 output. Available speakers are back-
114 #  left(bl), front-left(fl), front-center(fc), front-right(fr), and back-
115 #  right(br).
116 #layout_51CHN = bl=-110, fl=-30, fc=0, fr=30, br=110
118 ## layout_61CHN:
119 #  Sets the speaker layout when using 6.1 output. Available speakers are side-
120 #  left(sl), front-left(fl), front-center(fc), front-right(fr), side-right(sr),
121 #  and back-center(bc).
122 #layout_61CHN = sl=-90, fl=-30, fc=0, fr=30, sr=90, bc=180
124 ## layout_71CHN:
125 #  Sets the speaker layout when using 7.1 output. Available speakers are back-
126 #  left(bl), side-left(sl), front-left(fl), front-center(fc), front-right(fr),
127 #  side-right(sr), and back-right(br).
128 #layout_71CHN = bl=-150, sl=-90, fl=-30, fc=0, fr=30, sr=90, br=150
131 ## ALSA backend stuff
133 [alsa]
135 ## device:
136 #  Sets the device name for the default playback device.
137 #device = default
139 ## periods:
140 #  Sets the number of update buffers for playback. A value of 0 means auto-
141 #  select.
142 #periods = 0
144 ## capture:
145 #  Sets the device name for the default capture device.
146 #capture = default
148 ## mmap:
149 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
150 #  consumption). If mmap isn't available, it will automatically fall back to
151 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
152 #  and anything else will force mmap off.
153 #mmap = true
156 ## OSS backend stuff
158 [oss]
160 ## device:
161 #  Sets the device name for OSS output.
162 #device = /dev/dsp
164 ## periods:
165 #  Sets the number of update buffers.
166 #periods = 4
168 ## capture:
169 #  Sets the device name for OSS capture.
170 #capture = /dev/dsp
173 ## Solaris backend stuff
175 [solaris]
177 ## device:
178 #  Sets the device name for Solaris output.
179 #device = /dev/audio
181 ## DirectSound backend stuff
182 [dsound]
184 ## periods:
185 #  Sets the number of updates for the output buffer.
186 #periods = 4
189 ## Windows Multimedia backend stuff
191 [winmm]
194 ## PortAudio backend stuff
196 [port]
198 ## device:
199 #  Sets the device index for output. Negative values will use the default as
200 #  given by PortAudio itself.
201 #device = -1
203 ## periods:
204 #  Sets the number of update buffers.
205 #periods = 4
208 ## PulseAudio backend stuff
210 [pulse]
213 ## Wave File Writer stuff
215 [wave]
217 ## file:
218 #  Sets the filename of the wave file to write to. An empty name prevents the
219 #  backend from opening, even when explicitly requested.
220 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
221 #file =