Add missing comment markers
[openal-soft.git] / alsoftrc.sample
blob438eba4a283083861d8a8634ec4f2a6f68311823
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). These are the current available settings:
15 format = AL_FORMAT_STEREO16  # Sets the output format. Can be one of:
16                              # AL_FORMAT_MONO8    (8-bit mono)
17                              # AL_FORMAT_STEREO8  (8-bit stereo)
18                              # AL_FORMAT_QUAD8    (8-bit 4-channel)
19                              # AL_FORMAT_51CHN8   (8-bit 5.1 output)
20                              # AL_FORMAT_61CHN8   (8-bit 6.1 output)
21                              # AL_FORMAT_71CHN8   (8-bit 7.1 output)
22                              # AL_FORMAT_MONO16   (16-bit mono)
23                              # AL_FORMAT_STEREO16 (16-bit stereo)
24                              # AL_FORMAT_QUAD16   (16-bit 4-channel)
25                              # AL_FORMAT_51CHN16  (16-bit 5.1 output)
26                              # AL_FORMAT_61CHN16  (16-bit 6.1 output)
27                              # AL_FORMAT_71CHN16  (16-bit 7.1 output)
28                              # Default is AL_FORMAT_STEREO16
30 cf_level = 0  # Sets the crossfeed level for stereo output. Valid values are:
31               # 0 - No crossfeed
32               # 1 - Low crossfeed
33               # 2 - Middle crossfeed
34               # 3 - High crossfeed (virtual speakers are closer to itself)
35               # 4 - Low easy crossfeed
36               # 5 - Middle easy crossfeed
37               # 6 - High easy crossfeed
38               # Default is 0. Users of headphones may want to try various
39               # settings. Has no effect on non-stereo modes.
41 frequency = 44100  # Sets the output frequency. Default is 44100
43 refresh = 4096  # Sets the buffer size, in frames. Default is 4096. Note that
44                 # the actual granularity may or may not be less than this.
46 sources = 256  # Sets the maximum number of allocatable sources. Lower values
47                # may help for systems with apps that try to play more sounds
48                # than the CPU can handle. Default is 256
50 stereodup =  # Sets whether to duplicate stereo sounds on the rear and side
51              # speakers for 4+ channel output. This can make stereo sources
52              # substantially louder than mono or even 4+ channel sources, but
53              # provides a "fuller" playback quality. True, yes, on, and non-0
54              # values will duplicate stereo sources. 0 and anything else will
55              # cause stereo sounds to only play out the front speakers.
56              # Default is false
58 drivers =  # Sets the backend driver list order, comma-seperated. Unknown
59            # backends and duplicated names are ignored, and unlisted backends
60            # won't be considered for use. An empty list means the default.
61            # Default is:
62            # alsa,oss,solaris,dsound,winmm,port,wave
64 excludefx =  # Sets which effects to exclude, preventing apps from using them.
65              # This can help for apps that try to use effects which are too CPU
66              # intensive for the system to handle. Available effects are:
67              # reverb
68              # Default is empty (all available effects enabled)
70 layout_STEREO =  # Sets the speaker layout when using stereo output. Values are
71                  # specified in degrees, where 0 is straight in front, negative
72                  # goes left, and positive goes right. The values must define a
73                  # circular pattern, starting with the back-left at the most
74                  # negative, around the front to back-center. Unspecified
75                  # speakers will remain at their default position. Available
76                  # speakers are front-left(fl) and front-right(fr).
77                  # The default is:
78                  # fl=-90, fr=90
80 layout_QUAD =  # Sets the speaker layout when using quadriphonic output.
81                # Available speakers are back-left(bl), front-left(fl),
82                # front-right(fr), and back-right(br).
83                # The default is:
84                # bl=-135, fl=-45, fr=45, br=135
86 layout_51CHN =  # Sets the speaker layout when using 5.1 output. Available
87                 # speakers are back-left(bl), front-left(fl), front-center(fc),
88                 # front-right(fr), and back-right(br).
89                 # The default is:
90                 # bl=-110, fl=-30, fc=0, fr=30, br=110
92 layout_61CHN =  # Sets the speaker layout when using 6.1 output. Available
93                 # speakers are side-left(sl), front-left(fl), front-center(fc),
94                 # front-right(fr), side-right(sr), and back-center(bc).
95                 # The default is:
96                 # sl=-90, fl=-30, fc=0, fr=30, sr=90, bc=180
98 layout_71CHN =  # Sets the speaker layout when using 7.1 output. Available
99                 # speakers are back-left(bl), side-left(sl), front-left(fl),
100                 # front-center(fc), front-right(fr), side-right(sr), and
101                 # back-right(br).
102                 # The default is:
103                 # bl=-150, sl=-90, fl=-30, fc=0, fr=30, sr=90 br=150
106 [alsa]  # ALSA backend stuff
107 device = default  # Sets the device name for the default playback device.
108                   # Default is default
110 periods = 0  # Sets the number of update buffers for playback. A value of 0
111              # means auto-select. Default is 0
113 capture = default  # Sets the device name for the default capture device.
114                    # Default is default
116 mmap = true  # Sets whether to try using mmap mode (helps reduce latencies and
117              # CPU consumption). If mmap isn't available, it will automatically
118              # fall back to non-mmap mode. True, yes, on, and non-0 values will
119              # attempt to use mmap. 0 and anything else will force mmap off.
120              # Default is true.
122 [oss]  # OSS backend stuff
123 device = /dev/dsp  # Sets the device name for OSS output. Default is /dev/dsp
125 periods = 4  # Sets the number of update buffers. Default is 4
127 capture = /dev/dsp  # Sets the device name for OSS capture. Default is /dev/dsp
129 [solaris]  # Solaris backend stuff
130 device = /dev/audio  # Sets the device name for Solaris output. Default is
131                      # /dev/audio
133 [dsound]  # DirectSound backend stuff
134 periods = 4  # Sets the number of updates for the output buffer. Default is 4
136 [winmm]  # Windows Multimedia backend stuff
137          # Nothing yet...
139 [port]  # PortAudio backend stuff
140 device = -1  # Sets the device index for output. Negative values will use the
141              # default as given by PortAudio itself. Default is -1
143 periods = 4  # Sets the number of update buffers. Default is 4
145 [wave]  # Wave File Writer stuff
146 file =  # Sets the filename of the wave file to write to. An empty name
147         # prevents the backend from opening, even when explicitly requested.
148         # THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
149         # Default is empty