Update the drivers config file comment
[openal-soft.git] / alsoftrc.sample
blobb3882598c6afe3339b8dc9c5b72379fbc9ce028f
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 ## frequency:
52 #  Sets the output frequency.
53 #frequency = 44100
55 ## period_size:
56 #  Sets the update period size, in frames. This is the number of frames needed
57 #  for each mixing update. If the deprecated 'refresh' option is specified and
58 #  this isn't, the value will be calculated as size = refresh/periods.
59 #period_size = 1024
61 ## periods:
62 #  Sets the number of update periods. Higher values create a larger mix ahead,
63 #  which helps protect against skips when the CPU is under load, but increases
64 #  the delay between a sound getting mixed and being heard.
65 #periods = 4
67 ## sources:
68 #  Sets the maximum number of allocatable sources. Lower values may help for
69 #  systems with apps that try to play more sounds than the CPU can handle.
70 #sources = 256
72 ## stereodup:
73 #  Sets whether to duplicate stereo sounds on the rear and side speakers for 4+
74 #  channel output. This can make stereo sources substantially louder than mono
75 #  or even 4+ channel sources, but provides a "fuller" playback quality. True,
76 #  yes, on, and non-0 values will duplicate stereo sources. 0 and anything else
77 #  will cause stereo sounds to only play out the front speakers.
78 #stereodup = false
80 ## drivers:
81 #  Sets the backend driver list order, comma-seperated. Unknown backends and
82 #  duplicated names are ignored. Unlisted backends won't be considered for use
83 #  unless the list is ended with a comma (eg. 'oss,' will list OSS first
84 #  followed by all other available backends, while 'oss' will list OSS only).
85 #  An empty list means the default.
86 #drivers = alsa,oss,solaris,dsound,winmm,port,pulse,wave
88 ## excludefx:
89 #  Sets which effects to exclude, preventing apps from using them. This can
90 #  help for apps that try to use effects which are too CPU intensive for the
91 #  system to handle. Available effects are: eaxreverb,reverb,echo
92 #excludefx =
94 ## slots:
95 #  Sets the maximum number of Auxiliary Effect Slots an app can create. A slot
96 #  can use a non-negligible amount of CPU time if an effect is set on it even
97 #  if no sources are feeding it, so this may help when apps use more than the
98 #  system can handle.
99 #slots = 4
101 ## sends:
102 #  Sets the maximum number of auxiliary sends per source. The total number of
103 #  sends possible is defined at compile time and thus can not be increased
104 #  beyond the default (2).
105 #sends = 2
107 ## layout_STEREO:
108 #  Sets the speaker layout when using stereo output. Values are specified in
109 #  degrees, where 0 is straight in front, negative goes left, and positive goes
110 #  right. The values must define a circular pattern, starting with the back-
111 #  left at the most negative, around the front to back-center. Unspecified
112 #  speakers will remain at their default position. Available speakers are
113 #  front-left(fl) and front-right(fr).
114 #layout_STEREO = fl=-90, fr=90
116 ## laytout_QUAD:
117 #  Sets the speaker layout when using quadriphonic output. Available speakers
118 #  are back-left(bl), front-left(fl), front-right(fr), and back-right(br).
119 #layout_QUAD = bl=-135, fl=-45, fr=45, br=135
121 ## layout_51CHN:
122 #  Sets the speaker layout when using 5.1 output. Available speakers are back-
123 #  left(bl), front-left(fl), front-center(fc), front-right(fr), and back-
124 #  right(br).
125 #layout_51CHN = bl=-110, fl=-30, fc=0, fr=30, br=110
127 ## layout_61CHN:
128 #  Sets the speaker layout when using 6.1 output. Available speakers are side-
129 #  left(sl), front-left(fl), front-center(fc), front-right(fr), side-right(sr),
130 #  and back-center(bc).
131 #layout_61CHN = sl=-90, fl=-30, fc=0, fr=30, sr=90, bc=180
133 ## layout_71CHN:
134 #  Sets the speaker layout when using 7.1 output. Available speakers are back-
135 #  left(bl), side-left(sl), front-left(fl), front-center(fc), front-right(fr),
136 #  side-right(sr), and back-right(br).
137 #layout_71CHN = bl=-150, sl=-90, fl=-30, fc=0, fr=30, sr=90, br=150
140 ## ALSA backend stuff
142 [alsa]
144 ## device:
145 #  Sets the device name for the default playback device.
146 #device = default
148 ## capture:
149 #  Sets the device name for the default capture device.
150 #capture = default
152 ## mmap:
153 #  Sets whether to try using mmap mode (helps reduce latencies and CPU
154 #  consumption). If mmap isn't available, it will automatically fall back to
155 #  non-mmap mode. True, yes, on, and non-0 values will attempt to use mmap. 0
156 #  and anything else will force mmap off.
157 #mmap = true
160 ## OSS backend stuff
162 [oss]
164 ## device:
165 #  Sets the device name for OSS output.
166 #device = /dev/dsp
168 ## capture:
169 #  Sets the device name for OSS capture.
170 #capture = /dev/dsp
173 ## Solaris backend stuff
175 [solaris]
177 ## device:
178 #  Sets the device name for Solaris output.
179 #device = /dev/audio
182 ## DirectSound backend stuff
184 [dsound]
187 ## Windows Multimedia backend stuff
189 [winmm]
192 ## PortAudio backend stuff
194 [port]
196 ## device:
197 #  Sets the device index for output. Negative values will use the default as
198 #  given by PortAudio itself.
199 #device = -1
202 ## PulseAudio backend stuff
204 [pulse]
207 ## Wave File Writer stuff
209 [wave]
211 ## file:
212 #  Sets the filename of the wave file to write to. An empty name prevents the
213 #  backend from opening, even when explicitly requested.
214 #  THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
215 #file =