alsoftrc.sample

   1 # OpenAL config file. Options that are not under a block or are under the
   2 # [general] block are for general, non-backend-specific options. Blocks may
   3 # appear multiple times, and duplicated options will take the last value
   4 # specified.
   5 # The system-wide settings can be put in /etc/openal/alsoft.conf and user-
   6 # specific override settings in ~/.alsoftrc.
   7 # For Windows, these settings should go into %AppData%\alsoft.ini
   8 # The environment variable ALSOFT_CONF can be used to specify another config
   9 # override
  10
  11 # Option and block names are case-insenstive. The supplied values are only
  12 # hints and may not be honored (though generally it'll try to get as close as
  13 # possible). Note: options that are left unset may default to app- or system-
  14 # specified values. These are the current available settings:
  15
  16 ## format:
  17 #  Sets the output format. Can be one of:
  18 #  AL_FORMAT_MONO8    (8-bit mono)
  19 #  AL_FORMAT_STEREO8  (8-bit stereo)
  20 #  AL_FORMAT_QUAD8    (8-bit 4-channel)
  21 #  AL_FORMAT_51CHN8   (8-bit 5.1 output)
  22 #  AL_FORMAT_61CHN8   (8-bit 6.1 output)
  23 #  AL_FORMAT_71CHN8   (8-bit 7.1 output)
  24 #  AL_FORMAT_MONO16   (16-bit mono)
  25 #  AL_FORMAT_STEREO16 (16-bit stereo)
  26 #  AL_FORMAT_QUAD16   (16-bit 4-channel)
  27 #  AL_FORMAT_51CHN16  (16-bit 5.1 output)
  28 #  AL_FORMAT_61CHN16  (16-bit 6.1 output)
  29 #  AL_FORMAT_71CHN16  (16-bit 7.1 output)
  30 #  AL_FORMAT_MONO32   (32-bit float mono)
  31 #  AL_FORMAT_STEREO32 (32-bit float stereo)
  32 #  AL_FORMAT_QUAD32   (32-bit float 4-channel)
  33 #  AL_FORMAT_51CHN32  (32-bit float 5.1 output)
  34 #  AL_FORMAT_61CHN32  (32-bit float 6.1 output)
  35 #  AL_FORMAT_71CHN32  (32-bit float 7.1 output)
  36 #format = AL_FORMAT_STEREO16
  37
  38 ## hrtf:
  39 #  Enables HRTF filters. These filters provide for better sound spatialization
  40 #  while using headphones. The filters will only work when output is 44100hz
  41 #  stereo. While HRTF is active, the cf_level option is disabled. Default is
  42 #  disabled since stereo speaker output quality may suffer.
  43 #hrtf = false
  44
  45 ## cf_level:
  46 #  Sets the crossfeed level for stereo output. Valid values are:
  47 #  0 - No crossfeed
  48 #  1 - Low crossfeed
  49 #  2 - Middle crossfeed
  50 #  3 - High crossfeed (virtual speakers are closer to itself)
  51 #  4 - Low easy crossfeed
  52 #  5 - Middle easy crossfeed
  53 #  6 - High easy crossfeed
  54 #  Users of headphones may want to try various settings. Has no effect on non-
  55 #  stereo modes.
  56 #cf_level = 0
  57
  58 ## frequency:
  59 #  Sets the output frequency.
  60 #frequency = 44100
  61
  62 ## resampler:
  63 #  Selects the resampler used when mixing sources. Valid values are:
  64 #  0 - None (nearest sample, no interpolation)
  65 #  1 - Linear (extrapolates samples using a linear slope between samples)
  66 #  2 - Cubic (extrapolates samples using a Catmull-Rom spline)
  67 #  Specifying other values will result in using the default (linear).
  68 #resampler = 1
  69
  70 ## rt-prio:
  71 #  Sets real-time priority for the mixing thread. Not all drivers may use this
  72 #  (eg. PortAudio) as they already control the priority of the mixing thread.
  73 #  0 and negative values will disable it. Note that this may constitute a
  74 #  security risk since a real-time priority thread can indefinitely block
  75 #  normal-priority threads if it fails to wait. As such, the default is
  76 #  disabled.
  77 #rt-prio = 0
  78
  79 ## period_size:
  80 #  Sets the update period size, in frames. This is the number of frames needed
  81 #  for each mixing update.
  82 #period_size = 1024
  83
  84 ## periods:
  85 #  Sets the number of update periods. Higher values create a larger mix ahead,
  86 #  which helps protect against skips when the CPU is under load, but increases
  87 #  the delay between a sound getting mixed and being heard.
  88 #periods = 4
  89
  90 ## sources:
  91 #  Sets the maximum number of allocatable sources. Lower values may help for
  92 #  systems with apps that try to play more sounds than the CPU can handle.
  93 #sources = 256
  94
  95 ## stereodup:
  96 #  Sets whether to duplicate stereo sounds behind the listener for 4+ channel
  97 #  output. This provides a "fuller" playback quality for surround sound output
  98 #  modes, although each individual speaker will have a slight reduction in
  99 #  volume to compensate for the extra output speakers. True, yes, on, and non-0
 100 #  values will duplicate stereo sources. 0 and anything else will cause stereo
 101 #  sounds to only play in front. This only has an effect when a suitable output
 102 #  format is used (ie. those that contain side and/or rear speakers).
 103 #stereodup = true
 104
 105 ## drivers:
 106 #  Sets the backend driver list order, comma-seperated. Unknown backends and
 107 #  duplicated names are ignored. Unlisted backends won't be considered for use
 108 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
 109 #  followed by all other available backends, while 'oss' will list OSS only).
 110 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
 111 #  all available backends except OSS). An empty list means the default.
 112 #drivers = pulse,alsa,core,oss,solaris,sndio,mmdevapi,dsound,winmm,port,opensl,null,wave
 113
 114 ## excludefx:
 115 #  Sets which effects to exclude, preventing apps from using them. This can
 116 #  help for apps that try to use effects which are too CPU intensive for the
 117 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator,
 118 #  dedicated
 119 #excludefx =
 120
 121 ## slots:
 122 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
 123 #  can use a non-negligible amount of CPU time if an effect is set on it even
 124 #  if no sources are feeding it, so this may help when apps use more than the
 125 #  system can handle.
 126 #slots = 4
 127
 128 ## sends:
 129 #  Sets the number of auxiliary sends per source. When not specified (default),
 130 #  it allows the app to request how many it wants. The maximum value currently
 131 #  possible is 4.
 132 #sends =
 133
 134 ## layout:
 135 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
 136 #  straight in front, negative goes left, and positive goes right. Unspecified
 137 #  speakers will remain at their default positions (which are dependant on the
 138 #  output format). Available speakers are back-left(bl), side-left(sl), front-
 139 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
 140 #  and back-center(bc).
 141 #layout =
 142
 143 ## layout_*:
 144 #  Channel-specific layouts may be specified to override the layout option. The
 145 #  same speakers as the layout option are available, and the default settings
 146 #  are shown below.
 147 #layout_STEREO = fl=-90, fr=90
 148 #layout_QUAD   = fl=-45, fr=45, bl=-135, br=135
 149 #layout_51CHN  = fl=-30, fr=30, fc=0, bl=-110, br=110
 150 #layout_61CHN  = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
 151 #layout_71CHN  = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
 152
 153 ## trap-alc-error:
 154 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
 155 #  that support it. This helps when debugging, while trying to find the cause
 156 #  of a device error. On Windows, a breakpoint exception is generated.
 157 #  Optionally, the __ALSOFT_TRAP_ALC_ERROR env var may be set before running
 158 #  the app instead.
 159 #trap-alc-error = false
 160
 161 ## trap-al-error:
 162 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
 163 #  that support it. This helps when debugging, while trying to find the cause
 164 #  of a context error. On Windows, a breakpoint exception is generated.
 165 #  Optionally, the __ALSOFT_TRAP_AL_ERROR env var may be set before running the
 166 #  app instead.
 167 #trap-al-error = false
 168
 169 ##
 170 ## Reverb effect stuff (includes EAX reverb)
 171 ##
 172 [reverb]
 173
 174 ## boost:
 175 #  A global amplification for reverb output, expressed in decibels. The value
 176 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
 177 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
 178 #  value of 0 means no change.
 179 #boost = 0
 180
 181 ## emulate-eax:
 182 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
 183 #  reverb processing is a bit more CPU intensive than standard, so this option
 184 #  allows a simpler effect to be used at the loss of some quality.
 185 #emulate-eax = false
 186
 187 ##
 188 ## ALSA backend stuff
 189 ##
 190 [alsa]
 191
 192 ## device:
 193 #  Sets the device name for the default playback device.
 194 #device = default
 195
 196 ## device-prefix:
 197 #  Sets the prefix used by the discovered (non-default) playback devices. This
 198 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
 199 #  device index for the requested device name.
 200 #device-prefix = plughw:
 201
 202 ## capture:
 203 #  Sets the device name for the default capture device.
 204 #capture = default
 205
 206 ## capture-prefix:
 207 #  Sets the prefix used by the discovered (non-default) capture devices. This
 208 #  will be appended with "CARD=c,DEV=d", where c is the card number and d is
 209 #  the device number for the requested device name.
 210 #capture-prefix = plughw:
 211
 212 ## mmap:
 213 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
 214 #  consumption). If mmap isn't available, it will automatically fall back to
 215 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
 216 #  and anything else will force mmap off.
 217 #mmap = true
 218
 219 ##
 220 ## OSS backend stuff
 221 ##
 222 [oss]
 223
 224 ## device:
 225 #  Sets the device name for OSS output.
 226 #device = /dev/dsp
 227
 228 ## capture:
 229 #  Sets the device name for OSS capture.
 230 #capture = /dev/dsp
 231
 232 ##
 233 ## Solaris backend stuff
 234 ##
 235 [solaris]
 236
 237 ## device:
 238 #  Sets the device name for Solaris output.
 239 #device = /dev/audio
 240
 241 ##
 242 ## MMDevApi backend stuff
 243 ##
 244 [mmdevapi]
 245
 246 ##
 247 ## DirectSound backend stuff
 248 ##
 249 [dsound]
 250
 251 ##
 252 ## Windows Multimedia backend stuff
 253 ##
 254 [winmm]
 255
 256 ##
 257 ## PortAudio backend stuff
 258 ##
 259 [port]
 260
 261 ## device:
 262 #  Sets the device index for output. Negative values will use the default as
 263 #  given by PortAudio itself.
 264 #device = -1
 265
 266 ## capture:
 267 #  Sets the device index for capture. Negative values will use the default as
 268 #  given by PortAudio itself.
 269 #capture = -1
 270
 271 ##
 272 ## PulseAudio backend stuff
 273 ##
 274 [pulse]
 275
 276 ## spawn-server:
 277 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
 278 #  device. Note that some apps may open and probe all enumerated devices on
 279 #  startup, causing a server to spawn even if a PulseAudio device is not
 280 #  actually selected. Setting autospawn to false in Pulse's client.conf will
 281 #  still prevent autospawning even if this is set to true.
 282 #spawn-server = false
 283
 284 ##
 285 ## Wave File Writer stuff
 286 ##
 287 [wave]
 288
 289 ## file:
 290 #  Sets the filename of the wave file to write to. An empty name prevents the
 291 #  backend from opening, even when explicitly requested.
 292 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
 293 #file =