Use al::byte instead of ALbyte for raw bytes
[openal-soft.git] / alsoftrc.sample
blob95d4ff82c7f9ef0edfa644e15369bff19240adaa
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 sample frames. This is the number of frames
76 #  needed for each mixing update. Acceptable values range between 64 and 8192.
77 #  If left unspecified it will default to 1/50th of the frequency (20ms, or 882
78 #  for 44100, 960 for 48000, etc).
79 #period_size =
81 ## periods:
82 #  Sets the number of update periods. Higher values create a larger mix ahead,
83 #  which helps protect against skips when the CPU is under load, but increases
84 #  the delay between a sound getting mixed and being heard. Acceptable values
85 #  range between 2 and 16.
86 #periods = 3
88 ## stereo-mode:
89 #  Specifies if stereo output is treated as being headphones or speakers. With
90 #  headphones, HRTF or crossfeed filters may be used for better audio quality.
91 #  Valid settings are auto, speakers, and headphones.
92 #stereo-mode = auto
94 ## stereo-encoding:
95 #  Specifies the encoding method for non-HRTF stereo output. 'panpot' (default)
96 #  uses standard amplitude panning (aka pair-wise, stereo pair, etc) between
97 #  -30 and +30 degrees, while 'uhj' creates stereo-compatible two-channel UHJ
98 #  output, which encodes some surround sound information into stereo output
99 #  that can be decoded with a surround sound receiver. If crossfeed filters are
100 #  used, UHJ is disabled.
101 #stereo-encoding = panpot
103 ## ambi-format:
104 #  Specifies the channel order and normalization for the "ambi*" set of channel
105 #  configurations. Valid settings are: fuma, ambix (or acn+sn3d), acn+n3d
106 #ambi-format = ambix
108 ## hrtf:
109 #  Controls HRTF processing. These filters provide better spatialization of
110 #  sounds while using headphones, but do require a bit more CPU power. The
111 #  default filters will only work with 44100hz or 48000hz stereo output. While
112 #  HRTF is used, the cf_level option is ignored. Setting this to auto (default)
113 #  will allow HRTF to be used when headphones are detected or the app requests
114 #  it, while setting true or false will forcefully enable or disable HRTF
115 #  respectively.
116 #hrtf = auto
118 ## default-hrtf:
119 #  Specifies the default HRTF to use. When multiple HRTFs are available, this
120 #  determines the preferred one to use if none are specifically requested. Note
121 #  that this is the enumerated HRTF name, not necessarily the filename.
122 #default-hrtf =
124 ## hrtf-paths:
125 #  Specifies a comma-separated list of paths containing HRTF data sets. The
126 #  format of the files are described in docs/hrtf.txt. The files within the
127 #  directories must have the .mhr file extension to be recognized. By default,
128 #  OS-dependent data paths will be used. They will also be used if the list
129 #  ends with a comma. On Windows this is:
130 #  $AppData\openal\hrtf
131 #  And on other systems, it's (in order):
132 #  $XDG_DATA_HOME/openal/hrtf  (defaults to $HOME/.local/share/openal/hrtf)
133 #  $XDG_DATA_DIRS/openal/hrtf  (defaults to /usr/local/share/openal/hrtf and
134 #                               /usr/share/openal/hrtf)
135 #hrtf-paths =
137 ## cf_level:
138 #  Sets the crossfeed level for stereo output. Valid values are:
139 #  0 - No crossfeed
140 #  1 - Low crossfeed
141 #  2 - Middle crossfeed
142 #  3 - High crossfeed (virtual speakers are closer to itself)
143 #  4 - Low easy crossfeed
144 #  5 - Middle easy crossfeed
145 #  6 - High easy crossfeed
146 #  Users of headphones may want to try various settings. Has no effect on non-
147 #  stereo modes.
148 #cf_level = 0
150 ## resampler: (global)
151 #  Selects the resampler used when mixing sources. Valid values are:
152 #  point - nearest sample, no interpolation
153 #  linear - extrapolates samples using a linear slope between samples
154 #  cubic - extrapolates samples using a Catmull-Rom spline
155 #  bsinc12 - extrapolates samples using a band-limited Sinc filter (varying
156 #            between 12 and 24 points, with anti-aliasing)
157 #  bsinc24 - extrapolates samples using a band-limited Sinc filter (varying
158 #            between 24 and 48 points, with anti-aliasing)
159 #resampler = linear
161 ## rt-prio: (global)
162 #  Sets real-time priority for the mixing thread. Not all drivers may use this
163 #  (eg. PortAudio) as they already control the priority of the mixing thread.
164 #  0 and negative values will disable it. Note that this may constitute a
165 #  security risk since a real-time priority thread can indefinitely block
166 #  normal-priority threads if it fails to wait. As such, the default is
167 #  disabled.
168 #rt-prio = 0
170 ## sources:
171 #  Sets the maximum number of allocatable sources. Lower values may help for
172 #  systems with apps that try to play more sounds than the CPU can handle.
173 #sources = 256
175 ## slots:
176 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
177 #  can use a non-negligible amount of CPU time if an effect is set on it even
178 #  if no sources are feeding it, so this may help when apps use more than the
179 #  system can handle.
180 #slots = 64
182 ## sends:
183 #  Limits the number of auxiliary sends allowed per source. Setting this higher
184 #  than the default has no effect.
185 #sends = 16
187 ## front-stablizer:
188 #  Applies filters to "stablize" front sound imaging. A psychoacoustic method
189 #  is used to generate a front-center channel signal from the front-left and
190 #  front-right channels, improving the front response by reducing the combing
191 #  artifacts and phase errors. Consequently, it will only work with channel
192 #  configurations that include front-left, front-right, and front-center.
193 #front-stablizer = false
195 ## output-limiter:
196 #  Applies a gain limiter on the final mixed output. This reduces the volume
197 #  when the output samples would otherwise clamp, avoiding excessive clipping
198 #  noise.
199 #output-limiter = true
201 ## dither:
202 #  Applies dithering on the final mix, for 8- and 16-bit output by default.
203 #  This replaces the distortion created by nearest-value quantization with low-
204 #  level whitenoise.
205 #dither = true
207 ## dither-depth:
208 #  Quantization bit-depth for dithered output. A value of 0 (or less) will
209 #  match the output sample depth. For int32, uint32, and float32 output, 0 will
210 #  disable dithering because they're at or beyond the rendered precision. The
211 #  maximum dither depth is 24.
212 #dither-depth = 0
214 ## volume-adjust:
215 #  A global volume adjustment for source output, expressed in decibels. The
216 #  value is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will
217 #  be a scale of 4x, etc. Similarly, -6 will be x1/2, and -12 is about x1/4. A
218 #  value of 0 means no change.
219 #volume-adjust = 0
221 ## excludefx: (global)
222 #  Sets which effects to exclude, preventing apps from using them. This can
223 #  help for apps that try to use effects which are too CPU intensive for the
224 #  system to handle. Available effects are: eaxreverb,reverb,autowah,chorus,
225 #  compressor,distortion,echo,equalizer,flanger,modulator,dedicated,pshifter,
226 #  fshifter
227 #excludefx =
229 ## default-reverb: (global)
230 #  A reverb preset that applies by default to all sources on send 0
231 #  (applications that set their own slots on send 0 will override this).
232 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
233 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
234 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
235 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
236 #default-reverb =
238 ## trap-alc-error: (global)
239 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
240 #  that support it. This helps when debugging, while trying to find the cause
241 #  of a device error. On Windows, a breakpoint exception is generated.
242 #trap-alc-error = false
244 ## trap-al-error: (global)
245 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
246 #  that support it. This helps when debugging, while trying to find the cause
247 #  of a context error. On Windows, a breakpoint exception is generated.
248 #trap-al-error = false
251 ## Ambisonic decoder stuff
253 [decoder]
255 ## hq-mode:
256 #  Enables a high-quality ambisonic decoder. This mode is capable of frequency-
257 #  dependent processing, creating a better reproduction of 3D sound rendering
258 #  over surround sound speakers. Enabling this also requires specifying decoder
259 #  configuration files for the appropriate speaker configuration you intend to
260 #  use (see the quad, surround51, etc options below). Currently, up to third-
261 #  order decoding is supported.
262 hq-mode = false
264 ## distance-comp:
265 #  Enables compensation for the speakers' relative distances to the listener.
266 #  This applies the necessary delays and attenuation to make the speakers
267 #  behave as though they are all equidistant, which is important for proper
268 #  playback of 3D sound rendering. Requires the proper distances to be
269 #  specified in the decoder configuration file.
270 distance-comp = true
272 ## nfc:
273 #  Enables near-field control filters. This simulates and compensates for low-
274 #  frequency effects caused by the curvature of nearby sound-waves, which
275 #  creates a more realistic perception of sound distance. Note that the effect
276 #  may be stronger or weaker than intended if the application doesn't use or
277 #  specify an appropriate unit scale, or if incorrect speaker distances are set
278 #  in the decoder configuration file.
279 nfc = false
281 ## nfc-ref-delay
282 #  Specifies the reference delay value for ambisonic output when NFC filters
283 #  are enabled. If channels is set to one of the ambi* formats, this option
284 #  enables NFC-HOA output with the specified Reference Delay parameter. The
285 #  specified value can then be shared with an appropriate NFC-HOA decoder to
286 #  reproduce correct near-field effects. Keep in mind that despite being
287 #  designed for higher-order ambisonics, this also applies to first-order
288 #  output. When left unset, normal output is created with no near-field
289 #  simulation. Requires the nfc option to also be enabled.
290 nfc-ref-delay =
292 ## quad:
293 #  Decoder configuration file for Quadraphonic channel output. See
294 #  docs/ambdec.txt for a description of the file format.
295 quad =
297 ## surround51:
298 #  Decoder configuration file for 5.1 Surround (Side and Rear) channel output.
299 #  See docs/ambdec.txt for a description of the file format.
300 surround51 =
302 ## surround61:
303 #  Decoder configuration file for 6.1 Surround channel output. See
304 #  docs/ambdec.txt for a description of the file format.
305 surround61 =
307 ## surround71:
308 #  Decoder configuration file for 7.1 Surround channel output. See
309 #  docs/ambdec.txt for a description of the file format. Note: This can be used
310 #  to enable 3D7.1 with the appropriate configuration and speaker placement,
311 #  see docs/3D7.1.txt.
312 surround71 =
315 ## Reverb effect stuff (includes EAX reverb)
317 [reverb]
319 ## boost: (global)
320 #  A global amplification for reverb output, expressed in decibels. The value
321 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
322 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
323 #  value of 0 means no change.
324 #boost = 0
327 ## PulseAudio backend stuff
329 [pulse]
331 ## spawn-server: (global)
332 #  Attempts to autospawn a PulseAudio server whenever needed (initializing the
333 #  backend, enumerating devices, etc). Setting autospawn to false in Pulse's
334 #  client.conf will still prevent autospawning even if this is set to true.
335 #spawn-server = true
337 ## allow-moves: (global)
338 #  Allows PulseAudio to move active streams to different devices. Note that the
339 #  device specifier (seen by applications) will not be updated when this
340 #  occurs, and neither will the AL device configuration (sample rate, format,
341 #  etc).
342 #allow-moves = true
344 ## fix-rate:
345 #  Specifies whether to match the playback stream's sample rate to the device's
346 #  sample rate. Enabling this forces OpenAL Soft to mix sources and effects
347 #  directly to the actual output rate, avoiding a second resample pass by the
348 #  PulseAudio server.
349 #fix-rate = false
351 ## adjust-latency:
352 #  Attempts to adjust the overall latency of device playback. Note that this
353 #  may have adverse effects on the resulting internal buffer sizes and mixing
354 #  updates, leading to performance problems and drop-outs. However, if the
355 #  PulseAudio server is creating a lot of latency, enabling this may help make
356 #  it more manageable.
357 #adjust-latency = false
360 ## ALSA backend stuff
362 [alsa]
364 ## device: (global)
365 #  Sets the device name for the default playback device.
366 #device = default
368 ## device-prefix: (global)
369 #  Sets the prefix used by the discovered (non-default) playback devices. This
370 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
371 #  device index for the requested device name.
372 #device-prefix = plughw:
374 ## device-prefix-*: (global)
375 #  Card- and device-specific prefixes may be used to override the device-prefix
376 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
377 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
378 #  case-sensitive.
379 #device-prefix- =
381 ## capture: (global)
382 #  Sets the device name for the default capture device.
383 #capture = default
385 ## capture-prefix: (global)
386 #  Sets the prefix used by the discovered (non-default) capture devices. This
387 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
388 #  device number for the requested device name.
389 #capture-prefix = plughw:
391 ## capture-prefix-*: (global)
392 #  Card- and device-specific prefixes may be used to override the
393 #  capture-prefix option. The option may specify the card id (eg,
394 #  capture-prefix-NVidia), or the card id and device index (eg,
395 #  capture-prefix-NVidia-0). The card id is case-sensitive.
396 #capture-prefix- =
398 ## mmap:
399 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
400 #  consumption). If mmap isn't available, it will automatically fall back to
401 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
402 #  and anything else will force mmap off.
403 #mmap = true
405 ## allow-resampler:
406 #  Specifies whether to allow ALSA's built-in resampler. Enabling this will
407 #  allow the playback device to be set to a different sample rate than the
408 #  actual output, causing ALSA to apply its own resampling pass after OpenAL
409 #  Soft resamples and mixes the sources and effects for output.
410 #allow-resampler = false
413 ## OSS backend stuff
415 [oss]
417 ## device: (global)
418 #  Sets the device name for OSS output.
419 #device = /dev/dsp
421 ## capture: (global)
422 #  Sets the device name for OSS capture.
423 #capture = /dev/dsp
426 ## Solaris backend stuff
428 [solaris]
430 ## device: (global)
431 #  Sets the device name for Solaris output.
432 #device = /dev/audio
435 ## QSA backend stuff
437 [qsa]
440 ## JACK backend stuff
442 [jack]
444 ## spawn-server: (global)
445 #  Attempts to autospawn a JACK server whenever needed (initializing the
446 #  backend, opening devices, etc).
447 #spawn-server = false
449 ## buffer-size:
450 #  Sets the update buffer size, in samples, that the backend will keep buffered
451 #  to handle the server's real-time processing requests. This value must be a
452 #  power of 2, or else it will be rounded up to the next power of 2. If it is
453 #  less than JACK's buffer update size, it will be clamped. This option may
454 #  be useful in case the server's update size is too small and doesn't give the
455 #  mixer time to keep enough audio available for the processing requests.
456 #buffer-size = 0
459 ## WASAPI backend stuff
461 [wasapi]
464 ## DirectSound backend stuff
466 [dsound]
469 ## Windows Multimedia backend stuff
471 [winmm]
474 ## PortAudio backend stuff
476 [port]
478 ## device: (global)
479 #  Sets the device index for output. Negative values will use the default as
480 #  given by PortAudio itself.
481 #device = -1
483 ## capture: (global)
484 #  Sets the device index for capture. Negative values will use the default as
485 #  given by PortAudio itself.
486 #capture = -1
489 ## Wave File Writer stuff
491 [wave]
493 ## file: (global)
494 #  Sets the filename of the wave file to write to. An empty name prevents the
495 #  backend from opening, even when explicitly requested.
496 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
497 #file =
499 ## bformat: (global)
500 #  Creates AMB format files using first-order ambisonics instead of a standard
501 #  single- or multi-channel .wav file.
502 #bformat = false