Remove an unnecessary check
[openal-soft.git] / alsoftrc.sample
blob13f5f759c1667e4334fb484a20f13aea921fefbb
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 ## head_dampen:
52 #  Sets the amount of dampening on sounds emanating from behind the listener.
53 #  This is used to simulate the natural occlusion of the head, which is
54 #  typically missing with mono and stereo output, and as such, only works on
55 #  mono and stereo output modes. Valid values range from 0 to 1 (inclusive),
56 #  and higher values provide a stronger effect.
57 #head_dampen = 0.25
59 ## frequency:
60 #  Sets the output frequency.
61 #frequency = 44100
63 ## resampler:
64 #  Selects the resampler used when mixing sources. Valid values are:
65 #  0 - None (nearest sample, no interpolation)
66 #  1 - Linear (extrapolates samples using a linear slope between samples)
67 #  2 - Cosine (extrapolates using a (co)sine slope)
68 #  Specifying other values will result in using the default (linear).
69 #resampler = 1
71 ## rt-prio:
72 #  Sets real-time priority for the mixing thread. Not all drivers may use this
73 #  (eg. PortAudio) as they already control the priority of the mixing thread.
74 #  0 and negative values will disable it. Note that this may constitute a
75 #  security risk since a real-time priority thread can indefinitely block
76 #  normal-priority threads if it fails to wait. As such, the default is
77 #  disabled.
78 #rt-prio = 0
80 ## period_size:
81 #  Sets the update period size, in frames. This is the number of frames needed
82 #  for each mixing update.
83 #period_size = 1024
85 ## periods:
86 #  Sets the number of update periods. Higher values create a larger mix ahead,
87 #  which helps protect against skips when the CPU is under load, but increases
88 #  the delay between a sound getting mixed and being heard.
89 #periods = 4
91 ## sources:
92 #  Sets the maximum number of allocatable sources. Lower values may help for
93 #  systems with apps that try to play more sounds than the CPU can handle.
94 #sources = 256
96 ## stereodup:
97 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
98 #  channel output. This can make stereo sources noticeably louder than mono or
99 #  even 4+ channel sources, but provides a "fuller" playback quality. True,
100 #  yes, on, and non-0 values will duplicate stereo sources. 0 and anything else
101 #  will cause stereo sounds to only play out the front speakers.
102 #stereodup = false
104 ## scalemix:
105 #  Sets whether to scale the remixed output. When the final mix is written to
106 #  the device, the multi-channel data is remixed so pure-virtual channels (eg.
107 #  front-center on stereo output) are remixed and added to available channels
108 #  (eg. front-left and front-right). Scaling helps ensure that no single source
109 #  will put out more than 100% on a given physical channel. This can cause a
110 #  noticeable reduction in overall volume, however, so it is off by default.
111 #scalemix = false
113 ## drivers:
114 #  Sets the backend driver list order, comma-seperated. Unknown backends and
115 #  duplicated names are ignored. Unlisted backends won't be considered for use
116 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
117 #  followed by all other available backends, while 'oss' will list OSS only).
118 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
119 #  all available backends except OSS). An empty list means the default.
120 #drivers = pulse,alsa,oss,solaris,dsound,winmm,port,null,wave
122 ## excludefx:
123 #  Sets which effects to exclude, preventing apps from using them. This can
124 #  help for apps that try to use effects which are too CPU intensive for the
125 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator
126 #excludefx =
128 ## slots:
129 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
130 #  can use a non-negligible amount of CPU time if an effect is set on it even
131 #  if no sources are feeding it, so this may help when apps use more than the
132 #  system can handle.
133 #slots = 4
135 ## sends:
136 #  Sets the maximum number of auxiliary sends per source. The total number of
137 #  sends possible is defined at compile time and thus can not be increased
138 #  beyond the default (2).
139 #sends = 2
141 ## layout:
142 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
143 #  straight in front, negative goes left, and positive goes right. Unspecified
144 #  speakers will remain at their default positions (which are dependant on the
145 #  output format). Available speakers are back-left(bl), side-left(sl), front-
146 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
147 #  and back-center(bc).
148 #layout =
151 ## ALSA backend stuff
153 [alsa]
155 ## device:
156 #  Sets the device name for the default playback device.
157 #device = default
159 ## capture:
160 #  Sets the device name for the default capture device.
161 #capture = default
163 ## mmap:
164 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
165 #  consumption). If mmap isn't available, it will automatically fall back to
166 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
167 #  and anything else will force mmap off.
168 #mmap = true
171 ## OSS backend stuff
173 [oss]
175 ## device:
176 #  Sets the device name for OSS output.
177 #device = /dev/dsp
179 ## capture:
180 #  Sets the device name for OSS capture.
181 #capture = /dev/dsp
184 ## Solaris backend stuff
186 [solaris]
188 ## device:
189 #  Sets the device name for Solaris output.
190 #device = /dev/audio
193 ## DirectSound backend stuff
195 [dsound]
198 ## Windows Multimedia backend stuff
200 [winmm]
203 ## PortAudio backend stuff
205 [port]
207 ## device:
208 #  Sets the device index for output. Negative values will use the default as
209 #  given by PortAudio itself.
210 #device = -1
212 ## capture:
213 #  Sets the device index for capture. Negative values will use the default as
214 #  given by PortAudio itself.
215 #capture = -1
218 ## PulseAudio backend stuff
220 [pulse]
222 ## spawn-server:
223 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
224 #  device. Note that some apps may open and probe all enumerated devices on
225 #  startup, causing a server to spawn even if a PulseAudio device is not
226 #  actually selected. Setting autospawn to false in Pulse's client.conf will
227 #  still prevent autospawning even if this is set to true.
228 #spawn-server = false
231 ## Wave File Writer stuff
233 [wave]
235 ## file:
236 #  Sets the filename of the wave file to write to. An empty name prevents the
237 #  backend from opening, even when explicitly requested.
238 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
239 #file =