share/man/man4/snd_emu10kx.4

   1 .\"
   2 .\" Copyright (c) 2003,2006 Yuriy Tsibizov,
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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.
  13 .\"
  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
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $Id: snd_emu10kx.4,v 1.19 2006/06/07 11:18:57 chibis Exp $
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd July 15, 2006
  30 .Dt SND_EMU10KX 4
  31 .Os
  32 .Sh NAME
  33 .Nm snd_emu10kx
  34 .Nd Creative SoundBlaster Live! and Audigy sound cards device driver
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel, place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device sound"
  40 .Cd "device snd_emu10kx"
  41 .Pp
  42 For additional options:
  43 .Cd "options EMU10KX_MULTICHANNEL"
  44 .Cd "options EMU10KX_DEBUG"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a module at boot time, place the
  48 following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 snd_emu10kx_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 bridge driver allows the generic audio driver
  57 .Xr sound 4
  58 to attach to the Creative sound cards based on EMU10K1, CA0100, CA0101, CA0102
  59 and CA0108 DSPs.
  60 .Pp
  61 The
  62 .Nm
  63 sound cards have a PCM part, which is accessible through one to five
  64 .Xr pcm 4
  65 devices (see
  66 .Sx MULTICHANNEL PLAYBACK
  67 for details), and MPU401-compatible MIDI I/O controller, which is accessible
  68 through the midi device.
  69 Wave table synthesizer is not supported.
  70 .Sh HARDWARE
  71 The
  72 .Nm
  73 driver supports the following sound cards:
  74 .Pp
  75 .Bl -bullet -compact
  76 .It
  77 Creative Sound Blaster Live!\& (EMU10K1 Chipset).
  78 Both PCM and MIDI interfaces are available.
  79 .It
  80 Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset).
  81 PCM and two MIDI interfaces available.
  82 .It
  83 Creative Sound Blaster Audigy 2 and Creative Sound Blaster Audigy 4 (CA0102
  84 Chipset).
  85 PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part
  86 of this chipset is not supported).
  87 .It
  88 Creative Sound Blaster Audigy 2 Value (CA0108 Chipset).
  89 PCM support is limited
  90 to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).
  91 There is no MIDI support for this card.
  92 .El
  93 .Pp
  94 The
  95 .Nm
  96 driver does
  97 .Em not
  98 support the following sound cards (although they are named
  99 similar to some supported ones):
 100 .Pp
 101 .Bl -bullet -compact
 102 .It
 103 Creative Sound Blaster Live!\& 24-Bit, identified by
 104 .Fx
 105 as
 106 .Qq Li "emu10k1x Soundblaster Live! 5.1" .
 107 .It
 108 Creative Sound Blaster Audigy LS / ES, identified by
 109 .Fx
 110 as
 111 .Qq Li "CA0106-DAT Audigy LS" .
 112 .It
 113 All other cards with -DAT chipsets.
 114 .El
 115 .Sh MULTICHANNEL PLAYBACK
 116 It is possible to build this driver with multichannel playback capabilities.
 117 If you enable the
 118 .Dv EMU10KX_MULTICHANNEL
 119 option in your kernel configuration (or
 120 build it as a module) you will get up to five DSP devices, one for each sound
 121 card output.
 122 Only
 123 .Dq FRONT
 124 output can play and record sound from external
 125 sources (like line or S/PDIF inputs).
 126 .Sh OSS MIXER CONTROLS
 127 These are controls available through the standard OSS programming interface.
 128 You can use
 129 .Xr mixer 8
 130 to change them.
 131 .Pp
 132 On EMU10K1-based cards the OSS mixer directly controls the AC97 codec on card.
 133 On newer cards the OSS mixer controls some parameters of the AC97 codec and
 134 some DSP-based mixer controls.
 135 .Bl -inset
 136 .It Qq vol
 137 mixer control is overall sound volume.
 138 .It Qq pcm
 139 mixer control is PCM playback volume.
 140 It controls only front output
 141 volume in multichannel mode and all output volume in single channel mode.
 142 .It Qq rec
 143 mixer control acts very different on EMU10K1 and other cards.
 144 On EMU10K1 cards it controls the AC97 codec recording level.
 145 On non-EMU10K1 cards
 146 it controls the amount of AC97 "stereo mix" entering the DSP.
 147 AC97 recording level and AC97 recording source are fixed
 148 on CA0100, CA0101, CA0102 and CA0108 cards.
 149 AC97 recording level are always set to
 150 maximum and recording source is always
 151 .Dq Li "stereo mix" .
 152 .El
 153 .Pp
 154 Other OSS mixer controls do not work.
 155 .Sh PRIVATE DEVICE CONTROLS
 156 You can control most of EMU10Kx operation and configuration parameters through
 157 .Va dev.emu10kx. Ns Aq Ar X
 158 sysctls.
 159 These
 160 .Xr sysctl 8
 161 values are temporary and should not be relied
 162 upon.
 163 .Sh DRIVER CONFIGURATION
 164 .Ss Kernel Configuration Options
 165 The following kernel configuration options control the
 166 .Nm
 167 driver.
 168 .Bl -tag -width ".Dv EMU10KX_MULTICHANNEL"
 169 .It Dv EMU10KX_MULTICHANNEL
 170 This option enables
 171 .Sx MULTICHANNEL PLAYBACK
 172 for all instances of the
 173 .Nm
 174 driver.
 175 .It Dv EMU10KX_DEBUG
 176 This option enables additional debug messages.
 177 .El
 178 .Sh FILES
 179 .Bl -tag -width ".Pa /dev/emu10kx?" -compact
 180 .It Pa /dev/emu10kx?
 181 .Nm
 182 management interface
 183 .El
 184 .Sh SEE ALSO
 185 .Xr sound 4
 186 .Sh HISTORY
 187 The
 188 .Nm
 189 device driver first appeared in
 190 .Fx 7.0 .
 191 .Sh AUTHORS
 192 .An -nosplit
 193 The PCM part of the driver is based on the
 194 .Xr snd_emu10k1 4
 195 SB Live!\& driver by
 196 .An "Cameron Grant" .
 197 The MIDI interface is based on the
 198 .Xr snd_emu10k1 4
 199 MIDI interface code by
 200 .An "Mathew Kanner" .
 201 The
 202 .Nm
 203 device driver and this manual page were written by
 204 .An Yuriy Tsibizov .
 205 .Sh BUGS
 206 8kHz/8bit/mono recording does not work.
 207 8kHz recording was removed from the driver capabilities.
 208 .Pp
 209 The driver does not detect lost S/PDIF signal and produces noise when S/PDIF
 210 is not connected and S/PDIF volume is not zero.
 211 .Pp
 212 The PCM driver cannot detect the presence of Live!Drive or AudigyDrive
 213 breakout boxes
 214 and tries to use them (and list their connectors in the mixer).
 215 .Pp
 216 The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive
 217 breakout boxes and tries to enable the IR receiver on them anyway.