2 .\" Copyright (c) 2003-2007 Yuriy Tsibizov
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: head/share/man/man4/snd_emu10kx.4 267938 2014-06-26 21:46:14Z bapt $
33 .Nd Creative SoundBlaster Live! and Audigy sound cards device driver
35 To compile this driver into the kernel, place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
39 .Cd "device snd_emu10kx"
42 Alternatively, to load the driver as a module at boot time, place the
45 .Bd -literal -offset indent
46 snd_emu10kx_load="YES"
51 bridge driver allows the generic audio driver
53 to attach to Creative sound cards based on the EMU10K1, CA0100, CA0101, CA0102
58 sound cards have a PCM part, which is accessible through one to five
61 .Sx MULTICHANNEL PLAYBACK
62 for details), and MPU401-compatible MIDI I/O controller, which is accessible
63 through the midi device.
64 Wave table synthesizer support is not available.
68 driver supports the following sound cards:
72 Creative Sound Blaster Live!\& (EMU10K1 Chipset).
73 Both PCM and MIDI interfaces are available.
75 Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset).
76 PCM and two MIDI interfaces available.
78 Creative Sound Blaster Audigy 2 and Creative Sound Blaster Audigy 4 (CA0102
80 PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part
81 of this chipset is not supported).
83 Creative Sound Blaster Audigy 2 Value (CA0108 Chipset).
84 PCM support is limited
85 to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).
86 There is no MIDI support for this card.
93 support the following sound cards (although they have names
94 similar to some supported ones):
98 Creative Sound Blaster Live!\& 24-Bit, identified by
101 .Qq Li "emu10k1x Soundblaster Live! 5.1" .
103 Creative Sound Blaster Audigy LS / ES, identified by
106 .Qq Li "CA0106-DAT Audigy LS" .
108 All other Creative sound cards with -DAT chipsets.
110 All Creative X-Fi series sound cards.
112 .Sh MULTICHANNEL PLAYBACK
115 driver is loaded with multichannel playback capabilities enabled.
116 If you do not set the
117 .Dv hint.emu10kx.0.multichannel_disabled
120 configuration file you will get up to five DSP devices, one for each
122 You can use additional software (like
125 .Em The Ports Collection )
126 to do sound stream demultiplexing.
129 output can play and record sound from external
130 sources (like line or S/PDIF inputs).
131 .Sh MULTICHANNEL RECORDING
132 By default multichannel recording capabilities are not enabled when you load
137 .Dv hint.emu10kx.0.multichannel_recording
140 you will get one more DSP device that is rate-locked to 48kHz/16bit/mono.
141 This is actually 48kHz/16bit/32 channels on SB Live! cards and
142 48kHz/16bit/64channels on Audigy cards, but the current implementation of
143 the sound subsystem does not support such an amount of PCM channels.
144 This device can not be opened for read, thus confusing many applications.
146 Within a multichannel stream, the first half (0-15 or 0-31) is a copy of all DSP
147 outputs, the second half (15-30 or 32-63) is a copy of some DSP inputs.
148 On Live! cards the last substream (31) is used as a sync stream and is always
150 Audigy cards do not need such sync data, because a stream always starts with
152 .Ss SB Live! substream map (in byte offsets, each substream is 2 bytes LE)
153 .Bl -tag -width ".Dv +0x00..+0x1E"
161 PCM inputs: front left, front right, rear left, rear right, center, sub
165 sync substream (0xc0de)
167 .Ss Audigy substream map (in byte offsets, each substream is 2 bytes LE)
168 .Bl -tag -width ".Dv +0x00..+0x3E"
174 PCM inputs: front LR, rear LR, center, sub, ...
178 .Sh OSS MIXER CONTROLS
179 These are the controls available through the standard OSS programming interface.
184 On EMU10K1-based cards the OSS mixer directly controls the AC97 codec.
185 On newer cards the OSS mixer controls some parameters of the AC97 codec and
186 some DSP-based mixer controls.
189 mixer control for the overall sound volume.
191 mixer control for the PCM playback volume.
192 It controls only front output
193 volume in multichannel mode and all output volume in single channel mode.
195 mixer control acts very differently on EMU10K1 and other cards.
196 On EMU10K1 cards it controls the AC97 codec recording level.
197 On non-EMU10K1 cards it controls the amount of AC97
200 AC97 recording level and AC97 recording source are fixed on CA0100, CA0101,
201 CA0102 and CA0108 cards.
202 The AC97 recording levels are always set to maximum and recording source is always
203 .Dq Li "stereo mix" .
205 is a CD S/PDIF (on-card) volume control
207 is an AudigyDrive S/PDIF (Audigy series) or TOSLink (SB Live! series) volume
210 is an on-card S/PDIF volume control
212 is AudigyDrive "Line In 2" volume control
214 is AudigyDrive "AUX In 2" volume control
217 Other OSS mixer controls control the inputs of the AC97 codec.
218 .Sh PRIVATE DEVICE CONTROLS
219 You can control some of EMU10Kx's operation and configuration parameters through
220 .Va dev.emu10kx. Ns Aq Ar X
224 values are temporary and should not be relied upon.
225 .Sh DRIVER CONFIGURATION
226 Loader tunables are used to set driver configuration.
227 Tunables can be set at the
229 prompt before booting the kernel or they can be stored in
230 .Pa /boot/loader.conf .
231 These tunables cannot be changed from a machine
233 entry after boot, but you can change them using
238 .Bl -tag -width indent
239 .It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .disabled
240 Disables loading a driver instance.
241 .It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .multichannel_disabled
242 Disables multichannel playback support, when one card is represented as
244 .It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .multichannel_recording
245 Enables experimental multichannel recording support.
246 .It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .debug
247 Set debug output level.
250 No additional debug options enabled
252 Enables all DSP outputs to be connected, even those
253 that are known to be unused on a particular card.
255 Additional debug messages about in-driver events will be printed.
257 Additional debug messages will be printed when memory allocation fails.
261 .Bl -tag -width ".Pa /dev/emu10kx?" -compact
271 device driver first appeared in
275 The PCM part of the driver is based on the
278 .An Cameron Grant Aq Mt cg@FreeBSD.org .
279 The MIDI interface is based on the
281 MIDI interface code by
282 .An Mathew Kanner Aq Mt matk@FreeBSD.org .
285 device driver and this manual page were written by
288 The driver does not detect lost S/PDIF signals and produces noise when
289 S/PDIF is not connected and S/PDIF volume is not zero.
291 The PCM driver cannot detect the presence of Live!Drive or AudigyDrive
292 breakout boxes and tries to use them (and list their connectors in the
295 The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive
296 breakout boxes and tries to enable the IR receiver on them anyway.