Properly fall back to non-mmap capture if the parameters fail
[openal-soft.git] / alsoftrc.sample
blobe13ff8146d9d37988649c38b4d8d8607e186234d
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). These are the current available settings:
15 ## format:
16 #  Sets the output format. Can be one of:
17 #  AL_FORMAT_MONO8    (8-bit mono)
18 #  AL_FORMAT_STEREO8  (8-bit stereo)
19 #  AL_FORMAT_QUAD8    (8-bit 4-channel)
20 #  AL_FORMAT_51CHN8   (8-bit 5.1 output)
21 #  AL_FORMAT_61CHN8   (8-bit 6.1 output)
22 #  AL_FORMAT_71CHN8   (8-bit 7.1 output)
23 #  AL_FORMAT_MONO16   (16-bit mono)
24 #  AL_FORMAT_STEREO16 (16-bit stereo)
25 #  AL_FORMAT_QUAD16   (16-bit 4-channel)
26 #  AL_FORMAT_51CHN16  (16-bit 5.1 output)
27 #  AL_FORMAT_61CHN16  (16-bit 6.1 output)
28 #  AL_FORMAT_71CHN16  (16-bit 7.1 output)
29 #format = AL_FORMAT_STEREO16
31 ## cf_level:
32 #  Sets the crossfeed level for stereo output. Valid values are:
33 #  0 - No crossfeed
34 #  1 - Low crossfeed
35 #  2 - Middle crossfeed
36 #  3 - High crossfeed (virtual speakers are closer to itself)
37 #  4 - Low easy crossfeed
38 #  5 - Middle easy crossfeed
39 #  6 - High easy crossfeed
40 #  Users of headphones may want to try various settings. Has no effect on non-
41 #  stereo modes.
42 #cf_level = 0
44 ## frequency:
45 #  Sets the output frequency.
46 #frequency = 44100
48 ## refresh:
49 #  Sets the buffer size, in frames. Note that the actual granularity may or may
50 #  not be less than this.
51 #refresh = 4096
53 ## sources:
54 #  Sets the maximum number of allocatable sources. Lower values may help for
55 #  systems with apps that try to play more sounds than the CPU can handle.
56 #sources = 256
58 ## stereodup:
59 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
60 #  channel output. This can make stereo sources substantially louder than mono
61 #  or even 4+ channel sources, but provides a "fuller" playback quality. True,
62 #  yes, on, and non-0 values will duplicate stereo sources. 0 and anything else
63 #  will cause stereo sounds to only play out the front speakers.
64 #stereodup = false
66 ## drivers:
67 #  Sets the backend driver list order, comma-seperated. Unknown backends and
68 #  duplicated names are ignored, and unlisted backends won't be considered for
69 #  use. An empty list means the default.
70 #drivers = alsa,oss,solaris,dsound,winmm,port,pulse,wave
72 ## excludefx:
73 #  Sets which effects to exclude, preventing apps from using them. This can
74 #  help for apps that try to use effects which are too CPU intensive for the
75 #  system to handle. Available effects are: reverb,echo
76 #excludefx =
78 ## slots:
79 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
80 #  can use a non-negligible amount of CPU time if an effect is set on it even
81 #  if no sources are feeding it, so this may help when apps use more than the
82 #  system can handle.
83 #slots = 4
85 ## sends:
86 #  Sets the maximum number of auxiliary sends per source. The total number of
87 #  sends possible is defined at compile time and thus can not be increased
88 #  beyond the default (2).
89 #sends = 2
91 ## layout_STEREO:
92 #  Sets the speaker layout when using stereo output. Values are specified in
93 #  degrees, where 0 is straight in front, negative goes left, and positive goes
94 #  right. The values must define a circular pattern, starting with the back-
95 #  left at the most negative, around the front to back-center. Unspecified
96 #  speakers will remain at their default position. Available speakers are
97 #  front-left(fl) and front-right(fr).
98 #layout_STEREO = fl=-90, fr=90
100 ## laytout_QUAD:
101 #  Sets the speaker layout when using quadriphonic output. Available speakers
102 #  are back-left(bl), front-left(fl), front-right(fr), and back-right(br).
103 #layout_QUAD = bl=-135, fl=-45, fr=45, br=135
105 ## layout_51CHN:
106 #  Sets the speaker layout when using 5.1 output. Available speakers are back-
107 #  left(bl), front-left(fl), front-center(fc), front-right(fr), and back-
108 #  right(br).
109 #layout_51CHN = bl=-110, fl=-30, fc=0, fr=30, br=110
111 ## layout_61CHN:
112 #  Sets the speaker layout when using 6.1 output. Available speakers are side-
113 #  left(sl), front-left(fl), front-center(fc), front-right(fr), side-right(sr),
114 #  and back-center(bc).
115 #layout_61CHN = sl=-90, fl=-30, fc=0, fr=30, sr=90, bc=180
117 ## layout_71CHN:
118 #  Sets the speaker layout when using 7.1 output. Available speakers are back-
119 #  left(bl), side-left(sl), front-left(fl), front-center(fc), front-right(fr),
120 #  side-right(sr), and back-right(br).
121 #layout_71CHN = bl=-150, sl=-90, fl=-30, fc=0, fr=30, sr=90, br=150
124 ## ALSA backend stuff
126 [alsa]
128 ## device:
129 #  Sets the device name for the default playback device.
130 #device = default
132 ## periods:
133 #  Sets the number of update buffers for playback. A value of 0 means auto-
134 #  select.
135 #periods = 0
137 ## capture:
138 #  Sets the device name for the default capture device.
139 #capture = default
141 ## mmap:
142 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
143 #  consumption). If mmap isn't available, it will automatically fall back to
144 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
145 #  and anything else will force mmap off.
146 #mmap = true
149 ## OSS backend stuff
151 [oss]
153 ## device:
154 #  Sets the device name for OSS output.
155 #device = /dev/dsp
157 ## periods:
158 #  Sets the number of update buffers.
159 #periods = 4
161 ## capture:
162 #  Sets the device name for OSS capture.
163 #capture = /dev/dsp
166 ## Solaris backend stuff
168 [solaris]
170 ## device:
171 #  Sets the device name for Solaris output.
172 #device = /dev/audio
174 ## DirectSound backend stuff
175 [dsound]
177 ## periods:
178 #  Sets the number of updates for the output buffer.
179 #periods = 4
182 ## Windows Multimedia backend stuff
184 [winmm]
187 ## PortAudio backend stuff
189 [port]
191 ## device:
192 #  Sets the device index for output. Negative values will use the default as
193 #  given by PortAudio itself.
194 #device = -1
196 ## periods:
197 #  Sets the number of update buffers.
198 #periods = 4
201 ## PulseAudio backend stuff
203 [pulse]
206 ## Wave File Writer stuff
208 [wave]
210 ## file:
211 #  Sets the filename of the wave file to write to. An empty name prevents the
212 #  backend from opening, even when explicitly requested.
213 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
214 #file =