Fix a typo
[openal-soft.git] / alsoftrc.sample
blobbcfbe5e2d57680bda108fdfe79203288967422ce
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 ## disable-cpu-exts:
15 #  Disables use of the listed CPU extensions. Certain methods may utilize CPU
16 #  extensions when detected, and this option is useful for preventing those
17 #  extensions from being used. The available extensions are: neon. Specifying
18 #  'all' disables use of all extensions.
19 #disable-cpu-exts =
21 ## channels:
22 #  Sets the output channel configuration. If left unspecified, one will try to
23 #  be detected from the system, and defaulting to stereo. The available values
24 #  are: mono, stereo, quad, surround51, surround61, surround71
25 #channels = stereo
27 ## sample-type:
28 #  Sets the output sample type. Currently, all mixing is done with 32-bit float
29 #  and converted to the output sample type as needed. Available values are:
30 #  int8    - signed 8-bit int
31 #  uint8   - unsigned 8-bit int
32 #  int16   - signed 16-bit int
33 #  uint16  - unsigned 16-bit int
34 #  int32   - signed 32-bit int
35 #  uint32  - unsigned 32-bit int
36 #  float32 - 32-bit float
37 #sample-type = float32
39 ## hrtf:
40 #  Enables HRTF filters. These filters provide for better sound spatialization
41 #  while using headphones. The default filter will only work when output is
42 #  44100hz stereo. While HRTF is active, the cf_level option is disabled.
43 #  Default is disabled since stereo speaker output quality may suffer.
44 #hrtf = false
46 ## hrtf_tables
47 #  Specifies a comma-separated list of files containing HRTF data sets. The
48 #  listed data sets can be used in place of or in addiiton to the the built-in
49 #  set. The format of the files are described in hrtf.txt.
50 #hrtf_tables =
52 ## cf_level:
53 #  Sets the crossfeed level for stereo output. Valid values are:
54 #  0 - No crossfeed
55 #  1 - Low crossfeed
56 #  2 - Middle crossfeed
57 #  3 - High crossfeed (virtual speakers are closer to itself)
58 #  4 - Low easy crossfeed
59 #  5 - Middle easy crossfeed
60 #  6 - High easy crossfeed
61 #  Users of headphones may want to try various settings. Has no effect on non-
62 #  stereo modes.
63 #cf_level = 0
65 ## wide-stereo:
66 #  Specifies that stereo sources are given a width of about 120 degrees on each
67 #  channel, centering on -90 (left) and +90 (right), as opposed to being points
68 #  placed at -30 (left) and +30 (right). This can be useful for surround-sound
69 #  to give stereo sources a more encompassing sound. Note that the sound's
70 #  overall volume will be slightly reduced to account for the extra output.
71 #wide-stereo = false
73 ## frequency:
74 #  Sets the output frequency.
75 #frequency = 44100
77 ## resampler:
78 #  Selects the resampler used when mixing sources. Valid values are:
79 #  point - nearest sample, no interpolation
80 #  linear - extrapolates samples using a linear slope between samples
81 #  cubic - extrapolates samples using a Catmull-Rom spline
82 #  Specifying other values will result in using the default (linear).
83 #resampler = linear
85 ## rt-prio:
86 #  Sets real-time priority for the mixing thread. Not all drivers may use this
87 #  (eg. PortAudio) as they already control the priority of the mixing thread.
88 #  0 and negative values will disable it. Note that this may constitute a
89 #  security risk since a real-time priority thread can indefinitely block
90 #  normal-priority threads if it fails to wait. As such, the default is
91 #  disabled.
92 #rt-prio = 0
94 ## period_size:
95 #  Sets the update period size, in frames. This is the number of frames needed
96 #  for each mixing update. Acceptable values range between 64 and 8192.
97 #period_size = 1024
99 ## periods:
100 #  Sets the number of update periods. Higher values create a larger mix ahead,
101 #  which helps protect against skips when the CPU is under load, but increases
102 #  the delay between a sound getting mixed and being heard. Acceptable values
103 #  range between 2 and 16.
104 #periods = 4
106 ## sources:
107 #  Sets the maximum number of allocatable sources. Lower values may help for
108 #  systems with apps that try to play more sounds than the CPU can handle.
109 #sources = 256
111 ## drivers:
112 #  Sets the backend driver list order, comma-seperated. Unknown backends and
113 #  duplicated names are ignored. Unlisted backends won't be considered for use
114 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
115 #  followed by all other available backends, while 'oss' will list OSS only).
116 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
117 #  all available backends except OSS). An empty list means the default.
118 #drivers = pulse,alsa,core,oss,solaris,sndio,mmdevapi,dsound,winmm,port,opensl,null,wave
120 ## excludefx:
121 #  Sets which effects to exclude, preventing apps from using them. This can
122 #  help for apps that try to use effects which are too CPU intensive for the
123 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator,
124 #  dedicated
125 #excludefx =
127 ## slots:
128 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
129 #  can use a non-negligible amount of CPU time if an effect is set on it even
130 #  if no sources are feeding it, so this may help when apps use more than the
131 #  system can handle.
132 #slots = 4
134 ## sends:
135 #  Sets the number of auxiliary sends per source. When not specified (default),
136 #  it allows the app to request how many it wants. The maximum value currently
137 #  possible is 4.
138 #sends =
140 ## layout:
141 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
142 #  straight in front, negative goes left, and positive goes right. Unspecified
143 #  speakers will remain at their default positions (which are dependant on the
144 #  output format). Available speakers are back-left(bl), side-left(sl), front-
145 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
146 #  and back-center(bc).
147 #layout =
149 ## layout_*:
150 #  Channel-specific layouts may be specified to override the layout option. The
151 #  same speakers as the layout option are available, and the default settings
152 #  are shown below.
153 #layout_stereo     = fl=-90, fr=90
154 #layout_quad       = fl=-45, fr=45, bl=-135, br=135
155 #layout_surround51 = fl=-30, fr=30, fc=0, bl=-110, br=110
156 #layout_surround61 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
157 #layout_surround71 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
159 ## default-reverb:
160 #  A reverb preset that applies by default to all sources on send 0
161 #  (applications that set their own slots on send 0 will override this).
162 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
163 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
164 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
165 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
166 #default-reverb =
168 ## trap-alc-error:
169 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
170 #  that support it. This helps when debugging, while trying to find the cause
171 #  of a device error. On Windows, a breakpoint exception is generated.
172 #trap-alc-error = false
174 ## trap-al-error:
175 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
176 #  that support it. This helps when debugging, while trying to find the cause
177 #  of a context error. On Windows, a breakpoint exception is generated.
178 #trap-al-error = false
181 ## Reverb effect stuff (includes EAX reverb)
183 [reverb]
185 ## boost:
186 #  A global amplification for reverb output, expressed in decibels. The value
187 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
188 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
189 #  value of 0 means no change.
190 #boost = 0
192 ## emulate-eax:
193 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
194 #  reverb processing is a bit more CPU intensive than standard, so this option
195 #  allows a simpler effect to be used at the loss of some quality.
196 #emulate-eax = false
199 ## ALSA backend stuff
201 [alsa]
203 ## device:
204 #  Sets the device name for the default playback device.
205 #device = default
207 ## device-prefix:
208 #  Sets the prefix used by the discovered (non-default) playback devices. This
209 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
210 #  device index for the requested device name.
211 #device-prefix = plughw:
213 ## device-prefix-*:
214 #  Card- and device-specific prefixes may be used to override the device-prefix
215 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
216 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
217 #  case-sensitive.
218 #device-prefix- =
220 ## capture:
221 #  Sets the device name for the default capture device.
222 #capture = default
224 ## capture-prefix:
225 #  Sets the prefix used by the discovered (non-default) capture devices. This
226 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
227 #  device number for the requested device name.
228 #capture-prefix = plughw:
230 ## capture-prefix-*:
231 #  Card- and device-specific prefixes may be used to override the
232 #  capture-prefix option. The option may specify the card id (eg,
233 #  capture-prefix-NVidia), or the card id and device index (eg,
234 #  capture-prefix-NVidia-0). The card id is case-sensitive.
235 #capture-prefix- =
237 ## mmap:
238 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
239 #  consumption). If mmap isn't available, it will automatically fall back to
240 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
241 #  and anything else will force mmap off.
242 #mmap = true
245 ## OSS backend stuff
247 [oss]
249 ## device:
250 #  Sets the device name for OSS output.
251 #device = /dev/dsp
253 ## capture:
254 #  Sets the device name for OSS capture.
255 #capture = /dev/dsp
258 ## Solaris backend stuff
260 [solaris]
262 ## device:
263 #  Sets the device name for Solaris output.
264 #device = /dev/audio
267 ## MMDevApi backend stuff
269 [mmdevapi]
272 ## DirectSound backend stuff
274 [dsound]
277 ## Windows Multimedia backend stuff
279 [winmm]
282 ## PortAudio backend stuff
284 [port]
286 ## device:
287 #  Sets the device index for output. Negative values will use the default as
288 #  given by PortAudio itself.
289 #device = -1
291 ## capture:
292 #  Sets the device index for capture. Negative values will use the default as
293 #  given by PortAudio itself.
294 #capture = -1
297 ## PulseAudio backend stuff
299 [pulse]
301 ## spawn-server:
302 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
303 #  device. Setting autospawn to false in PulseAudio's client.conf will still
304 #  prevent autospawning even if this is set to true.
305 #spawn-server = true
307 ## allow-moves:
308 #  Allows PulseAudio to move active streams to different devices. Note that the
309 #  device specifier seen by applications will not be updated when this occurs,
310 #  and neither will the AL device configuration (sample rate, format, etc).
311 #allow-moves = false
314 ## Wave File Writer stuff
316 [wave]
318 ## file:
319 #  Sets the filename of the wave file to write to. An empty name prevents the
320 #  backend from opening, even when explicitly requested.
321 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
322 #file =