Returned pa_operations can be NULL
[openal-soft.git] / alsoftrc.sample
blob93a4823209a7aa39e23c6656679f7187de5cb80a
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 ## cf_level:
40 #  Sets the crossfeed level for stereo output. Valid values are:
41 #  0 - No crossfeed
42 #  1 - Low crossfeed
43 #  2 - Middle crossfeed
44 #  3 - High crossfeed (virtual speakers are closer to itself)
45 #  4 - Low easy crossfeed
46 #  5 - Middle easy crossfeed
47 #  6 - High easy crossfeed
48 #  Users of headphones may want to try various settings. Has no effect on non-
49 #  stereo modes.
50 #cf_level = 0
52 ## frequency:
53 #  Sets the output frequency.
54 #frequency = 44100
56 ## resampler:
57 #  Selects the resampler used when mixing sources. Valid values are:
58 #  point - nearest sample, no interpolation
59 #  linear - extrapolates samples using a linear slope between samples
60 #  cubic - extrapolates samples using a Catmull-Rom spline
61 #  Specifying other values will result in using the default (linear).
62 #resampler = linear
64 ## rt-prio:
65 #  Sets real-time priority for the mixing thread. Not all drivers may use this
66 #  (eg. PortAudio) as they already control the priority of the mixing thread.
67 #  0 and negative values will disable it. Note that this may constitute a
68 #  security risk since a real-time priority thread can indefinitely block
69 #  normal-priority threads if it fails to wait. As such, the default is
70 #  disabled.
71 #rt-prio = 0
73 ## period_size:
74 #  Sets the update period size, in frames. This is the number of frames needed
75 #  for each mixing update. Acceptable values range between 64 and 8192.
76 #period_size = 1024
78 ## periods:
79 #  Sets the number of update periods. Higher values create a larger mix ahead,
80 #  which helps protect against skips when the CPU is under load, but increases
81 #  the delay between a sound getting mixed and being heard. Acceptable values
82 #  range between 2 and 16.
83 #periods = 4
85 ## sources:
86 #  Sets the maximum number of allocatable sources. Lower values may help for
87 #  systems with apps that try to play more sounds than the CPU can handle.
88 #sources = 256
90 ## stereodup:
91 #  Sets whether to duplicate stereo sounds behind the listener. This provides a
92 #  "fuller" playback quality for surround sound output modes, although each
93 #  individual speaker will have a slight reduction in volume to compensate for
94 #  the extra output speakers. True, yes, on, and non-0 values will duplicate
95 #  stereo sources. 0 and anything else will cause stereo sounds to only play in
96 #  front. This only has an effect when a suitable output format is used (ie.
97 #  those that contain side and/or rear speakers).
98 #stereodup = true
100 ## drivers:
101 #  Sets the backend driver list order, comma-seperated. Unknown backends and
102 #  duplicated names are ignored. Unlisted backends won't be considered for use
103 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
104 #  followed by all other available backends, while 'oss' will list OSS only).
105 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
106 #  all available backends except OSS). An empty list means the default.
107 #drivers = pulse,alsa,core,oss,solaris,sndio,mmdevapi,dsound,winmm,port,opensl,null,wave
109 ## excludefx:
110 #  Sets which effects to exclude, preventing apps from using them. This can
111 #  help for apps that try to use effects which are too CPU intensive for the
112 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator,
113 #  dedicated
114 #excludefx =
116 ## slots:
117 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
118 #  can use a non-negligible amount of CPU time if an effect is set on it even
119 #  if no sources are feeding it, so this may help when apps use more than the
120 #  system can handle.
121 #slots = 4
123 ## sends:
124 #  Sets the number of auxiliary sends per source. When not specified (default),
125 #  it allows the app to request how many it wants. The maximum value currently
126 #  possible is 4.
127 #sends =
129 ## layout:
130 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
131 #  straight in front, negative goes left, and positive goes right. Unspecified
132 #  speakers will remain at their default positions (which are dependant on the
133 #  output format). Available speakers are back-left(bl), side-left(sl), front-
134 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
135 #  and back-center(bc).
136 #layout =
138 ## layout_*:
139 #  Channel-specific layouts may be specified to override the layout option. The
140 #  same speakers as the layout option are available, and the default settings
141 #  are shown below.
142 #layout_stereo     = fl=-30, fr=30
143 #layout_quad       = fl=-45, fr=45, bl=-135, br=135
144 #layout_surround51 = fl=-30, fr=30, fc=0, bl=-110, br=110
145 #layout_surround61 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
146 #layout_surround71 = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
148 ## default-reverb:
149 #  A reverb preset that applies by default to all sources on send 0
150 #  (applications that set their own slots on send 0 will override this).
151 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
152 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
153 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
154 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
155 #default-reverb =
157 ## trap-alc-error:
158 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
159 #  that support it. This helps when debugging, while trying to find the cause
160 #  of a device error. On Windows, a breakpoint exception is generated.
161 #trap-alc-error = false
163 ## trap-al-error:
164 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
165 #  that support it. This helps when debugging, while trying to find the cause
166 #  of a context error. On Windows, a breakpoint exception is generated.
167 #trap-al-error = false
170 ## Reverb effect stuff (includes EAX reverb)
172 [reverb]
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
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
188 ## ALSA backend stuff
190 [alsa]
192 ## device:
193 #  Sets the device name for the default playback device.
194 #device = default
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:
202 ## device-prefix-*:
203 #  Card- and device-specific prefixes may be used to override the device-prefix
204 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
205 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
206 #  case-sensitive.
207 #defice-prefix- =
209 ## capture:
210 #  Sets the device name for the default capture device.
211 #capture = default
213 ## capture-prefix:
214 #  Sets the prefix used by the discovered (non-default) capture devices. This
215 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
216 #  device number for the requested device name.
217 #capture-prefix = plughw:
219 ## capture-prefix-*:
220 #  Card- and device-specific prefixes may be used to override the
221 #  capture-prefix option. The option may specify the card id (eg,
222 #  capture-prefix-NVidia), or the card id and device index (eg,
223 #  capture-prefix-NVidia-0). The card id is case-sensitive.
224 #capture-prefix- =
226 ## mmap:
227 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
228 #  consumption). If mmap isn't available, it will automatically fall back to
229 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
230 #  and anything else will force mmap off.
231 #mmap = true
234 ## OSS backend stuff
236 [oss]
238 ## device:
239 #  Sets the device name for OSS output.
240 #device = /dev/dsp
242 ## capture:
243 #  Sets the device name for OSS capture.
244 #capture = /dev/dsp
247 ## Solaris backend stuff
249 [solaris]
251 ## device:
252 #  Sets the device name for Solaris output.
253 #device = /dev/audio
256 ## MMDevApi backend stuff
258 [mmdevapi]
261 ## DirectSound backend stuff
263 [dsound]
266 ## Windows Multimedia backend stuff
268 [winmm]
271 ## PortAudio backend stuff
273 [port]
275 ## device:
276 #  Sets the device index for output. Negative values will use the default as
277 #  given by PortAudio itself.
278 #device = -1
280 ## capture:
281 #  Sets the device index for capture. Negative values will use the default as
282 #  given by PortAudio itself.
283 #capture = -1
286 ## PulseAudio backend stuff
288 [pulse]
290 ## spawn-server:
291 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
292 #  device. Note that some apps may open and probe all enumerated devices on
293 #  startup, causing a server to spawn even if a PulseAudio device is not
294 #  actually selected. Setting autospawn to false in Pulse's client.conf will
295 #  still prevent autospawning even if this is set to true.
296 #spawn-server = false
299 ## Wave File Writer stuff
301 [wave]
303 ## file:
304 #  Sets the filename of the wave file to write to. An empty name prevents the
305 #  backend from opening, even when explicitly requested.
306 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
307 #file =