Handle libossaudio as an optional OSS library
[openal-soft.git] / alsoftrc.sample
blob41c884ad29cf8501f434d85ac6f1c402f551134e
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 # Device-specific values may be specified by including the device name in the
12 # block name, with "general" replaced by the device name. That is, general
13 # options for the device "Name of Device" would be in the [Name of Device]
14 # block, while ALSA options would be in the [alsa/Name of Device] block.
15 # Options marked as "(global)" are not influenced by the device.
17 # The system-wide settings can be put in /etc/openal/alsoft.conf and user-
18 # specific override settings in $HOME/.alsoftrc.
19 # For Windows, these settings should go into $AppData\alsoft.ini
21 # Option and block names are case-senstive. The supplied values are only hints
22 # and may not be honored (though generally it'll try to get as close as
23 # possible). Note: options that are left unset may default to app- or system-
24 # specified values. These are the current available settings:
27 ## General stuff
29 [general]
31 ## disable-cpu-exts: (global)
32 #  Disables use of specialized methods that use specific CPU intrinsics.
33 #  Certain methods may utilize CPU extensions for improved performance, and
34 #  this option is useful for preventing some or all of those methods from being
35 #  used. The available extensions are: sse, sse2, sse3, sse4.1, and neon.
36 #  Specifying 'all' disables use of all such specialized methods.
37 #disable-cpu-exts =
39 ## drivers: (global)
40 #  Sets the backend driver list order, comma-seperated. Unknown backends and
41 #  duplicated names are ignored. Unlisted backends won't be considered for use
42 #  unless the list is ended with a comma (e.g. 'oss,' will try OSS first before
43 #  other backends, while 'oss' will try OSS only). Backends prepended with -
44 #  won't be considered for use (e.g. '-oss,' will try all available backends
45 #  except OSS). An empty list means to try all backends.
46 #drivers =
48 ## channels:
49 #  Sets the output channel configuration. If left unspecified, one will try to
50 #  be detected from the system, and defaulting to stereo. The available values
51 #  are: mono, stereo, quad, surround51, surround51rear, surround61, surround71,
52 #  ambi1, ambi2, ambi3. Note that the ambi* configurations provide ambisonic
53 #  channels of the given order (using ACN ordering and SN3D normalization by
54 #  default), which need to be decoded to play correctly on speakers.
55 #channels =
57 ## sample-type:
58 #  Sets the output sample type. Currently, all mixing is done with 32-bit float
59 #  and converted to the output sample type as needed. Available values are:
60 #  int8    - signed 8-bit int
61 #  uint8   - unsigned 8-bit int
62 #  int16   - signed 16-bit int
63 #  uint16  - unsigned 16-bit int
64 #  int32   - signed 32-bit int
65 #  uint32  - unsigned 32-bit int
66 #  float32 - 32-bit float
67 #sample-type = float32
69 ## frequency:
70 #  Sets the output frequency. If left unspecified it will try to detect a
71 #  default from the system, otherwise it will default to 44100.
72 #frequency =
74 ## period_size:
75 #  Sets the update period size, in frames. This is the number of frames needed
76 #  for each mixing update. Acceptable values range between 64 and 8192.
77 #period_size = 1024
79 ## periods:
80 #  Sets the number of update periods. Higher values create a larger mix ahead,
81 #  which helps protect against skips when the CPU is under load, but increases
82 #  the delay between a sound getting mixed and being heard. Acceptable values
83 #  range between 2 and 16.
84 #periods = 3
86 ## stereo-mode:
87 #  Specifies if stereo output is treated as being headphones or speakers. With
88 #  headphones, HRTF or crossfeed filters may be used for better audio quality.
89 #  Valid settings are auto, speakers, and headphones.
90 #stereo-mode = auto
92 ## stereo-encoding:
93 #  Specifies the encoding method for non-HRTF stereo output. 'panpot' (default)
94 #  uses standard amplitude panning (aka pair-wise, stereo pair, etc) between
95 #  -30 and +30 degrees, while 'uhj' creates stereo-compatible two-channel UHJ
96 #  output, which encodes some surround sound information into stereo output
97 #  that can be decoded with a surround sound receiver. If crossfeed filters are
98 #  used, UHJ is disabled.
99 #stereo-encoding = panpot
101 ## ambi-format:
102 #  Specifies the channel order and normalization for the "ambi*" set of channel
103 #  configurations. Valid settings are: fuma, acn+sn3d, acn+n3d
104 #ambi-format = acn+sn3d
106 ## hrtf:
107 #  Controls HRTF processing. These filters provide better spatialization of
108 #  sounds while using headphones, but do require a bit more CPU power. The
109 #  default filters will only work with 44100hz or 48000hz stereo output. While
110 #  HRTF is used, the cf_level option is ignored. Setting this to auto (default)
111 #  will allow HRTF to be used when headphones are detected or the app requests
112 #  it, while setting true or false will forcefully enable or disable HRTF
113 #  respectively.
114 #hrtf = auto
116 ## default-hrtf:
117 #  Specifies the default HRTF to use. When multiple HRTFs are available, this
118 #  determines the preferred one to use if none are specifically requested. Note
119 #  that this is the enumerated HRTF name, not necessarily the filename.
120 #default-hrtf =
122 ## hrtf-paths:
123 #  Specifies a comma-separated list of paths containing HRTF data sets. The
124 #  format of the files are described in docs/hrtf.txt. The files within the
125 #  directories must have the .mhr file extension to be recognized. By default,
126 #  OS-dependent data paths will be used. They will also be used if the list
127 #  ends with a comma. On Windows this is:
128 #  $AppData\openal\hrtf
129 #  And on other systems, it's (in order):
130 #  $XDG_DATA_HOME/openal/hrtf  (defaults to $HOME/.local/share/openal/hrtf)
131 #  $XDG_DATA_DIRS/openal/hrtf  (defaults to /usr/local/share/openal/hrtf and
132 #                               /usr/share/openal/hrtf)
133 #hrtf-paths =
135 ## cf_level:
136 #  Sets the crossfeed level for stereo output. Valid values are:
137 #  0 - No crossfeed
138 #  1 - Low crossfeed
139 #  2 - Middle crossfeed
140 #  3 - High crossfeed (virtual speakers are closer to itself)
141 #  4 - Low easy crossfeed
142 #  5 - Middle easy crossfeed
143 #  6 - High easy crossfeed
144 #  Users of headphones may want to try various settings. Has no effect on non-
145 #  stereo modes.
146 #cf_level = 0
148 ## resampler: (global)
149 #  Selects the resampler used when mixing sources. Valid values are:
150 #  point - nearest sample, no interpolation
151 #  linear - extrapolates samples using a linear slope between samples
152 #  sinc4 - extrapolates samples using a 4-point Sinc filter
153 #  bsinc12 - extrapolates samples using a band-limited Sinc filter (varying
154 #            between 12 and 24 points, with anti-aliasing)
155 #  bsinc24 - extrapolates samples using a band-limited Sinc filter (varying
156 #            between 24 and 48 points, with anti-aliasing)
157 #resampler = linear
159 ## rt-prio: (global)
160 #  Sets real-time priority for the mixing thread. Not all drivers may use this
161 #  (eg. PortAudio) as they already control the priority of the mixing thread.
162 #  0 and negative values will disable it. Note that this may constitute a
163 #  security risk since a real-time priority thread can indefinitely block
164 #  normal-priority threads if it fails to wait. As such, the default is
165 #  disabled.
166 #rt-prio = 0
168 ## sources:
169 #  Sets the maximum number of allocatable sources. Lower values may help for
170 #  systems with apps that try to play more sounds than the CPU can handle.
171 #sources = 256
173 ## slots:
174 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
175 #  can use a non-negligible amount of CPU time if an effect is set on it even
176 #  if no sources are feeding it, so this may help when apps use more than the
177 #  system can handle.
178 #slots = 64
180 ## sends:
181 #  Limits the number of auxiliary sends allowed per source. Setting this higher
182 #  than the default has no effect.
183 #sends = 16
185 ## front-stablizer:
186 #  Applies filters to "stablize" front sound imaging. A psychoacoustic method
187 #  is used to generate a front-center channel signal from the front-left and
188 #  front-right channels, improving the front response by reducing the combing
189 #  artifacts and phase errors. Consequently, it will only work with channel
190 #  configurations that include front-left, front-right, and front-center.
191 #front-stablizer = false
193 ## output-limiter:
194 #  Applies a gain limiter on the final mixed output. This reduces the volume
195 #  when the output samples would otherwise clamp, avoiding excessive clipping
196 #  noise.
197 #output-limiter = true
199 ## dither:
200 #  Applies dithering on the final mix, for 8- and 16-bit output by default.
201 #  This replaces the distortion created by nearest-value quantization with low-
202 #  level whitenoise.
203 #dither = true
205 ## dither-depth:
206 #  Quantization bit-depth for dithered output. A value of 0 (or less) will
207 #  match the output sample depth. For int32, uint32, and float32 output, 0 will
208 #  disable dithering because they're at or beyond the rendered precision. The
209 #  maximum dither depth is 24.
210 #dither-depth = 0
212 ## volume-adjust:
213 #  A global volume adjustment for source output, expressed in decibels. The
214 #  value is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will
215 #  be a scale of 4x, etc. Similarly, -6 will be x1/2, and -12 is about x1/4. A
216 #  value of 0 means no change.
217 #volume-adjust = 0
219 ## excludefx: (global)
220 #  Sets which effects to exclude, preventing apps from using them. This can
221 #  help for apps that try to use effects which are too CPU intensive for the
222 #  system to handle. Available effects are: eaxreverb,reverb,chorus,compressor,
223 #  distortion,echo,equalizer,flanger,modulator,dedicated
224 #excludefx =
226 ## default-reverb: (global)
227 #  A reverb preset that applies by default to all sources on send 0
228 #  (applications that set their own slots on send 0 will override this).
229 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
230 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
231 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
232 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
233 #default-reverb =
235 ## trap-alc-error: (global)
236 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
237 #  that support it. This helps when debugging, while trying to find the cause
238 #  of a device error. On Windows, a breakpoint exception is generated.
239 #trap-alc-error = false
241 ## trap-al-error: (global)
242 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
243 #  that support it. This helps when debugging, while trying to find the cause
244 #  of a context error. On Windows, a breakpoint exception is generated.
245 #trap-al-error = false
248 ## Ambisonic decoder stuff
250 [decoder]
252 ## hq-mode:
253 #  Enables a high-quality ambisonic decoder. This mode is capable of frequency-
254 #  dependent processing, creating a better reproduction of 3D sound rendering
255 #  over surround sound speakers. Enabling this also requires specifying decoder
256 #  configuration files for the appropriate speaker configuration you intend to
257 #  use (see the quad, surround51, etc options below). Currently, up to third-
258 #  order decoding is supported.
259 hq-mode = false
261 ## distance-comp:
262 #  Enables compensation for the speakers' relative distances to the listener.
263 #  This applies the necessary delays and attenuation to make the speakers
264 #  behave as though they are all equidistant, which is important for proper
265 #  playback of 3D sound rendering. Requires the proper distances to be
266 #  specified in the decoder configuration file.
267 distance-comp = true
269 ## nfc:
270 #  Enables near-field control filters. This simulates and compensates for low-
271 #  frequency effects caused by the curvature of nearby sound-waves, which
272 #  creates a more realistic perception of sound distance. Note that the effect
273 #  may be stronger or weaker than intended if the application doesn't use or
274 #  specify an appropriate unit scale, or if incorrect speaker distances are set
275 #  in the decoder configuration file. Requires hq-mode to be enabled.
276 nfc = true
278 ## nfc-ref-delay
279 #  Specifies the reference delay value for ambisonic output. When channels is
280 #  set to one of the ambi* formats, this option enables NFC-HOA output with the
281 #  specified Reference Delay parameter. The specified value can then be shared
282 #  with an appropriate NFC-HOA decoder to reproduce correct near-field effects.
283 #  Keep in mind that despite being designed for higher-order ambisonics, this
284 #  applies to first-order output all the same. When left unset, normal output
285 #  is created with no near-field simulation.
286 nfc-ref-delay =
288 ## quad:
289 #  Decoder configuration file for Quadrophonic channel output. See
290 #  docs/ambdec.txt for a description of the file format.
291 quad =
293 ## surround51:
294 #  Decoder configuration file for 5.1 Surround (Side and Rear) channel output.
295 #  See docs/ambdec.txt for a description of the file format.
296 surround51 =
298 ## surround61:
299 #  Decoder configuration file for 6.1 Surround channel output. See
300 #  docs/ambdec.txt for a description of the file format.
301 surround61 =
303 ## surround71:
304 #  Decoder configuration file for 7.1 Surround channel output. See
305 #  docs/ambdec.txt for a description of the file format. Note: This can be used
306 #  to enable 3D7.1 with the appropriate configuration and speaker placement,
307 #  see docs/3D7.1.txt.
308 surround71 =
311 ## Reverb effect stuff (includes EAX reverb)
313 [reverb]
315 ## boost: (global)
316 #  A global amplification for reverb output, expressed in decibels. The value
317 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
318 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
319 #  value of 0 means no change.
320 #boost = 0
322 ## emulate-eax: (global)
323 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
324 #  reverb processing is a bit more CPU intensive than standard, so this option
325 #  allows a simpler effect to be used at the loss of some quality.
326 #emulate-eax = false
329 ## PulseAudio backend stuff
331 [pulse]
333 ## spawn-server: (global)
334 #  Attempts to autospawn a PulseAudio server whenever needed (initializing the
335 #  backend, enumerating devices, etc). Setting autospawn to false in Pulse's
336 #  client.conf will still prevent autospawning even if this is set to true.
337 #spawn-server = true
339 ## allow-moves: (global)
340 #  Allows PulseAudio to move active streams to different devices. Note that the
341 #  device specifier (seen by applications) will not be updated when this
342 #  occurs, and neither will the AL device configuration (sample rate, format,
343 #  etc).
344 #allow-moves = false
346 ## fix-rate:
347 #  Specifies whether to match the playback stream's sample rate to the device's
348 #  sample rate. Enabling this forces OpenAL Soft to mix sources and effects
349 #  directly to the actual output rate, avoiding a second resample pass by the
350 #  PulseAudio server.
351 #fix-rate = false
354 ## ALSA backend stuff
356 [alsa]
358 ## device: (global)
359 #  Sets the device name for the default playback device.
360 #device = default
362 ## device-prefix: (global)
363 #  Sets the prefix used by the discovered (non-default) playback devices. This
364 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
365 #  device index for the requested device name.
366 #device-prefix = plughw:
368 ## device-prefix-*: (global)
369 #  Card- and device-specific prefixes may be used to override the device-prefix
370 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
371 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
372 #  case-sensitive.
373 #device-prefix- =
375 ## capture: (global)
376 #  Sets the device name for the default capture device.
377 #capture = default
379 ## capture-prefix: (global)
380 #  Sets the prefix used by the discovered (non-default) capture devices. This
381 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
382 #  device number for the requested device name.
383 #capture-prefix = plughw:
385 ## capture-prefix-*: (global)
386 #  Card- and device-specific prefixes may be used to override the
387 #  capture-prefix option. The option may specify the card id (eg,
388 #  capture-prefix-NVidia), or the card id and device index (eg,
389 #  capture-prefix-NVidia-0). The card id is case-sensitive.
390 #capture-prefix- =
392 ## mmap:
393 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
394 #  consumption). If mmap isn't available, it will automatically fall back to
395 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
396 #  and anything else will force mmap off.
397 #mmap = true
399 ## allow-resampler:
400 #  Specifies whether to allow ALSA's built-in resampler. Enabling this will
401 #  allow the playback device to be set to a different sample rate than the
402 #  actual output, causing ALSA to apply its own resampling pass after OpenAL
403 #  Soft resamples and mixes the sources and effects for output.
404 #allow-resampler = false
407 ## OSS backend stuff
409 [oss]
411 ## device: (global)
412 #  Sets the device name for OSS output.
413 #device = /dev/dsp
415 ## capture: (global)
416 #  Sets the device name for OSS capture.
417 #capture = /dev/dsp
420 ## Solaris backend stuff
422 [solaris]
424 ## device: (global)
425 #  Sets the device name for Solaris output.
426 #device = /dev/audio
429 ## QSA backend stuff
431 [qsa]
434 ## JACK backend stuff
436 [jack]
438 ## spawn-server: (global)
439 #  Attempts to autospawn a JACK server whenever needed (initializing the
440 #  backend, opening devices, etc).
441 #spawn-server = false
443 ## buffer-size:
444 #  Sets the update buffer size, in samples, that the backend will keep buffered
445 #  to handle the server's real-time processing requests. This value must be a
446 #  power of 2, or else it will be rounded up to the next power of 2. If it is
447 #  less than JACK's buffer update size, it will be clamped. This option may
448 #  be useful in case the server's update size is too small and doesn't give the
449 #  mixer time to keep enough audio available for the processing requests.
450 #buffer-size = 0
453 ## MMDevApi backend stuff
455 [mmdevapi]
458 ## DirectSound backend stuff
460 [dsound]
463 ## Windows Multimedia backend stuff
465 [winmm]
468 ## PortAudio backend stuff
470 [port]
472 ## device: (global)
473 #  Sets the device index for output. Negative values will use the default as
474 #  given by PortAudio itself.
475 #device = -1
477 ## capture: (global)
478 #  Sets the device index for capture. Negative values will use the default as
479 #  given by PortAudio itself.
480 #capture = -1
483 ## Wave File Writer stuff
485 [wave]
487 ## file: (global)
488 #  Sets the filename of the wave file to write to. An empty name prevents the
489 #  backend from opening, even when explicitly requested.
490 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
491 #file =
493 ## bformat: (global)
494 #  Creates AMB format files using first-order ambisonics instead of a standard
495 #  single- or multi-channel .wav file.
496 #bformat = false