Don't check if the pulseaudio sink is suspended when opening
[openal-soft.git] / alsoftrc.sample
blobc7cdceb36f82a5cbdc5c3ce25e5d2ef88d80137f
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.
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.
82 #periods = 4
84 ## sources:
85 #  Sets the maximum number of allocatable sources. Lower values may help for
86 #  systems with apps that try to play more sounds than the CPU can handle.
87 #sources = 256
89 ## stereodup:
90 #  Sets whether to duplicate stereo sounds behind the listener. This provides a
91 #  "fuller" playback quality for surround sound output modes, although each
92 #  individual speaker will have a slight reduction in volume to compensate for
93 #  the extra output speakers. True, yes, on, and non-0 values will duplicate
94 #  stereo sources. 0 and anything else will cause stereo sounds to only play in
95 #  front. This only has an effect when a suitable output format is used (ie.
96 #  those that contain side and/or rear speakers).
97 #stereodup = true
99 ## drivers:
100 #  Sets the backend driver list order, comma-seperated. Unknown backends and
101 #  duplicated names are ignored. Unlisted backends won't be considered for use
102 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
103 #  followed by all other available backends, while 'oss' will list OSS only).
104 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
105 #  all available backends except OSS). An empty list means the default.
106 #drivers = pulse,alsa,core,oss,solaris,sndio,mmdevapi,dsound,winmm,port,opensl,null,wave
108 ## excludefx:
109 #  Sets which effects to exclude, preventing apps from using them. This can
110 #  help for apps that try to use effects which are too CPU intensive for the
111 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator,
112 #  dedicated
113 #excludefx =
115 ## slots:
116 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
117 #  can use a non-negligible amount of CPU time if an effect is set on it even
118 #  if no sources are feeding it, so this may help when apps use more than the
119 #  system can handle.
120 #slots = 4
122 ## sends:
123 #  Sets the number of auxiliary sends per source. When not specified (default),
124 #  it allows the app to request how many it wants. The maximum value currently
125 #  possible is 4.
126 #sends =
128 ## layout:
129 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
130 #  straight in front, negative goes left, and positive goes right. Unspecified
131 #  speakers will remain at their default positions (which are dependant on the
132 #  output format). Available speakers are back-left(bl), side-left(sl), front-
133 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
134 #  and back-center(bc).
135 #layout =
137 ## layout_*:
138 #  Channel-specific layouts may be specified to override the layout option. The
139 #  same speakers as the layout option are available, and the default settings
140 #  are shown below.
141 #layout_STEREO = fl=-30, fr=30
142 #layout_QUAD   = fl=-45, fr=45, bl=-135, br=135
143 #layout_51CHN  = fl=-30, fr=30, fc=0, bl=-110, br=110
144 #layout_61CHN  = fl=-30, fr=30, fc=0, sl=-90, sr=90, bc=180
145 #layout_71CHN  = fl=-30, fr=30, fc=0, sl=-90, sr=90, bl=-150, br=150
147 ## default-reverb:
148 #  A reverb preset that applies by default to all sources on send 0
149 #  (applications that set their own slots on send 0 will override this).
150 #  Available presets are: None, Generic, PaddedCell, Room, Bathroom,
151 #  Livingroom, Stoneroom, Auditorium, ConcertHall, Cave, Arena, Hangar,
152 #  CarpetedHallway, Hallway, StoneCorridor, Alley, Forest, City, Moutains,
153 #  Quarry, Plain, ParkingLot, SewerPipe, Underwater, Drugged, Dizzy, Psychotic.
154 #default-reverb =
156 ## trap-alc-error:
157 #  Generates a SIGTRAP signal when an ALC device error is generated, on systems
158 #  that support it. This helps when debugging, while trying to find the cause
159 #  of a device error. On Windows, a breakpoint exception is generated.
160 #trap-alc-error = false
162 ## trap-al-error:
163 #  Generates a SIGTRAP signal when an AL context error is generated, on systems
164 #  that support it. This helps when debugging, while trying to find the cause
165 #  of a context error. On Windows, a breakpoint exception is generated.
166 #trap-al-error = false
169 ## Reverb effect stuff (includes EAX reverb)
171 [reverb]
173 ## boost:
174 #  A global amplification for reverb output, expressed in decibels. The value
175 #  is logarithmic, so +6 will be a scale of (approximately) 2x, +12 will be a
176 #  scale of 4x, etc. Similarly, -6 will be about half, and -12 about 1/4th. A
177 #  value of 0 means no change.
178 #boost = 0
180 ## emulate-eax:
181 #  Allows the standard reverb effect to be used in place of EAX reverb. EAX
182 #  reverb processing is a bit more CPU intensive than standard, so this option
183 #  allows a simpler effect to be used at the loss of some quality.
184 #emulate-eax = false
187 ## ALSA backend stuff
189 [alsa]
191 ## device:
192 #  Sets the device name for the default playback device.
193 #device = default
195 ## device-prefix:
196 #  Sets the prefix used by the discovered (non-default) playback devices. This
197 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
198 #  device index for the requested device name.
199 #device-prefix = plughw:
201 ## device-prefix-*:
202 #  Card- and device-specific prefixes may be used to override the device-prefix
203 #  option. The option may specify the card id (eg, device-prefix-NVidia), or
204 #  the card id and device index (eg, device-prefix-NVidia-0). The card id is
205 #  case-sensitive.
206 #defice-prefix- =
208 ## capture:
209 #  Sets the device name for the default capture device.
210 #capture = default
212 ## capture-prefix:
213 #  Sets the prefix used by the discovered (non-default) capture devices. This
214 #  will be appended with "CARD=c,DEV=d", where c is the card id and d is the
215 #  device number for the requested device name.
216 #capture-prefix = plughw:
218 ## capture-prefix-*:
219 #  Card- and device-specific prefixes may be used to override the
220 #  capture-prefix option. The option may specify the card id (eg,
221 #  capture-prefix-NVidia), or the card id and device index (eg,
222 #  capture-prefix-NVidia-0). The card id is case-sensitive.
223 #capture-prefix- =
225 ## mmap:
226 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
227 #  consumption). If mmap isn't available, it will automatically fall back to
228 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
229 #  and anything else will force mmap off.
230 #mmap = true
233 ## OSS backend stuff
235 [oss]
237 ## device:
238 #  Sets the device name for OSS output.
239 #device = /dev/dsp
241 ## capture:
242 #  Sets the device name for OSS capture.
243 #capture = /dev/dsp
246 ## Solaris backend stuff
248 [solaris]
250 ## device:
251 #  Sets the device name for Solaris output.
252 #device = /dev/audio
255 ## MMDevApi backend stuff
257 [mmdevapi]
260 ## DirectSound backend stuff
262 [dsound]
265 ## Windows Multimedia backend stuff
267 [winmm]
270 ## PortAudio backend stuff
272 [port]
274 ## device:
275 #  Sets the device index for output. Negative values will use the default as
276 #  given by PortAudio itself.
277 #device = -1
279 ## capture:
280 #  Sets the device index for capture. Negative values will use the default as
281 #  given by PortAudio itself.
282 #capture = -1
285 ## PulseAudio backend stuff
287 [pulse]
289 ## spawn-server:
290 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
291 #  device. Note that some apps may open and probe all enumerated devices on
292 #  startup, causing a server to spawn even if a PulseAudio device is not
293 #  actually selected. Setting autospawn to false in Pulse's client.conf will
294 #  still prevent autospawning even if this is set to true.
295 #spawn-server = false
298 ## Wave File Writer stuff
300 [wave]
302 ## file:
303 #  Sets the filename of the wave file to write to. An empty name prevents the
304 #  backend from opening, even when explicitly requested.
305 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
306 #file =