Use proper atomics in the OSS backend
[openal-soft.git] / alsoftrc.sample
blobd5913ff0e997e58bcdd09b9e821451ec3f130dfa
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 = 4
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-panning:
93 #  Specifies the panning method for non-HRTF stereo output. uhj (default)
94 #  creates stereo-compatible two-channel UHJ output, which encodes some
95 #  surround sound information, while paired uses standard pair-wise panning
96 #  between -30 and +30 degrees. If crossfeed filters are used, uhj panning is
97 #  disabled.
98 #stereo-panning = uhj
100 ## ambi-format:
101 #  Specifies the channel order and normalization for the "ambi*" set of channel
102 #  configurations. Valid settings are: fuma, acn+sn3d, acn+n3d
103 #ambi-format = acn+sn3d
105 ## hrtf:
106 #  Controls HRTF processing. These filters provide better spatialization of
107 #  sounds while using headphones, but do require a bit more CPU power. The
108 #  default filters will only work with 44100hz or 48000hz stereo output. While
109 #  HRTF is used, the cf_level option is ignored. Setting this to auto (default)
110 #  will allow HRTF to be used when headphones are detected or the app requests
111 #  it, while setting true or false will forcefully enable or disable HRTF
112 #  respectively.
113 #hrtf = auto
115 ## default-hrtf:
116 #  Specifies the default HRTF to use. When multiple HRTFs are available, this
117 #  determines the preferred one to use if none are specifically requested. Note
118 #  that this is the enumerated HRTF name, not necessarily the filename.
119 #default-hrtf =
121 ## hrtf-paths:
122 #  Specifies a comma-separated list of paths containing HRTF data sets. The
123 #  format of the files are described in docs/hrtf.txt. The files within the
124 #  directories must have the .mhr file extension to be recognized. By default,
125 #  OS-dependent data paths will be used. They will also be used if the list
126 #  ends with a comma. On Windows this is:
127 #  $AppData\openal\hrtf
128 #  And on other systems, it's (in order):
129 #  $XDG_DATA_HOME/openal/hrtf  (defaults to $HOME/.local/share/openal/hrtf)
130 #  $XDG_DATA_DIRS/openal/hrtf  (defaults to /usr/local/share/openal/hrtf and
131 #                               /usr/share/openal/hrtf)
132 #hrtf-paths =
134 ## cf_level:
135 #  Sets the crossfeed level for stereo output. Valid values are:
136 #  0 - No crossfeed
137 #  1 - Low crossfeed
138 #  2 - Middle crossfeed
139 #  3 - High crossfeed (virtual speakers are closer to itself)
140 #  4 - Low easy crossfeed
141 #  5 - Middle easy crossfeed
142 #  6 - High easy crossfeed
143 #  Users of headphones may want to try various settings. Has no effect on non-
144 #  stereo modes.
145 #cf_level = 0
147 ## resampler: (global)
148 #  Selects the resampler used when mixing sources. Valid values are:
149 #  point - nearest sample, no interpolation
150 #  linear - extrapolates samples using a linear slope between samples
151 #  sinc4 - extrapolates samples using a 4-point Sinc filter
152 #  sinc8 - extrapolates samples using an 8-point Sinc filter
153 #  bsinc - extrapolates samples using a band-limited Sinc filter (varying
154 #          between 12 and 24 points, with anti-aliasing)
155 #  Specifying other values will result in using the default (linear).
156 #resampler = linear
158 ## rt-prio: (global)
159 #  Sets real-time priority for the mixing thread. Not all drivers may use this
160 #  (eg. PortAudio) as they already control the priority of the mixing thread.
161 #  0 and negative values will disable it. Note that this may constitute a
162 #  security risk since a real-time priority thread can indefinitely block
163 #  normal-priority threads if it fails to wait. As such, the default is
164 #  disabled.
165 #rt-prio = 0
167 ## sources:
168 #  Sets the maximum number of allocatable sources. Lower values may help for
169 #  systems with apps that try to play more sounds than the CPU can handle.
170 #sources = 256
172 ## slots:
173 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
174 #  can use a non-negligible amount of CPU time if an effect is set on it even
175 #  if no sources are feeding it, so this may help when apps use more than the
176 #  system can handle.
177 #slots = 4
179 ## sends:
180 #  Sets the number of auxiliary sends per source. When not specified (default),
181 #  it allows the app to request how many it wants. The maximum value currently
182 #  possible is 4.
183 #sends =
185 ## volume-adjust:
186 #  A global volume adjustment for source output, expressed in decibels. The
187 #  value is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will
188 #  be a scale of 4x, etc. Similarly, -6 will be x1/2, and -12 is about x1/4. A
189 #  value of 0 means no change.
190 #volume-adjust = 0
192 ## excludefx: (global)
193 #  Sets which effects to exclude, preventing apps from using them. This can
194 #  help for apps that try to use effects which are too CPU intensive for the
195 #  system to handle. Available effects are: eaxreverb,reverb,chorus,compressor,
196 #  distortion,echo,equalizer,flanger,modulator,dedicated
197 #excludefx =
199 ## default-reverb: (global)
200 #  A reverb preset that applies by default to all sources on send 0
201 #  (applications that set their own slots on send 0 will override this).
202 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
203 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
204 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
205 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
206 #default-reverb =
208 ## trap-alc-error: (global)
209 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
210 #  that support it. This helps when debugging, while trying to find the cause
211 #  of a device error. On Windows, a breakpoint exception is generated.
212 #trap-alc-error = false
214 ## trap-al-error: (global)
215 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
216 #  that support it. This helps when debugging, while trying to find the cause
217 #  of a context error. On Windows, a breakpoint exception is generated.
218 #trap-al-error = false
221 ## Ambisonic decoder stuff
223 [decoder]
225 ## hq-mode:
226 #  Enables a high-quality ambisonic decoder. This mode is capable of frequency-
227 #  dependent processing, creating a better reproduction of 3D sound rendering
228 #  over surround sound speakers. Enabling this also requires specifying decoder
229 #  configuration files for the appropriate speaker configuration you intend to
230 #  use (see the quad, surround51, etc options below). Currently, up to third-
231 #  order decoding is supported.
232 hq-mode = false
234 ## distance-comp:
235 #  Enables compensation for the speakers' relative distances to the listener.
236 #  This applies the necessary delays and attenuation to make the speakers
237 #  behave as though they are all equidistant, which is important for proper
238 #  playback of 3D sound rendering. Requires the high-quality ambisonic decoder,
239 #  as well as the proper distances to be specified in the decoder configuration
240 #  file.
241 distance-comp = true
243 ## quad:
244 #  Decoder configuration file for Quadrophonic channel output. See
245 #  docs/ambdec.txt for a description of the file format.
246 quad =
248 ## surround51:
249 #  Decoder configuration file for 5.1 Surround (Side) channel output. See
250 #  docs/ambdec.txt for a description of the file format.
251 surround51 =
253 ## surround51rear:
254 #  Decoder configuration file for 5.1 Surround (Rear) channel output. See
255 #  docs/ambdec.txt for a description of the file format.
256 surround51rear =
258 ## surround61:
259 #  Decoder configuration file for 6.1 Surround channel output. See
260 #  docs/ambdec.txt for a description of the file format.
261 surround61 =
263 ## surround71:
264 #  Decoder configuration file for 7.1 Surround channel output. See
265 #  docs/ambdec.txt for a description of the file format. Note: This can be used
266 #  to enable 3D7.1 with the appropriate configuration and speaker placement,
267 #  see docs/3D7.1.txt.
268 surround71 =
271 ## Reverb effect stuff (includes EAX reverb)
273 [reverb]
275 ## boost: (global)
276 #  A global amplification for reverb output, expressed in decibels. The value
277 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
278 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
279 #  value of 0 means no change.
280 #boost = 0
282 ## emulate-eax: (global)
283 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
284 #  reverb processing is a bit more CPU intensive than standard, so this option
285 #  allows a simpler effect to be used at the loss of some quality.
286 #emulate-eax = false
289 ## PulseAudio backend stuff
291 [pulse]
293 ## spawn-server: (global)
294 #  Attempts to autospawn a PulseAudio server whenever needed (initializing the
295 #  backend, enumerating devices, etc). Setting autospawn to false in Pulse's
296 #  client.conf will still prevent autospawning even if this is set to true.
297 #spawn-server = true
299 ## allow-moves: (global)
300 #  Allows PulseAudio to move active streams to different devices. Note that the
301 #  device specifier (seen by applications) will not be updated when this
302 #  occurs, and neither will the AL device configuration (sample rate, format,
303 #  etc).
304 #allow-moves = false
306 ## fix-rate:
307 #  Specifies whether to match the playback stream's sample rate to the device's
308 #  sample rate. Enabling this forces OpenAL Soft to mix sources and effects
309 #  directly to the actual output rate, avoiding a second resample pass by the
310 #  PulseAudio server.
311 #fix-rate = false
314 ## ALSA backend stuff
316 [alsa]
318 ## device: (global)
319 #  Sets the device name for the default playback device.
320 #device = default
322 ## device-prefix: (global)
323 #  Sets the prefix used by the discovered (non-default) playback devices. This
324 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
325 #  device index for the requested device name.
326 #device-prefix = plughw:
328 ## device-prefix-*: (global)
329 #  Card- and device-specific prefixes may be used to override the device-prefix
330 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
331 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
332 #  case-sensitive.
333 #device-prefix- =
335 ## capture: (global)
336 #  Sets the device name for the default capture device.
337 #capture = default
339 ## capture-prefix: (global)
340 #  Sets the prefix used by the discovered (non-default) capture devices. This
341 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
342 #  device number for the requested device name.
343 #capture-prefix = plughw:
345 ## capture-prefix-*: (global)
346 #  Card- and device-specific prefixes may be used to override the
347 #  capture-prefix option. The option may specify the card id (eg,
348 #  capture-prefix-NVidia), or the card id and device index (eg,
349 #  capture-prefix-NVidia-0). The card id is case-sensitive.
350 #capture-prefix- =
352 ## mmap:
353 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
354 #  consumption). If mmap isn't available, it will automatically fall back to
355 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
356 #  and anything else will force mmap off.
357 #mmap = true
359 ## allow-resampler:
360 #  Specifies whether to allow ALSA's built-in resampler. Enabling this will
361 #  allow the playback device to be set to a different sample rate than the
362 #  actual output, causing ALSA to apply its own resampling pass after OpenAL
363 #  Soft resamples and mixes the sources and effects for output.
364 #allow-resampler = false
367 ## OSS backend stuff
369 [oss]
371 ## device: (global)
372 #  Sets the device name for OSS output.
373 #device = /dev/dsp
375 ## capture: (global)
376 #  Sets the device name for OSS capture.
377 #capture = /dev/dsp
380 ## Solaris backend stuff
382 [solaris]
384 ## device: (global)
385 #  Sets the device name for Solaris output.
386 #device = /dev/audio
389 ## QSA backend stuff
391 [qsa]
394 ## JACK backend stuff
396 [jack]
398 ## spawn-server: (global)
399 #  Attempts to autospawn a JACK server whenever needed (initializing the
400 #  backend, opening devices, etc).
401 #spawn-server = false
403 ## buffer-size:
404 #  Sets the update buffer size, in samples, that the backend will keep buffered
405 #  to handle the server's real-time processing requests. This value must be a
406 #  power of 2, or else it will be rounded up to the next power of 2. If it is
407 #  less than JACK's buffer update size, it will be clamped. This option may
408 #  be useful in case the server's update size is too small and doesn't give the
409 #  mixer time to keep enough audio available for the processing requests.
410 #buffer-size = 0
413 ## MMDevApi backend stuff
415 [mmdevapi]
418 ## DirectSound backend stuff
420 [dsound]
423 ## Windows Multimedia backend stuff
425 [winmm]
428 ## PortAudio backend stuff
430 [port]
432 ## device: (global)
433 #  Sets the device index for output. Negative values will use the default as
434 #  given by PortAudio itself.
435 #device = -1
437 ## capture: (global)
438 #  Sets the device index for capture. Negative values will use the default as
439 #  given by PortAudio itself.
440 #capture = -1
443 ## Wave File Writer stuff
445 [wave]
447 ## file: (global)
448 #  Sets the filename of the wave file to write to. An empty name prevents the
449 #  backend from opening, even when explicitly requested.
450 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
451 #file =
453 ## bformat: (global)
454 #  Creates AMB format files using first-order ambisonics instead of a standard
455 #  single- or multi-channel .wav file.
456 #bformat = false