Add an SDL backend
[openal-soft.git] / alsoftrc.sample
blobe447d5281e56a670f18cadb57b39c83f7856cf00
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 speakers for
51              # 4+ channel output. This can make stereo sources substantially
52              # louder than mono or even 4+ channel sources, but provides a
53              # "fuller" playback quality. True, yes, on, and non-0 values will
54              # duplicate stereo sources. 0 and anything else will cause stereo
55              # 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,sdl,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 [alsa]  # ALSA backend stuff
71 device = default  # Sets the device name for the default playback device.
72                   # Default is default
74 periods = 0  # Sets the number of update buffers for playback. A value of 0
75              # means auto-select. Default is 0
77 capture = default  # Sets the device name for the default capture device.
78                    # Default is default
80 mmap = true  # Sets whether to try using mmap mode (helps reduce latencies and
81              # CPU consumption). If mmap isn't available, it will automatically
82              # fall back to non-mmap mode. True, yes, on, and non-0 values will
83              # attempt to use mmap. 0 and anything else will force mmap off.
84              # Default is true.
86 [oss]  # OSS backend stuff
87 device = /dev/dsp  # Sets the device name for OSS output. Default is /dev/dsp
89 periods = 4  # Sets the number of update buffers. Default is 4
91 capture = /dev/dsp  # Sets the device name for OSS capture. Default is /dev/dsp
93 [solaris]  # Solaris backend stuff
94 device = /dev/audio  # Sets the device name for Solaris output. Default is
95                      # /dev/audio
97 [dsound]  # DirectSound backend stuff
98 periods = 4  # Sets the number of updates for the output buffer. Default is 4
100 [winmm]  # Windows Multimedia backend stuff
101          # Nothing yet...
103 [sdl]  # SDL backend stuff
104        # Nothing yet...
106 [wave]  # Wave File Writer stuff
107 file =  # Sets the filename of the wave file to write to. An empty name
108         # prevents the backend from opening, even when explicitly requested.
109         # THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
110         # Default is empty