Don't use deprecated macros
[openal-soft.git] / alsoftrc.sample
blob2c07209affcf11449eac5a79ef9b10606fa8358f
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. PulseAudio) 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. If the deprecated 'refresh' option is specified and
83 #  this isn't, the value will be calculated as size = refresh/periods.
84 #period_size = 1024
86 ## periods:
87 #  Sets the number of update periods. Higher values create a larger mix ahead,
88 #  which helps protect against skips when the CPU is under load, but increases
89 #  the delay between a sound getting mixed and being heard.
90 #periods = 4
92 ## sources:
93 #  Sets the maximum number of allocatable sources. Lower values may help for
94 #  systems with apps that try to play more sounds than the CPU can handle.
95 #sources = 256
97 ## stereodup:
98 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
99 #  channel output. This can make stereo sources substantially louder than mono
100 #  or even 4+ channel sources, but provides a "fuller" playback quality. True,
101 #  yes, on, and non-0 values will duplicate stereo sources. 0 and anything else
102 #  will cause stereo sounds to only play out the front speakers.
103 #stereodup = false
105 ## drivers:
106 #  Sets the backend driver list order, comma-seperated. Unknown backends and
107 #  duplicated names are ignored. Unlisted backends won't be considered for use
108 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
109 #  followed by all other available backends, while 'oss' will list OSS only).
110 #  An empty list means the default.
111 #drivers = pulse,alsa,oss,solaris,dsound,winmm,port,wave
113 ## excludefx:
114 #  Sets which effects to exclude, preventing apps from using them. This can
115 #  help for apps that try to use effects which are too CPU intensive for the
116 #  system to handle. Available effects are: eaxreverb,reverb,echo
117 #excludefx =
119 ## slots:
120 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
121 #  can use a non-negligible amount of CPU time if an effect is set on it even
122 #  if no sources are feeding it, so this may help when apps use more than the
123 #  system can handle.
124 #slots = 4
126 ## sends:
127 #  Sets the maximum number of auxiliary sends per source. The total number of
128 #  sends possible is defined at compile time and thus can not be increased
129 #  beyond the default (2).
130 #sends = 2
132 ## layout_STEREO:
133 #  Sets the speaker layout when using stereo output. Values are specified in
134 #  degrees, where 0 is straight in front, negative goes left, and positive goes
135 #  right. The values must define a circular pattern, starting with the back-
136 #  left at the most negative, around the front to back-center. Unspecified
137 #  speakers will remain at their default position. Available speakers are
138 #  front-left(fl) and front-right(fr).
139 #layout_STEREO = fl=-90, fr=90
141 ## laytout_QUAD:
142 #  Sets the speaker layout when using quadriphonic output. Available speakers
143 #  are back-left(bl), front-left(fl), front-right(fr), and back-right(br).
144 #layout_QUAD = bl=-135, fl=-45, fr=45, br=135
146 ## layout_51CHN:
147 #  Sets the speaker layout when using 5.1 output. Available speakers are back-
148 #  left(bl), front-left(fl), front-center(fc), front-right(fr), and back-
149 #  right(br).
150 #layout_51CHN = bl=-110, fl=-30, fc=0, fr=30, br=110
152 ## layout_61CHN:
153 #  Sets the speaker layout when using 6.1 output. Available speakers are side-
154 #  left(sl), front-left(fl), front-center(fc), front-right(fr), side-right(sr),
155 #  and back-center(bc).
156 #layout_61CHN = sl=-90, fl=-30, fc=0, fr=30, sr=90, bc=180
158 ## layout_71CHN:
159 #  Sets the speaker layout when using 7.1 output. Available speakers are back-
160 #  left(bl), side-left(sl), front-left(fl), front-center(fc), front-right(fr),
161 #  side-right(sr), and back-right(br).
162 #layout_71CHN = bl=-150, sl=-90, fl=-30, fc=0, fr=30, sr=90, br=150
165 ## ALSA backend stuff
167 [alsa]
169 ## device:
170 #  Sets the device name for the default playback device.
171 #device = default
173 ## capture:
174 #  Sets the device name for the default capture device.
175 #capture = default
177 ## mmap:
178 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
179 #  consumption). If mmap isn't available, it will automatically fall back to
180 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
181 #  and anything else will force mmap off.
182 #mmap = true
185 ## OSS backend stuff
187 [oss]
189 ## device:
190 #  Sets the device name for OSS output.
191 #device = /dev/dsp
193 ## capture:
194 #  Sets the device name for OSS capture.
195 #capture = /dev/dsp
198 ## Solaris backend stuff
200 [solaris]
202 ## device:
203 #  Sets the device name for Solaris output.
204 #device = /dev/audio
207 ## DirectSound backend stuff
209 [dsound]
212 ## Windows Multimedia backend stuff
214 [winmm]
217 ## PortAudio backend stuff
219 [port]
221 ## device:
222 #  Sets the device index for output. Negative values will use the default as
223 #  given by PortAudio itself.
224 #device = -1
226 ## capture:
227 #  Sets the device index for capture. Negative values will use the default as
228 #  given by PortAudio itself.
229 #capture = -1
232 ## PulseAudio backend stuff
234 [pulse]
236 ## spawn-server:
237 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
238 #  device. Note that some apps may open and probe all enumerated devices on
239 #  startup, causing a server to spawn even if a PulseAudio device is not
240 #  actually selected. Setting autospawn to false in Pulse's client.conf will
241 #  still prevent autospawning even if this is set to true.
242 #spawn-server = false
244 ## buffer-length:
245 #  Specifies the PulseAudio buffer length, in sample frames. When set to a
246 #  non-0 value, it specifies the total buffer length for the playback stream,
247 #  overriding the period settings. Otherwise it uses the period size and count
248 #  to calculate a buffer size. PulseAudio, unlike other backends, does not work
249 #  in period chunks, but instead just has one buffer block which is refilled as
250 #  it nears empty. Because of this, the usual buffering metrics are unsuitable,
251 #  with the default 4096 frames being needlessly large.
252 #buffer-length = 2048
255 ## Wave File Writer stuff
257 [wave]
259 ## file:
260 #  Sets the filename of the wave file to write to. An empty name prevents the
261 #  backend from opening, even when explicitly requested.
262 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
263 #file =