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