Avoid unnecessary ExchangeInt uses
[openal-soft.git] / alsoftrc.sample
blob53731644de6cf06b63d7c13a2e2df214874e913d
1 # OpenAL config file.
3 # Option blocks may appear multiple times, and duplicated options will take the
4 # last value specified. Environment variables may be specified within option
5 # values, and are automatically substituted when the config file is loaded.
6 # Environment variable names may only contain alpha-numeric characters (a-z,
7 # A-Z, 0-9) and underscores (_), and are prefixed with $. For example,
8 # specifying "$HOME/file.ext" would typically result in something like
9 # "/home/user/file.ext". To specify an actual "$" character, use "$$".
11 # The system-wide settings can be put in /etc/openal/alsoft.conf and user-
12 # specific override settings in $HOME/.alsoftrc.
13 # For Windows, these settings should go into $AppData\alsoft.ini
15 # Option and block names are case-insenstive. The supplied values are only
16 # hints and may not be honored (though generally it'll try to get as close as
17 # possible). Note: options that are left unset may default to app- or system-
18 # specified values. These are the current available settings:
21 ## General stuff
23 [general]
25 ## disable-cpu-exts:
26 #  Disables use of specialized methods that use specific CPU intrinsics.
27 #  Certain methods may utilize CPU extensions for improved performance, and
28 #  this option is useful for preventing some or all of those methods from being
29 #  used. The available extensions are: sse, sse2, sse4.1, and neon. Specifying
30 #  'all' disables use of all such specialized methods.
31 #disable-cpu-exts =
33 ## drivers:
34 #  Sets the backend driver list order, comma-seperated. Unknown backends and
35 #  duplicated names are ignored. Unlisted backends won't be considered for use
36 #  unless the list is ended with a comma (e.g. 'oss,' will try OSS first before
37 #  other backends, while 'oss' will try OSS only). Backends prepended with -
38 #  won't be considered for use (e.g. '-oss,' will try all available backends
39 #  except OSS). An empty list means to try all backends.
40 #drivers =
42 ## channels:
43 #  Sets the output channel configuration. If left unspecified, one will try to
44 #  be detected from the system, and defaulting to stereo. The available values
45 #  are: mono, stereo, quad, surround51, surround51rear, surround61, surround71
46 #channels =
48 ## sample-type:
49 #  Sets the output sample type. Currently, all mixing is done with 32-bit float
50 #  and converted to the output sample type as needed. Available values are:
51 #  int8    - signed 8-bit int
52 #  uint8   - unsigned 8-bit int
53 #  int16   - signed 16-bit int
54 #  uint16  - unsigned 16-bit int
55 #  int32   - signed 32-bit int
56 #  uint32  - unsigned 32-bit int
57 #  float32 - 32-bit float
58 #sample-type = float32
60 ## frequency:
61 #  Sets the output frequency. If left unspecified it will try to detect a
62 #  default from the system, otherwise it will default to 44100.
63 #frequency =
65 ## period_size:
66 #  Sets the update period size, in frames. This is the number of frames needed
67 #  for each mixing update. Acceptable values range between 64 and 8192.
68 #period_size = 1024
70 ## periods:
71 #  Sets the number of update periods. Higher values create a larger mix ahead,
72 #  which helps protect against skips when the CPU is under load, but increases
73 #  the delay between a sound getting mixed and being heard. Acceptable values
74 #  range between 2 and 16.
75 #periods = 4
77 ## stereo-mode
78 #  Specifies if stereo output is treated as being headphones or speakers. With
79 #  headphones, HRTF or crossfeed filters may be used for better audio quality.
80 #  Valid settings are auto, speakers, and headphones.
81 #stereo-mode = auto
83 ## hrtf:
84 #  Controls HRTF processing. These filters provide better spatialization of
85 #  sounds while using headphones, but do require a bit more CPU power. The
86 #  default filters will only work with 44100hz or 48000hz stereo output. While
87 #  HRTF is in use, the cf_level option is ignored. Setting this to true or
88 #  false will forcefully enable or disable HRTF, otherwise HRTF will be enabled
89 #  when using headphones.
90 #hrtf =
92 ## hrtf_tables
93 #  Specifies a comma-separated list of files containing HRTF data sets. The
94 #  format of the files are described in hrtf.txt. The filenames may contain
95 #  these markers, which will be replaced as needed:
96 #  %r - Device sampling rate
97 #  %% - Percent sign (%)
98 #  The listed files are relative to system-dependant data directories. On
99 #  Windows this is:
100 #  $AppData\openal\hrtf
101 #  And on other systems, it's (in order):
102 #  $XDG_DATA_HOME/openal/hrtf  (defaults to $HOME/.local/share/openal/hrtf)
103 #  $XDG_DATA_DIRS/openal/hrtf  (defaults to /usr/local/share/openal/hrtf and
104 #                               /usr/share/openal/hrtf)
105 #  An absolute path may also be specified, if the given file is elsewhere.
106 #hrtf_tables = default-%r.mhr
108 ## cf_level:
109 #  Sets the crossfeed level for stereo output. Valid values are:
110 #  0 - No crossfeed
111 #  1 - Low crossfeed
112 #  2 - Middle crossfeed
113 #  3 - High crossfeed (virtual speakers are closer to itself)
114 #  4 - Low easy crossfeed
115 #  5 - Middle easy crossfeed
116 #  6 - High easy crossfeed
117 #  Users of headphones may want to try various settings. Has no effect on non-
118 #  stereo modes.
119 #cf_level = 0
121 ## resampler:
122 #  Selects the resampler used when mixing sources. Valid values are:
123 #  point - nearest sample, no interpolation
124 #  linear - extrapolates samples using a linear slope between samples
125 #  cubic - extrapolates samples using a Catmull-Rom spline
126 #  Specifying other values will result in using the default (linear).
127 #resampler = linear
129 ## rt-prio:
130 #  Sets real-time priority for the mixing thread. Not all drivers may use this
131 #  (eg. PortAudio) as they already control the priority of the mixing thread.
132 #  0 and negative values will disable it. Note that this may constitute a
133 #  security risk since a real-time priority thread can indefinitely block
134 #  normal-priority threads if it fails to wait. As such, the default is
135 #  disabled.
136 #rt-prio = 0
138 ## sources:
139 #  Sets the maximum number of allocatable sources. Lower values may help for
140 #  systems with apps that try to play more sounds than the CPU can handle.
141 #sources = 256
143 ## slots:
144 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
145 #  can use a non-negligible amount of CPU time if an effect is set on it even
146 #  if no sources are feeding it, so this may help when apps use more than the
147 #  system can handle.
148 #slots = 4
150 ## sends:
151 #  Sets the number of auxiliary sends per source. When not specified (default),
152 #  it allows the app to request how many it wants. The maximum value currently
153 #  possible is 4.
154 #sends =
156 ## excludefx:
157 #  Sets which effects to exclude, preventing apps from using them. This can
158 #  help for apps that try to use effects which are too CPU intensive for the
159 #  system to handle. Available effects are: eaxreverb,reverb,autowah,chorus,
160 #  compressor,distortion,echo,equalizer,flanger,modulator,dedicated
161 #excludefx =
163 ## default-reverb:
164 #  A reverb preset that applies by default to all sources on send 0
165 #  (applications that set their own slots on send 0 will override this).
166 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
167 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
168 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
169 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
170 #default-reverb =
172 ## trap-alc-error:
173 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
174 #  that support it. This helps when debugging, while trying to find the cause
175 #  of a device error. On Windows, a breakpoint exception is generated.
176 #trap-alc-error = false
178 ## trap-al-error:
179 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
180 #  that support it. This helps when debugging, while trying to find the cause
181 #  of a context error. On Windows, a breakpoint exception is generated.
182 #trap-al-error = false
185 ## MIDI stuff (EXPERIMENTAL)
187 [midi]
189 ## soundfont:
190 #  A default soundfont (sf2 format). Used when an app requests the system
191 #  default. The listed file is relative to system-dependant data directories.
192 #  On Windows this is:
193 #  $AppData\openal\soundfonts
194 #  And on other systems, it's (in order):
195 #  $XDG_DATA_HOME/openal/soundfonts
196 #  $XDG_DATA_DIRS/openal/soundfonts
197 #  An absolute path may also be specified, if the given file is elsewhere.
198 #soundfont =
200 ## volume:
201 #  Additional attenuation applied to MIDI output, expressed in decibels. This
202 #  is used to help keep the mix from clipping, and so must be 0 or less. The
203 #  value is logarithmic, so -6 will be about half amplitude, and -12 about
204 #  1/4th. The default is roughly -13.9794 (0.2, or 1/5th).
205 #volume =
208 ## Reverb effect stuff (includes EAX reverb)
210 [reverb]
212 ## boost:
213 #  A global amplification for reverb output, expressed in decibels. The value
214 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
215 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
216 #  value of 0 means no change.
217 #boost = 0
219 ## emulate-eax:
220 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
221 #  reverb processing is a bit more CPU intensive than standard, so this option
222 #  allows a simpler effect to be used at the loss of some quality.
223 #emulate-eax = false
226 ## PulseAudio backend stuff
228 [pulse]
230 ## spawn-server:
231 #  Attempts to autospawn a PulseAudio server whenever needed (initializing the
232 #  backend, enumerating devices, etc). Setting autospawn to false in Pulse's
233 #  client.conf will still prevent autospawning even if this is set to true.
234 #spawn-server = true
236 ## allow-moves:
237 #  Allows PulseAudio to move active streams to different devices. Note that the
238 #  device specifier (seen by applications) will not be updated when this
239 #  occurs, and neither will the AL device configuration (sample rate, format,
240 #  etc).
241 #allow-moves = false
244 ## ALSA backend stuff
246 [alsa]
248 ## device:
249 #  Sets the device name for the default playback device.
250 #device = default
252 ## device-prefix:
253 #  Sets the prefix used by the discovered (non-default) playback devices. This
254 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
255 #  device index for the requested device name.
256 #device-prefix = plughw:
258 ## device-prefix-*:
259 #  Card- and device-specific prefixes may be used to override the device-prefix
260 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
261 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
262 #  case-sensitive.
263 #device-prefix- =
265 ## capture:
266 #  Sets the device name for the default capture device.
267 #capture = default
269 ## capture-prefix:
270 #  Sets the prefix used by the discovered (non-default) capture devices. This
271 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
272 #  device number for the requested device name.
273 #capture-prefix = plughw:
275 ## capture-prefix-*:
276 #  Card- and device-specific prefixes may be used to override the
277 #  capture-prefix option. The option may specify the card id (eg,
278 #  capture-prefix-NVidia), or the card id and device index (eg,
279 #  capture-prefix-NVidia-0). The card id is case-sensitive.
280 #capture-prefix- =
282 ## mmap:
283 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
284 #  consumption). If mmap isn't available, it will automatically fall back to
285 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
286 #  and anything else will force mmap off.
287 #mmap = true
290 ## OSS backend stuff
292 [oss]
294 ## device:
295 #  Sets the device name for OSS output.
296 #device = /dev/dsp
298 ## capture:
299 #  Sets the device name for OSS capture.
300 #capture = /dev/dsp
303 ## Solaris backend stuff
305 [solaris]
307 ## device:
308 #  Sets the device name for Solaris output.
309 #device = /dev/audio
312 ## QSA backend stuff
314 [qsa]
317 ## JACK backend stuff
319 [jack]
321 ## spawn-server:
322 #  Attempts to autospawn a JACK server whenever needed (initializing the
323 #  backend, opening devices, etc).
324 #spawn-server = true
326 ## buffer-size:
327 #  Sets the update buffer size, in samples, that the backend will keep buffered
328 #  to handle the server's real-time processing requests. This value must be a
329 #  power of 2, or else it will be rounded up to the next power of 2. If it is
330 #  less than JACK's buffer update size, it will be clamped. This option may
331 #  be useful in case the server's update size is too small and doesn't give the
332 #  mixer time to keep enough audio available for the processing requests.
333 #buffer-size = 0
336 ## MMDevApi backend stuff
338 [mmdevapi]
341 ## DirectSound backend stuff
343 [dsound]
346 ## Windows Multimedia backend stuff
348 [winmm]
351 ## PortAudio backend stuff
353 [port]
355 ## device:
356 #  Sets the device index for output. Negative values will use the default as
357 #  given by PortAudio itself.
358 #device = -1
360 ## capture:
361 #  Sets the device index for capture. Negative values will use the default as
362 #  given by PortAudio itself.
363 #capture = -1
366 ## Wave File Writer stuff
368 [wave]
370 ## file:
371 #  Sets the filename of the wave file to write to. An empty name prevents the
372 #  backend from opening, even when explicitly requested.
373 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
374 #file =