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/xdg/alsoft.conf (as determined by
18 # the XDG_CONFIG_DIRS env var list, /etc/xdg being the default if unset) and
19 # user-specific override settings in $HOME/.config/alsoft.conf (as determined
20 # by the XDG_CONFIG_HOME env var).
22 # For Windows, these settings should go into $AppData\alsoft.ini
24 # An additional configuration file (alsoft.ini on Windows, alsoft.conf on other
25 # OSs) can be placed alongside the process executable for app-specific config
28 # Option and block names are case-senstive. The supplied values are only hints
29 # and may not be honored (though generally it'll try to get as close as
30 # possible). Note: options that are left unset may default to app- or system-
31 # specified values. These are the current available settings:
38 ## disable-cpu-exts: (global)
39 # Disables use of specialized methods that use specific CPU intrinsics.
40 # Certain methods may utilize CPU extensions for improved performance, and
41 # this option is useful for preventing some or all of those methods from being
42 # used. The available extensions are: sse, sse2, sse3, sse4.1, and neon.
43 # Specifying 'all' disables use of all such specialized methods.
47 # Sets the backend driver list order, comma-seperated. Unknown backends and
48 # duplicated names are ignored. Unlisted backends won't be considered for use
49 # unless the list is ended with a comma (e.g. 'oss,' will try OSS first before
50 # other backends, while 'oss' will try OSS only). Backends prepended with -
51 # won't be considered for use (e.g. '-oss,' will try all available backends
52 # except OSS). An empty list means to try all backends.
56 # Sets the default output channel configuration. If left unspecified, one will
57 # try to be detected from the system, with a fallback to stereo. The available
58 # values are: mono, stereo, quad, surround51, surround61, surround71,
59 # surround714, surround3d71, ambi1, ambi2, ambi3. Note that the ambi*
60 # configurations output ambisonic channels of the given order (using ACN
61 # ordering and SN3D normalization by default), which need to be decoded to
62 # play correctly on speakers.
66 # Sets the default output sample type. Currently, all mixing is done with
67 # 32-bit float and converted to the output sample type as needed. Available
69 # int8 - signed 8-bit int
70 # uint8 - unsigned 8-bit int
71 # int16 - signed 16-bit int
72 # uint16 - unsigned 16-bit int
73 # int32 - signed 32-bit int
74 # uint32 - unsigned 32-bit int
75 # float32 - 32-bit float
76 #sample-type = float32
79 # Sets the default output frequency. If left unspecified it will try to detect
80 # a default from the system, otherwise it will fallback to 48000.
84 # Sets the update period size, in sample frames. This is the number of frames
85 # needed for each mixing update. Acceptable values range between 64 and 8192.
86 # If left unspecified it will default to 1/50th of the frequency (20ms, or 882
87 # for 44100, 960 for 48000, etc).
91 # Sets the number of update periods. Higher values create a larger mix ahead,
92 # which helps protect against skips when the CPU is under load, but increases
93 # the delay between a sound getting mixed and being heard. Acceptable values
94 # range between 2 and 16.
98 # Specifies if stereo output is treated as being headphones or speakers. With
99 # headphones, HRTF or crossfeed filters may be used for better audio quality.
100 # Valid settings are auto, speakers, and headphones.
104 # Specifies the default encoding method for stereo output. Valid values are:
105 # basic - Standard amplitude panning (aka pair-wise, stereo pair, etc) between
106 # -30 and +30 degrees.
107 # uhj - Creates a stereo-compatible two-channel UHJ mix, which encodes some
108 # surround sound information into stereo output that can be decoded with
109 # a surround sound receiver.
110 # hrtf - Uses filters to provide better spatialization of sounds while using
112 # If crossfeed filters are used, basic stereo mixing is used.
113 #stereo-encoding = basic
116 # Specifies the channel order and normalization for the "ambi*" set of channel
117 # configurations. Valid settings are: fuma, acn+fuma, ambix (or acn+sn3d), or
122 # Deprecated. Consider using stereo-encoding instead. Valid values are auto,
127 # Specifies the rendering mode for HRTF processing. Setting the mode to full
128 # (default) applies a unique HRIR filter to each source given its relative
129 # location, providing the clearest directional response at the cost of the
130 # highest CPU usage. Setting the mode to ambi1, ambi2, or ambi3 will instead
131 # mix to a first-, second-, or third-order ambisonic buffer respectively, then
132 # decode that buffer with HRTF filters. Ambi1 has the lowest CPU usage,
133 # replacing the per-source HRIR filter for a simple 4-channel panning mix, but
134 # retains full 3D placement at the cost of a more diffuse response. Ambi2 and
135 # ambi3 increasingly improve the directional clarity, at the cost of more CPU
136 # usage (still less than "full", given some number of active sources).
140 # Specifies the impulse response size, in samples, for the HRTF filter. Larger
141 # values increase the filter quality, while smaller values reduce processing
142 # cost. A value of 0 (default) uses the full filter size in the dataset, and
143 # the default dataset has a filter size of 64 samples at 48khz.
147 # Specifies the default HRTF to use. When multiple HRTFs are available, this
148 # determines the preferred one to use if none are specifically requested. Note
149 # that this is the enumerated HRTF name, not necessarily the filename.
153 # Specifies a comma-separated list of paths containing HRTF data sets. The
154 # format of the files are described in docs/hrtf.txt. The files within the
155 # directories must have the .mhr file extension to be recognized. By default,
156 # OS-dependent data paths will be used. They will also be used if the list
157 # ends with a comma. On Windows this is:
158 # $AppData\openal\hrtf
159 # And on other systems, it's (in order):
160 # $XDG_DATA_HOME/openal/hrtf (defaults to $HOME/.local/share/openal/hrtf)
161 # $XDG_DATA_DIRS/openal/hrtf (defaults to /usr/local/share/openal/hrtf and
162 # /usr/share/openal/hrtf)
166 # Sets the crossfeed level for stereo output. Valid values are:
169 # 2 - Middle crossfeed
170 # 3 - High crossfeed (virtual speakers are closer to itself)
171 # 4 - Low easy crossfeed
172 # 5 - Middle easy crossfeed
173 # 6 - High easy crossfeed
174 # Users of headphones may want to try various settings. Has no effect on non-
178 ## resampler: (global)
179 # Selects the default resampler used when mixing sources. Valid values are:
180 # point - nearest sample, no interpolation
181 # linear - extrapolates samples using a linear slope between samples
182 # spline - extrapolates samples using a Catmull-Rom spline
183 # gaussian - extrapolates samples using a 4-point Gaussian filter
184 # bsinc12 - extrapolates samples using a band-limited Sinc filter (varying
185 # between 12 and 24 points, with anti-aliasing)
186 # fast_bsinc12 - same as bsinc12, except without interpolation between down-
188 # bsinc24 - extrapolates samples using a band-limited Sinc filter (varying
189 # between 24 and 48 points, with anti-aliasing)
190 # fast_bsinc24 - same as bsinc24, except without interpolation between down-
192 #resampler = gaussian
195 # Sets the real-time priority value for the mixing thread. Not all drivers may
196 # use this (eg. PortAudio) as those APIs already control the priority of the
197 # mixing thread. 0 and negative values will disable real-time priority. Note
198 # that this may constitute a security risk since a real-time priority thread
199 # can indefinitely block normal-priority threads if it fails to wait. Disable
200 # this if it turns out to be a problem.
203 ## rt-time-limit: (global)
204 # On non-Windows systems, allows reducing the process's RLIMIT_RTTIME resource
205 # as necessary for acquiring real-time priority from RTKit.
206 #rt-time-limit = true
209 # Sets the maximum number of allocatable sources. Lower values may help for
210 # systems with apps that try to play more sounds than the CPU can handle.
214 # Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
215 # can use a non-negligible amount of CPU time if an effect is set on it even
216 # if no sources are feeding it, so this may help when apps use more than the
221 # Limits the number of auxiliary sends allowed per source. Setting this higher
222 # than the default has no effect.
226 # Applies filters to "stablize" front sound imaging. A psychoacoustic method
227 # is used to generate a front-center channel signal from the front-left and
228 # front-right channels, improving the front response by reducing the combing
229 # artifacts and phase errors. Consequently, it will only work with channel
230 # configurations that include front-left, front-right, and front-center.
231 #front-stablizer = false
234 # Applies a gain limiter on the final mixed output. This reduces the volume
235 # when the output samples would otherwise clamp, avoiding excessive clipping
236 # noise. On by default for integer sample types, and off by default for
241 # Applies dithering on the final mix, enabled by default for 8- and 16-bit
242 # output. This replaces the distortion created by nearest-value quantization
243 # with low-level whitenoise.
247 # Quantization bit-depth for dithered output. A value of 0 (or less) will
248 # match the output sample depth. For int32, uint32, and float32 output, 0 will
249 # disable dithering because they're at or beyond the rendered precision. The
250 # maximum dither depth is 24.
254 # A global volume adjustment for source output, expressed in decibels. The
255 # value is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will
256 # be a scale of 4x, etc. Similarly, -6 will be x1/2, and -12 is about x1/4. A
257 # value of 0 means no change.
260 ## excludefx: (global)
261 # Sets which effects to exclude, preventing apps from using them. This can
262 # help for apps that try to use effects which are too CPU intensive for the
263 # system to handle. Available effects are: eaxreverb,reverb,autowah,chorus,
264 # compressor,distortion,echo,equalizer,flanger,modulator,dedicated,pshifter,
268 ## default-reverb: (global)
269 # A reverb preset that applies by default to all sources on send 0
270 # (applications that set their own slots on send 0 will override this).
271 # Available presets include: None, Generic, PaddedCell, Room, Bathroom,
272 # Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
273 # CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Mountains,
274 # Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
277 ## trap-alc-error: (global)
278 # Generates a SIGTRAP signal when an ALC device error is generated, on systems
279 # that support it. This helps when debugging, while trying to find the cause
280 # of a device error. On Windows, a breakpoint exception is generated.
281 #trap-alc-error = false
283 ## trap-al-error: (global)
284 # Generates a SIGTRAP signal when an AL context error is generated, on systems
285 # that support it. This helps when debugging, while trying to find the cause
286 # of a context error. On Windows, a breakpoint exception is generated.
287 #trap-al-error = false
290 ## Ambisonic decoder stuff
295 # Enables a high-quality ambisonic decoder. This mode is capable of frequency-
296 # dependent processing, creating a better reproduction of 3D sound rendering
297 # over surround sound speakers.
301 # Enables compensation for the speakers' relative distances to the listener.
302 # This applies the necessary delays and attenuation to make the speakers
303 # behave as though they are all equidistant, which is important for proper
304 # playback of 3D sound rendering. Requires the proper distances to be
305 # specified in the decoder configuration file.
306 #distance-comp = true
309 # Enables near-field control filters. This simulates and compensates for low-
310 # frequency effects caused by the curvature of nearby sound-waves, which
311 # creates a more realistic perception of sound distance with surround sound
312 # output. Note that the effect may be stronger or weaker than intended if the
313 # application doesn't use or specify an appropriate unit scale, or if
314 # incorrect speaker distances are set. For HRTF output, hrtf-mode must be set
315 # to one of the ambi* values for this to function.
319 # Specifies the speaker distance in meters, used by the near-field control
320 # filters with surround sound output. For ambisonic output modes, this value
321 # is the basis for the NFC-HOA Reference Delay parameter (calculated as
322 # delay_seconds = speaker_dist/343.3). This value is not used when a decoder
323 # configuration is set for the output mode (since they specify the per-speaker
324 # distances, overriding this setting), or when the NFC filters are off. Valid
325 # values range from 0.1 to 10.
329 # Decoder configuration file for Quadraphonic channel output. See
330 # docs/ambdec.txt for a description of the file format.
334 # Decoder configuration file for 5.1 Surround (Side and Rear) channel output.
335 # See docs/ambdec.txt for a description of the file format.
339 # Decoder configuration file for 6.1 Surround channel output. See
340 # docs/ambdec.txt for a description of the file format.
344 # Decoder configuration file for 7.1 Surround channel output. See
345 # docs/ambdec.txt for a description of the file format.
349 # Decoder configuration file for 7.1.4 Surround channel output. See
350 # docs/ambdec.txt for a description of the file format.
354 # Decoder configuration file for 3D7.1 Surround channel output. See
355 # docs/ambdec.txt for a description of the file format. See also
356 # docs/3D7.1.txt for information about 3D7.1.
360 ## UHJ and Super Stereo stuff
364 ## decode-filter: (global)
365 # Specifies the all-pass filter type for UHJ decoding and Super Stereo
366 # processing. Valid values are:
367 # iir - utilizes dual IIR filters, providing a wide pass-band with low CPU
368 # use, but causes additional phase shifts on the signal.
369 # fir256 - utilizes a 256-point FIR filter, providing more stable results but
370 # exhibiting attenuation in the lower and higher frequency bands.
371 # fir512 - utilizes a 512-point FIR filter, providing a wider pass-band than
372 # fir256, at the cost of more CPU use.
375 ## encode-filter: (global)
376 # Specifies the all-pass filter type for UHJ output encoding. Valid values are
377 # the same as for decode-filter.
381 ## Reverb effect stuff (includes EAX reverb)
386 # A global amplification for reverb output, expressed in decibels. The value
387 # is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
388 # scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
389 # value of 0 means no change.
393 ## PipeWire backend stuff
397 ## assume-audio: (global)
398 # Causes the backend to succeed initialization even if PipeWire reports no
399 # audio support. Currently, audio support is detected by the presence of audio
400 # source or sink nodes, although this can cause false negatives in cases where
401 # device availability during library initialization is spotty. Future versions
402 # of PipeWire are expected to have a more robust method to test audio support,
403 # but in the mean time this can be set to true to assume PipeWire has audio
404 # support even when no nodes may be reported at initialization time.
405 #assume-audio = false
408 # Renders samples directly in the real-time processing callback. This allows
409 # for lower latency and less overall CPU utilization, but can increase the
410 # risk of underruns when increasing the amount of work the mixer needs to do.
414 ## PulseAudio backend stuff
418 ## spawn-server: (global)
419 # Attempts to autospawn a PulseAudio server whenever needed (initializing the
420 # backend, enumerating devices, etc). Setting autospawn to false in Pulse's
421 # client.conf will still prevent autospawning even if this is set to true.
422 #spawn-server = false
424 ## allow-moves: (global)
425 # Allows PulseAudio to move active streams to different devices. Note that the
426 # device specifier (seen by applications) will not be updated when this
427 # occurs, and neither will the AL device configuration (sample rate, format,
432 # Specifies whether to match the playback stream's sample rate to the device's
433 # sample rate. Enabling this forces OpenAL Soft to mix sources and effects
434 # directly to the actual output rate, avoiding a second resample pass by the
439 # Attempts to adjust the overall latency of device playback. Note that this
440 # may have adverse effects on the resulting internal buffer sizes and mixing
441 # updates, leading to performance problems and drop-outs. However, if the
442 # PulseAudio server is creating a lot of latency, enabling this may help make
443 # it more manageable.
444 #adjust-latency = false
447 ## ALSA backend stuff
452 # Sets the device name for the default playback device.
455 ## device-prefix: (global)
456 # Sets the prefix used by the discovered (non-default) playback devices. This
457 # will be appended with "CARD=c,DEV=d", where c is the card id and d is the
458 # device index for the requested device name.
459 #device-prefix = plughw:
461 ## device-prefix-*: (global)
462 # Card- and device-specific prefixes may be used to override the device-prefix
463 # option. The option may specify the card id (eg, device-prefix-NVidia), or
464 # the card id and device index (eg, device-prefix-NVidia-0). The card id is
468 ## custom-devices: (global)
469 # Specifies a list of enumerated playback devices and the ALSA devices they
470 # refer to. The list pattern is "Display Name=ALSA device;...". The display
471 # names will be returned for device enumeration, and the ALSA device is the
472 # device name to open for each enumerated device.
476 # Sets the device name for the default capture device.
479 ## capture-prefix: (global)
480 # Sets the prefix used by the discovered (non-default) capture devices. This
481 # will be appended with "CARD=c,DEV=d", where c is the card id and d is the
482 # device number for the requested device name.
483 #capture-prefix = plughw:
485 ## capture-prefix-*: (global)
486 # Card- and device-specific prefixes may be used to override the
487 # capture-prefix option. The option may specify the card id (eg,
488 # capture-prefix-NVidia), or the card id and device index (eg,
489 # capture-prefix-NVidia-0). The card id is case-sensitive.
492 ## custom-captures: (global)
493 # Specifies a list of enumerated capture devices and the ALSA devices they
494 # refer to. The list pattern is "Display Name=ALSA device;...". The display
495 # names will be returned for device enumeration, and the ALSA device is the
496 # device name to open for each enumerated device.
500 # Sets whether to try using mmap mode (helps reduce latencies and CPU
501 # consumption). If mmap isn't available, it will automatically fall back to
502 # non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
503 # and anything else will force mmap off.
507 # Specifies whether to allow ALSA's built-in resampler. Enabling this will
508 # allow the playback device to be set to a different sample rate than the
509 # actual output, causing ALSA to apply its own resampling pass after OpenAL
510 # Soft resamples and mixes the sources and effects for output.
511 #allow-resampler = false
519 # Sets the device name for OSS output.
523 # Sets the device name for OSS capture.
527 ## Solaris backend stuff
532 # Sets the device name for Solaris output.
541 ## JACK backend stuff
545 ## spawn-server: (global)
546 # Attempts to autospawn a JACK server when initializing.
547 #spawn-server = false
549 ## custom-devices: (global)
550 # Specifies a list of enumerated devices and the ports they connect to. The
551 # list pattern is "Display Name=ports regex;Display Name=ports regex;...". The
552 # display names will be returned for device enumeration, and the ports regex
553 # is the regular expression to identify the target ports on the server (as
554 # given by the jack_get_ports function) for each enumerated device.
558 # Renders samples directly in the real-time processing callback. This allows
559 # for lower latency and less overall CPU utilization, but can increase the
560 # risk of underruns when increasing the amount of work the mixer needs to do.
564 # Attempts to automatically connect the client ports to physical server ports.
565 # Client ports that fail to connect will leave the remaining channels
566 # unconnected and silent (the device format won't change to accommodate).
567 #connect-ports = true
570 # Sets the update buffer size, in samples, that the backend will keep buffered
571 # to handle the server's real-time processing requests. This value must be a
572 # power of 2, or else it will be rounded up to the next power of 2. If it is
573 # less than JACK's buffer update size, it will be clamped. This option may
574 # be useful in case the server's update size is too small and doesn't give the
575 # mixer time to keep enough audio available for the processing requests.
576 # Ignored when rt-mix is true.
580 ## WASAPI backend stuff
585 # Specifies whether to use a Spatial Audio stream for playback. This may
586 # provide expanded capabilities for surround sound and with-height speaker
587 # configurations. Very experimental.
591 # Specifies whether to allow an extra resampler pass on the output. Enabling
592 # this will allow the playback device to be set to a different sample rate
593 # than the actual output can accept, causing the backend to apply its own
594 # resampling pass after OpenAL Soft mixes the sources and processes effects
596 #allow-resampler = true
599 ## DirectSound backend stuff
604 ## Windows Multimedia backend stuff
609 ## PortAudio backend stuff
614 # Sets the device index for output. Negative values will use the default as
615 # given by PortAudio itself.
619 # Sets the device index for capture. Negative values will use the default as
620 # given by PortAudio itself.
624 ## Wave File Writer stuff
629 # Sets the filename of the wave file to write to. An empty name prevents the
630 # backend from opening, even when explicitly requested.
631 # THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
635 # Creates AMB format files using first-order ambisonics instead of a standard
636 # single- or multi-channel .wav file.
640 ## EAX extensions stuff
645 # Sets whether to enable EAX extensions or not.
649 ## Per-game compatibility options (these should only be set in per-game config
650 ## files, *NOT* system- or user-level!)
654 ## default-error: (global)
655 # An error value returned by alGetError when there's no current context. The
656 # default value is AL_INVALID_OPERATION, which lets the caller know the
657 # operation could not be executed. Some applications may erroneously call
658 # alGetError without a current context and expect 0 (AL_NO_ERROR), however
659 # that may cause other applications to think earlier AL calls succeeded when
660 # they actually failed.
661 #default-error = 0xA004
663 ## nfc-scale: (global)
664 # A meters-per-unit distance scale applied to NFC filters. If a game doesn't
665 # use real-world meters for in-game units, the filters may create a too-near
666 # or too-distant effect. For instance, if the game uses 1 foot per unit, a
667 # value of 0.3048 will correctly adjust the filters. Or if the game uses 1
668 # kilometer per unit, a value of 1000 will correctly adjust the filters.
671 ## enable-sub-data-ext: (global)
672 # Enables the AL_SOFT_buffer_sub_data extension, disabling the
673 # AL_EXT_SOURCE_RADIUS extension. These extensions are incompatible, so only
674 # one can be available. The latter extension is more commonly used, but this
675 # option can be enabled for older apps that want the former extension.
676 #enable-sub-data-ext = false
678 ## reverse-x: (global)
679 # Reverses the local X (left-right) position of 3D sound sources.
682 ## reverse-y: (global)
683 # Reverses the local Y (up-down) position of 3D sound sources.
686 ## reverse-z: (global)
687 # Reverses the local Z (front-back) position of 3D sound sources.
691 # Overrides the string returned by alGetString(AL_VENDOR).
695 # Overrides the string returned by alGetString(AL_VERSION).
698 ## renderer-override:
699 # Overrides the string returned by alGetString(AL_RENDERER).