Attempted fix for the coreaudio backend
[openal-soft.git] / alsoftrc.sample
blob110c443bfa30e3b7caf3512b699c860c9490cb57
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
9 # Option and block names are case-insenstive. The supplied values are only
10 # hints and may not be honored (though generally it'll try to get as close as
11 # possible). Note: options that are left unset may default to app- or system-
12 # specified values. These are the current available settings:
14 ## channels:
15 #  Sets the output channel configuration. If left unspecified, one will try to
16 #  be detected from the system, and defaulting to stereo. The available values
17 #  are: mono, stereo, quad, surround51, surround61, surround71
18 #channels = stereo
20 ## sample-type:
21 #  Sets the output sample type. Currently, all mixing is done with 32-bit float
22 #  and converted to the output sample type as needed. Available values are:
23 #  int8    - signed 8-bit int
24 #  uint8   - unsigned 8-bit int
25 #  int16   - signed 16-bit int
26 #  uint16  - unsigned 16-bit int
27 #  int32   - signed 32-bit int
28 #  uint32  - unsigned 32-bit int
29 #  float32 - 32-bit float
30 #sample-type = float32
32 ## hrtf:
33 #  Enables HRTF filters. These filters provide for better sound spatialization
34 #  while using headphones. The default filter will only work when output is
35 #  44100hz stereo. While HRTF is active, the cf_level option is disabled.
36 #  Default is disabled since stereo speaker output quality may suffer.
37 #hrtf = false
39 ## hrtf_tables
40 #  Specifies a comma-separated list of files containing HRTF data sets. The
41 #  listed data sets can be used in place of or in addiiton to the the built-in
42 #  set. The format of the files are described in hrtf.txt.
43 #hrtf_tables =
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
58 ## frequency:
59 #  Sets the output frequency.
60 #frequency = 44100
62 ## resampler:
63 #  Selects the resampler used when mixing sources. Valid values are:
64 #  point - nearest sample, no interpolation
65 #  linear - extrapolates samples using a linear slope between samples
66 #  cubic - extrapolates samples using a Catmull-Rom spline
67 #  Specifying other values will result in using the default (linear).
68 #resampler = linear
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
79 ## period_size:
80 #  Sets the update period size, in frames. This is the number of frames needed
81 #  for each mixing update. Acceptable values range between 64 and 8192.
82 #period_size = 1024
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. Acceptable values
88 #  range between 2 and 16.
89 #periods = 4
91 ## sources:
92 #  Sets the maximum number of allocatable sources. Lower values may help for
93 #  systems with apps that try to play more sounds than the CPU can handle.
94 #sources = 256
96 ## stereodup:
97 #  Sets whether to duplicate stereo sounds behind the listener. This provides a
98 #  "fuller" playback quality for surround sound output modes, although each
99 #  individual speaker will have a slight reduction in volume to compensate for
100 #  the extra output speakers. True, yes, on, and non-0 values will duplicate
101 #  stereo sources. 0 and anything else will cause stereo sounds to only play in
102 #  front. This only has an effect when a suitable output format is used (ie.
103 #  those that contain side and/or rear speakers).
104 #stereodup = true
106 ## drivers:
107 #  Sets the backend driver list order, comma-seperated. Unknown backends and
108 #  duplicated names are ignored. Unlisted backends won't be considered for use
109 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
110 #  followed by all other available backends, while 'oss' will list OSS only).
111 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
112 #  all available backends except OSS). An empty list means the default.
113 #drivers = pulse,alsa,core,oss,solaris,sndio,mmdevapi,dsound,winmm,port,opensl,null,wave
115 ## excludefx:
116 #  Sets which effects to exclude, preventing apps from using them. This can
117 #  help for apps that try to use effects which are too CPU intensive for the
118 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator,
119 #  dedicated
120 #excludefx =
122 ## slots:
123 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
124 #  can use a non-negligible amount of CPU time if an effect is set on it even
125 #  if no sources are feeding it, so this may help when apps use more than the
126 #  system can handle.
127 #slots = 4
129 ## sends:
130 #  Sets the number of auxiliary sends per source. When not specified (default),
131 #  it allows the app to request how many it wants. The maximum value currently
132 #  possible is 4.
133 #sends =
135 ## layout:
136 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
137 #  straight in front, negative goes left, and positive goes right. Unspecified
138 #  speakers will remain at their default positions (which are dependant on the
139 #  output format). Available speakers are back-left(bl), side-left(sl), front-
140 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
141 #  and back-center(bc).
142 #layout =
144 ## layout_*:
145 #  Channel-specific layouts may be specified to override the layout option. The
146 #  same speakers as the layout option are available, and the default settings
147 #  are shown below.
148 #layout_stereo     = fl=-30, fr=30
149 #layout_quad       = fl=-45, fr=45, bl=-135, br=135
150 #layout_surround51 = fl=-30, fr=30, fc=0, bl=-110, br=110
151 #layout_surround61 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
152 #layout_surround71 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
154 ## default-reverb:
155 #  A reverb preset that applies by default to all sources on send 0
156 #  (applications that set their own slots on send 0 will override this).
157 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
158 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
159 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
160 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
161 #default-reverb =
163 ## trap-alc-error:
164 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
165 #  that support it. This helps when debugging, while trying to find the cause
166 #  of a device error. On Windows, a breakpoint exception is generated.
167 #trap-alc-error = false
169 ## trap-al-error:
170 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
171 #  that support it. This helps when debugging, while trying to find the cause
172 #  of a context error. On Windows, a breakpoint exception is generated.
173 #trap-al-error = false
176 ## Reverb effect stuff (includes EAX reverb)
178 [reverb]
180 ## boost:
181 #  A global amplification for reverb output, expressed in decibels. The value
182 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
183 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
184 #  value of 0 means no change.
185 #boost = 0
187 ## emulate-eax:
188 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
189 #  reverb processing is a bit more CPU intensive than standard, so this option
190 #  allows a simpler effect to be used at the loss of some quality.
191 #emulate-eax = false
194 ## ALSA backend stuff
196 [alsa]
198 ## device:
199 #  Sets the device name for the default playback device.
200 #device = default
202 ## device-prefix:
203 #  Sets the prefix used by the discovered (non-default) playback devices. This
204 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
205 #  device index for the requested device name.
206 #device-prefix = plughw:
208 ## device-prefix-*:
209 #  Card- and device-specific prefixes may be used to override the device-prefix
210 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
211 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
212 #  case-sensitive.
213 #defice-prefix- =
215 ## capture:
216 #  Sets the device name for the default capture device.
217 #capture = default
219 ## capture-prefix:
220 #  Sets the prefix used by the discovered (non-default) capture devices. This
221 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
222 #  device number for the requested device name.
223 #capture-prefix = plughw:
225 ## capture-prefix-*:
226 #  Card- and device-specific prefixes may be used to override the
227 #  capture-prefix option. The option may specify the card id (eg,
228 #  capture-prefix-NVidia), or the card id and device index (eg,
229 #  capture-prefix-NVidia-0). The card id is case-sensitive.
230 #capture-prefix- =
232 ## mmap:
233 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
234 #  consumption). If mmap isn't available, it will automatically fall back to
235 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
236 #  and anything else will force mmap off.
237 #mmap = true
240 ## OSS backend stuff
242 [oss]
244 ## device:
245 #  Sets the device name for OSS output.
246 #device = /dev/dsp
248 ## capture:
249 #  Sets the device name for OSS capture.
250 #capture = /dev/dsp
253 ## Solaris backend stuff
255 [solaris]
257 ## device:
258 #  Sets the device name for Solaris output.
259 #device = /dev/audio
262 ## MMDevApi backend stuff
264 [mmdevapi]
267 ## DirectSound backend stuff
269 [dsound]
272 ## Windows Multimedia backend stuff
274 [winmm]
277 ## PortAudio backend stuff
279 [port]
281 ## device:
282 #  Sets the device index for output. Negative values will use the default as
283 #  given by PortAudio itself.
284 #device = -1
286 ## capture:
287 #  Sets the device index for capture. Negative values will use the default as
288 #  given by PortAudio itself.
289 #capture = -1
292 ## PulseAudio backend stuff
294 [pulse]
296 ## spawn-server:
297 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
298 #  device. Note that some apps may open and probe all enumerated devices on
299 #  startup, causing a server to spawn even if a PulseAudio device is not
300 #  actually selected. Setting autospawn to false in Pulse's client.conf will
301 #  still prevent autospawning even if this is set to true.
302 #spawn-server = false
305 ## Wave File Writer stuff
307 [wave]
309 ## file:
310 #  Sets the filename of the wave file to write to. An empty name prevents the
311 #  backend from opening, even when explicitly requested.
312 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
313 #file =