Add an al_string type and use it for the device lists
[openal-soft.git] / alsoftrc.sample
blobaa1d1d9c32ff335b322ef74bf157051fdd214b5a
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 # The system-wide settings can be put in /etc/openal/alsoft.conf and user-
12 # specific override settings in $HOME/.alsoftrc.
13 # For Windows, these settings should go into $AppData\alsoft.ini
15 # Option and block names are case-insenstive. The supplied values are only
16 # hints and may not be honored (though generally it'll try to get as close as
17 # possible). Note: options that are left unset may default to app- or system-
18 # specified values. These are the current available settings:
21 ## General stuff
23 [general]
25 ## disable-cpu-exts:
26 #  Disables use of the listed CPU extensions. Certain methods may utilize CPU
27 #  extensions when detected, and this option is useful for preventing those
28 #  extensions from being used. The available extensions are: sse, sse2, neon.
29 #  Specifying 'all' disables use of all extensions.
30 #disable-cpu-exts =
32 ## channels:
33 #  Sets the output channel configuration. If left unspecified, one will try to
34 #  be detected from the system, and defaulting to stereo. The available values
35 #  are: mono, stereo, quad, surround51, surround61, surround71
36 #channels =
38 ## sample-type:
39 #  Sets the output sample type. Currently, all mixing is done with 32-bit float
40 #  and converted to the output sample type as needed. Available values are:
41 #  int8    - signed 8-bit int
42 #  uint8   - unsigned 8-bit int
43 #  int16   - signed 16-bit int
44 #  uint16  - unsigned 16-bit int
45 #  int32   - signed 32-bit int
46 #  uint32  - unsigned 32-bit int
47 #  float32 - 32-bit float
48 #sample-type = float32
50 ## hrtf:
51 #  Enables HRTF filters. These filters provide for better sound spatialization
52 #  while using headphones. The default filter will only work when output is
53 #  44100hz stereo. While HRTF is active, the cf_level option is disabled.
54 #  Default is disabled since stereo speaker output quality may suffer.
55 #hrtf = false
57 ## hrtf_tables
58 #  Specifies a comma-separated list of files containing HRTF data sets. The
59 #  format of the files are described in hrtf.txt. The filenames may contain
60 #  these markers, which will be replaced as needed:
61 #  %r - Device sampling rate
62 #  %% - Percent sign (%)
63 #  The listed files are relative to system-dependant data directories. On
64 #  Windows this is:
65 #  $AppData\openal\hrtf
66 #  And on other systems, it's (in order):
67 #  $XDG_DATA_HOME/openal/hrtf  (defaults to $HOME/.local/share/openal/hrtf)
68 #  $XDG_DATA_DIRS/openal/hrtf  (defaults to /usr/local/share/openal/hrtf and
69 #                               /usr/share/openal/hrtf)
70 #  An absolute path may also be specified, if the given file is elsewhere.
71 #hrtf_tables = default-%r.mhr
73 ## cf_level:
74 #  Sets the crossfeed level for stereo output. Valid values are:
75 #  0 - No crossfeed
76 #  1 - Low crossfeed
77 #  2 - Middle crossfeed
78 #  3 - High crossfeed (virtual speakers are closer to itself)
79 #  4 - Low easy crossfeed
80 #  5 - Middle easy crossfeed
81 #  6 - High easy crossfeed
82 #  Users of headphones may want to try various settings. Has no effect on non-
83 #  stereo modes.
84 #cf_level = 0
86 ## wide-stereo:
87 #  Specifies that stereo sources are given a width of about 120 degrees on each
88 #  channel, centering on -90 (left) and +90 (right), as opposed to being points
89 #  placed at -30 (left) and +30 (right). This can be useful for surround-sound
90 #  to give stereo sources a more encompassing sound. Note that the sound's
91 #  overall volume will be slightly reduced to account for the extra output.
92 #wide-stereo = false
94 ## frequency:
95 #  Sets the output frequency. If left unspecified it will try to detect a
96 #  default from the system, otherwise it will default to 44100.
97 #frequency =
99 ## resampler:
100 #  Selects the resampler used when mixing sources. Valid values are:
101 #  point - nearest sample, no interpolation
102 #  linear - extrapolates samples using a linear slope between samples
103 #  cubic - extrapolates samples using a Catmull-Rom spline
104 #  Specifying other values will result in using the default (linear).
105 #resampler = linear
107 ## rt-prio:
108 #  Sets real-time priority for the mixing thread. Not all drivers may use this
109 #  (eg. PortAudio) as they already control the priority of the mixing thread.
110 #  0 and negative values will disable it. Note that this may constitute a
111 #  security risk since a real-time priority thread can indefinitely block
112 #  normal-priority threads if it fails to wait. As such, the default is
113 #  disabled.
114 #rt-prio = 0
116 ## period_size:
117 #  Sets the update period size, in frames. This is the number of frames needed
118 #  for each mixing update. Acceptable values range between 64 and 8192.
119 #period_size = 1024
121 ## periods:
122 #  Sets the number of update periods. Higher values create a larger mix ahead,
123 #  which helps protect against skips when the CPU is under load, but increases
124 #  the delay between a sound getting mixed and being heard. Acceptable values
125 #  range between 2 and 16.
126 #periods = 4
128 ## sources:
129 #  Sets the maximum number of allocatable sources. Lower values may help for
130 #  systems with apps that try to play more sounds than the CPU can handle.
131 #sources = 256
133 ## drivers:
134 #  Sets the backend driver list order, comma-seperated. Unknown backends and
135 #  duplicated names are ignored. Unlisted backends won't be considered for use
136 #  unless the list is ended with a comma (e.g. 'oss,' will try OSS first before
137 #  other backends, while 'oss' will try OSS only). Backends prepended with -
138 #  won't be considered for use (e.g. '-oss,' will try all available backends
139 #  except OSS). An empty list means to try all backends.
140 #drivers =
142 ## excludefx:
143 #  Sets which effects to exclude, preventing apps from using them. This can
144 #  help for apps that try to use effects which are too CPU intensive for the
145 #  system to handle. Available effects are: eaxreverb,reverb,autowah,chorus,
146 #  compressor,distortion,echo,equalizer,flanger,modulator,dedicated
147 #excludefx =
149 ## slots:
150 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
151 #  can use a non-negligible amount of CPU time if an effect is set on it even
152 #  if no sources are feeding it, so this may help when apps use more than the
153 #  system can handle.
154 #slots = 4
156 ## sends:
157 #  Sets the number of auxiliary sends per source. When not specified (default),
158 #  it allows the app to request how many it wants. The maximum value currently
159 #  possible is 4.
160 #sends =
162 ## layout:
163 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
164 #  straight in front, negative goes left, and positive goes right. Unspecified
165 #  speakers will remain at their default positions (which are dependant on the
166 #  output format). Available speakers are back-left(bl), side-left(sl), front-
167 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
168 #  and back-center(bc).
169 #layout =
171 ## layout_*:
172 #  Channel-specific layouts may be specified to override the layout option. The
173 #  same speakers as the layout option are available, and the default settings
174 #  are shown below.
175 #layout_stereo     = fl=-90, fr=90
176 #layout_quad       = fl=-45, fr=45, bl=-135, br=135
177 #layout_surround51 = fl=-30, fr=30, fc=0, bl=-110, br=110
178 #layout_surround61 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
179 #layout_surround71 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
181 ## default-reverb:
182 #  A reverb preset that applies by default to all sources on send 0
183 #  (applications that set their own slots on send 0 will override this).
184 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
185 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
186 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
187 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
188 #default-reverb =
190 ## trap-alc-error:
191 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
192 #  that support it. This helps when debugging, while trying to find the cause
193 #  of a device error. On Windows, a breakpoint exception is generated.
194 #trap-alc-error = false
196 ## trap-al-error:
197 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
198 #  that support it. This helps when debugging, while trying to find the cause
199 #  of a context error. On Windows, a breakpoint exception is generated.
200 #trap-al-error = false
203 ## MIDI stuff (EXPERIMENTAL)
205 [midi]
207 ## soundfont:
208 #  A default soundfont (sf2 format). Used when an app requests the system
209 #  default. The listed file is relative to system-dependant data directories.
210 #  On Windows this is:
211 #  $AppData\openal\soundfonts
212 #  And on other systems, it's (in order):
213 #  $XDG_DATA_HOME/openal/soundfonts
214 #  $XDG_DATA_DIRS/openal/soundfonts
215 #  An absolute path may also be specified, if the given file is elsewhere.
216 #soundfont =
218 ## volume:
219 #  Additional attenuation applied to MIDI output, expressed in decibels. This
220 #  is used to help keep the mix from clipping, and so must be 0 or less. The
221 #  value is logarithmic, so -6 will be about half amplitude, and -12 about
222 #  1/4th. The default is roughly -13.9794 (0.2, or 1/5th).
223 #volume =
226 ## Reverb effect stuff (includes EAX reverb)
228 [reverb]
230 ## boost:
231 #  A global amplification for reverb output, expressed in decibels. The value
232 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
233 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
234 #  value of 0 means no change.
235 #boost = 0
237 ## emulate-eax:
238 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
239 #  reverb processing is a bit more CPU intensive than standard, so this option
240 #  allows a simpler effect to be used at the loss of some quality.
241 #emulate-eax = false
244 ## PulseAudio backend stuff
246 [pulse]
248 ## spawn-server:
249 #  Attempts to autospawn a PulseAudio server whenever needed (initializing the
250 #  backend, enumerating devices, etc). Setting autospawn to false in Pulse's
251 #  client.conf will still prevent autospawning even if this is set to true.
252 #spawn-server = true
254 ## allow-moves:
255 #  Allows PulseAudio to move active streams to different devices. Note that the
256 #  device specifier (seen by applications) will not be updated when this
257 #  occurs, and neither will the AL device configuration (sample rate, format,
258 #  etc).
259 #allow-moves = false
262 ## ALSA backend stuff
264 [alsa]
266 ## device:
267 #  Sets the device name for the default playback device.
268 #device = default
270 ## device-prefix:
271 #  Sets the prefix used by the discovered (non-default) playback devices. This
272 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
273 #  device index for the requested device name.
274 #device-prefix = plughw:
276 ## device-prefix-*:
277 #  Card- and device-specific prefixes may be used to override the device-prefix
278 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
279 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
280 #  case-sensitive.
281 #device-prefix- =
283 ## capture:
284 #  Sets the device name for the default capture device.
285 #capture = default
287 ## capture-prefix:
288 #  Sets the prefix used by the discovered (non-default) capture devices. This
289 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
290 #  device number for the requested device name.
291 #capture-prefix = plughw:
293 ## capture-prefix-*:
294 #  Card- and device-specific prefixes may be used to override the
295 #  capture-prefix option. The option may specify the card id (eg,
296 #  capture-prefix-NVidia), or the card id and device index (eg,
297 #  capture-prefix-NVidia-0). The card id is case-sensitive.
298 #capture-prefix- =
300 ## mmap:
301 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
302 #  consumption). If mmap isn't available, it will automatically fall back to
303 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
304 #  and anything else will force mmap off.
305 #mmap = true
308 ## OSS backend stuff
310 [oss]
312 ## device:
313 #  Sets the device name for OSS output.
314 #device = /dev/dsp
316 ## capture:
317 #  Sets the device name for OSS capture.
318 #capture = /dev/dsp
321 ## Solaris backend stuff
323 [solaris]
325 ## device:
326 #  Sets the device name for Solaris output.
327 #device = /dev/audio
330 ## QSA backend stuff
332 [qsa]
334 ## device:
335 #  Sets the device name for the default playback device.
336 #device = default
338 ## capture:
339 #  Sets the device name for the default capture device.
340 #capture = default
343 ## MMDevApi backend stuff
345 [mmdevapi]
348 ## DirectSound backend stuff
350 [dsound]
353 ## Windows Multimedia backend stuff
355 [winmm]
358 ## PortAudio backend stuff
360 [port]
362 ## device:
363 #  Sets the device index for output. Negative values will use the default as
364 #  given by PortAudio itself.
365 #device = -1
367 ## capture:
368 #  Sets the device index for capture. Negative values will use the default as
369 #  given by PortAudio itself.
370 #capture = -1
373 ## Wave File Writer stuff
375 [wave]
377 ## file:
378 #  Sets the filename of the wave file to write to. An empty name prevents the
379 #  backend from opening, even when explicitly requested.
380 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
381 #file =