Minor rework of the template macros
[openal-soft.git] / alsoftrc.sample
blobdacaf0d72d3a31dc3fc5cc697d13f0f0e526441c
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
8 # The environment variable ALSOFT_CONF can be used to specify another config
9 # override
11 # Option and block names are case-insenstive. The supplied values are only
12 # hints and may not be honored (though generally it'll try to get as close as
13 # possible). Note: options that are left unset may default to app- or system-
14 # specified values. These are the current available settings:
16 ## format:
17 #  Sets the output format. Can be one of:
18 #  AL_FORMAT_MONO8    (8-bit mono)
19 #  AL_FORMAT_STEREO8  (8-bit stereo)
20 #  AL_FORMAT_QUAD8    (8-bit 4-channel)
21 #  AL_FORMAT_51CHN8   (8-bit 5.1 output)
22 #  AL_FORMAT_61CHN8   (8-bit 6.1 output)
23 #  AL_FORMAT_71CHN8   (8-bit 7.1 output)
24 #  AL_FORMAT_MONO16   (16-bit mono)
25 #  AL_FORMAT_STEREO16 (16-bit stereo)
26 #  AL_FORMAT_QUAD16   (16-bit 4-channel)
27 #  AL_FORMAT_51CHN16  (16-bit 5.1 output)
28 #  AL_FORMAT_61CHN16  (16-bit 6.1 output)
29 #  AL_FORMAT_71CHN16  (16-bit 7.1 output)
30 #  AL_FORMAT_MONO32   (32-bit float mono)
31 #  AL_FORMAT_STEREO32 (32-bit float stereo)
32 #  AL_FORMAT_QUAD32   (32-bit float 4-channel)
33 #  AL_FORMAT_51CHN32  (32-bit float 5.1 output)
34 #  AL_FORMAT_61CHN32  (32-bit float 6.1 output)
35 #  AL_FORMAT_71CHN32  (32-bit float 7.1 output)
36 #format = AL_FORMAT_STEREO16
38 ## cf_level:
39 #  Sets the crossfeed level for stereo output. Valid values are:
40 #  0 - No crossfeed
41 #  1 - Low crossfeed
42 #  2 - Middle crossfeed
43 #  3 - High crossfeed (virtual speakers are closer to itself)
44 #  4 - Low easy crossfeed
45 #  5 - Middle easy crossfeed
46 #  6 - High easy crossfeed
47 #  Users of headphones may want to try various settings. Has no effect on non-
48 #  stereo modes.
49 #cf_level = 0
51 ## head_dampen:
52 #  Sets the amount of dampening on sounds emanating from behind the listener.
53 #  This is used to simulate the natural occlusion of the head, which is
54 #  typically missing with mono and stereo output, and as such, only works on
55 #  mono and stereo output modes. Valid values range from 0 to 1 (inclusive),
56 #  and higher values provide a stronger effect.
57 #head_dampen = 0.25
59 ## frequency:
60 #  Sets the output frequency.
61 #frequency = 44100
63 ## resampler:
64 #  Selects the resampler used when mixing sources. Valid values are:
65 #  0 - None (nearest sample, no interpolation)
66 #  1 - Linear (extrapolates samples using a linear slope between samples)
67 #  Specifying other values will result in using the default (linear).
68 #resampler = 1
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.
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.
88 #periods = 4
90 ## sources:
91 #  Sets the maximum number of allocatable sources. Lower values may help for
92 #  systems with apps that try to play more sounds than the CPU can handle.
93 #sources = 256
95 ## stereodup:
96 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
97 #  channel output. This provides a "fuller" playback quality for 4+ channel
98 #  output modes, although each individual speaker will have a slight reduction
99 #  in volume to compensate for the extra output speakers. True, yes, on, and
100 #  non-0 values will duplicate stereo sources. 0 and anything else will cause
101 #  stereo sounds to only play out the front speakers. This only has an effect
102 #  when a suitable output format is used (ie. those that contain side and/or
103 #  rear speakers).
104 #stereodup = true
106 ## scalemix:
107 #  Sets whether to scale the remixed output. When the final mix is written to
108 #  the device, the multi-channel data is remixed so pure-virtual channels (eg.
109 #  front-center on stereo output) are remixed and added to available channels
110 #  (eg. front-left and front-right). Scaling helps ensure that no single source
111 #  will put out more than 100% on a given physical channel. This can cause a
112 #  noticeable reduction in overall volume, however, so it is off by default.
113 #scalemix = false
115 ## drivers:
116 #  Sets the backend driver list order, comma-seperated. Unknown backends and
117 #  duplicated names are ignored. Unlisted backends won't be considered for use
118 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
119 #  followed by all other available backends, while 'oss' will list OSS only).
120 #  Backends prepended with - won't be available for use (eg. '-oss,' will allow
121 #  all available backends except OSS). An empty list means the default.
122 #drivers = pulse,alsa,oss,solaris,dsound,winmm,port,null,wave
124 ## excludefx:
125 #  Sets which effects to exclude, preventing apps from using them. This can
126 #  help for apps that try to use effects which are too CPU intensive for the
127 #  system to handle. Available effects are: eaxreverb,reverb,echo,modulator
128 #excludefx =
130 ## slots:
131 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
132 #  can use a non-negligible amount of CPU time if an effect is set on it even
133 #  if no sources are feeding it, so this may help when apps use more than the
134 #  system can handle.
135 #slots = 4
137 ## sends:
138 #  Sets the number of auxiliary sends per source. When not specified (default),
139 #  it allows the app to request how many it wants. The maximum value currently
140 #  possible is 4.
141 #sends =
143 ## layout:
144 #  Sets the virtual speaker layout. Values are specified in degrees, where 0 is
145 #  straight in front, negative goes left, and positive goes right. Unspecified
146 #  speakers will remain at their default positions (which are dependant on the
147 #  output format). Available speakers are back-left(bl), side-left(sl), front-
148 #  left(fl), front-center(fc), front-right(fr), side-right(sr), back-right(br),
149 #  and back-center(bc).
150 #layout =
153 ## ALSA backend stuff
155 [alsa]
157 ## device:
158 #  Sets the device name for the default playback device.
159 #device = default
161 ## capture:
162 #  Sets the device name for the default capture device.
163 #capture = default
165 ## mmap:
166 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
167 #  consumption). If mmap isn't available, it will automatically fall back to
168 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
169 #  and anything else will force mmap off.
170 #mmap = true
173 ## OSS backend stuff
175 [oss]
177 ## device:
178 #  Sets the device name for OSS output.
179 #device = /dev/dsp
181 ## capture:
182 #  Sets the device name for OSS capture.
183 #capture = /dev/dsp
186 ## Solaris backend stuff
188 [solaris]
190 ## device:
191 #  Sets the device name for Solaris output.
192 #device = /dev/audio
195 ## DirectSound backend stuff
197 [dsound]
200 ## Windows Multimedia backend stuff
202 [winmm]
205 ## PortAudio backend stuff
207 [port]
209 ## device:
210 #  Sets the device index for output. Negative values will use the default as
211 #  given by PortAudio itself.
212 #device = -1
214 ## capture:
215 #  Sets the device index for capture. Negative values will use the default as
216 #  given by PortAudio itself.
217 #capture = -1
220 ## PulseAudio backend stuff
222 [pulse]
224 ## spawn-server:
225 #  Attempts to spawn a PulseAudio server when requesting to open a PulseAudio
226 #  device. Note that some apps may open and probe all enumerated devices on
227 #  startup, causing a server to spawn even if a PulseAudio device is not
228 #  actually selected. Setting autospawn to false in Pulse's client.conf will
229 #  still prevent autospawning even if this is set to true.
230 #spawn-server = false
233 ## Wave File Writer stuff
235 [wave]
237 ## file:
238 #  Sets the filename of the wave file to write to. An empty name prevents the
239 #  backend from opening, even when explicitly requested.
240 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
241 #file =