annotate alsoftrc.sample @ 0:f9476ff7637e

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