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 .Nm
  62 sound cards have a PCM part, which is accessible through one to five
  63 .Xr pcm 4
  64 devices (see
  65 .Sx MULTICHANNEL PLAYBACK
  66 for details), and MPU401-compatible MIDI I/O controller, which is accessible
  67 through the midi device.
  68 Wave table synthesizer is not supported.
  69 .Sh HARDWARE
  70 The
  71 .Nm
  72 driver supports the following sound cards:
  73 .Pp
  74 .Bl -bullet -compact
  75 .It
  76 Creative Sound Blaster Live!\& (EMU10K1 Chipset).
  77 Both PCM and MIDI interfaces are available.
  78 .It
  79 Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset).
  80 PCM and two MIDI interfaces available.
  81 .It
  82 Creative Sound Blaster Audigy 2 and Creative Sound Blaster Audigy 4 (CA0102
  83 Chipset).
  84 PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part
  85 of this chipset is not supported).
  86 .It
  87 Creative Sound Blaster Audigy 2 Value (CA0108 Chipset).
  88 PCM support is limited
  89 to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).\&
  90 There is no MIDI support for this card.
  91 .El
  92 .Pp
  93 The
  94 .Nm
  95 driver does
  96 .Em not
  97 support the following sound cards (although they are named
  98 similar to some supported ones):
  99 .Pp
 100 .Bl -bullet -compact
 101 .It
 102 Creative Sound Blaster Live!\& 24-Bit, identified by FreeBSD as
 103 .Li Qq emu10k1x Soundblaster Live! 5.1 .
 104 .It
 105 Creative Sound Blaster Audigy LS / ES, identified by FreeBSD as
 106 .Li Qq CA0106-DAT Audigy LS .
 107 .It
 108 All other cards with -DAT chipsets.
 109 .El
 110 .Sh MULTICHANNEL PLAYBACK
 111 .Pp
 112 It is possible to build this driver with multichannel playback capabilites.
 113 If you enable the
 114 .Dq Dv EMU10KX_MULTICHANNEL
 115 option in your kernel configuration (or
 116 build it as a module) you will get up to five DSP devices, one for each sound
 117 card output.
 118 Only
 119 .Dq FRONT
 120 output can play and record sound from external
 121 sources (like line or S/PDIF inputs).
 122 .Sh OSS MIXER CONTROLS
 123 .Pp
 124 These are controls available through the standard OSS programming interface.
 125 You can use
 126 .Xr mixer 8
 127 to change them.
 128 .Pp
 129 On EMU10K1-based cards the OSS mixer directly controls the  AC97 codec on card.
 130 On newer cards the OSS mixer controls some parameters of the AC97 codec and
 131 some DSP-based mixer controls.
 132 .Pp
 133 "vol" mixer control is overall sound volume.
 134 .Pp
 135 "pcm" mixer control is PCM playback volume.
 136 It controls only front output
 137 volume in multichannel mode and all output volume in single chennel mode.
 138 .Pp
 139 "rec" mixer control acts very different on EMU10K1 and other cards.
 140 On EMU10K1 cards it controls the AC97 codec recording level.
 141 On non-EMU10K1 cards
 142 it controls the amount of AC97 "stereo mix" entering the DSP.
 143 AC97 recording level and AC97 recording source are fixed
 144 on CA0100, CA0101, CA0102 and CA0108 cards.
 145 AC97 recording level are always set to
 146 maximum and recording source is always "stereo mix".
 147 .Pp
 148 Other OSS mixer controls do not work.
 149 .Sh PRIVATE DEVICE CONTROLS
 150 .Pp
 151 You can control most of EMU10Kx operation and configuration parameters through
 152 dev.emu10kx.X sysctls.
 153 These
 154 .Xr sysctl 8
 155 values are temporary and should not be relied
 156 upon.
 157 .Sh DRIVER CONFIGURATION
 158 .Ss Kernel Configuration Options
 159 The following kernel configuration options control the
 160 .Nm
 161 driver.
 162 .Bl -tag -width EMU10KX_MULTICHANNEL
 163 .It Em EMU10KX_MULTICHANNEL
 164 This option enables
 165 .Sx MULTICHANNEL PLAYBACK
 166 for all instances of the
 167 .Nm
 168 driver.
 169 .It Em EMU10KX_DEBUG
 170 This option enables additional debug messages.
 171 .El
 172 .Pp
 173 .Sh FILES
 174 .Bl -tag -width /dev/emu10kx? -compact
 175 .It Pa /dev/emu10kx?
 176 emu10kx management interface
 177 .El
 178 .Sh SEE ALSO
 179 .Xr sound 4
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 device driver first appeared in
 184 .Fx 7.0 .
 185 .Sh AUTHORS
 186 The PCM part of the driver is based on the
 187 .Xr snd_emu10k1 4
 188 SB Live! driver by Cameron Grant.
 189 The MIDI interface is based on the
 190 .Xr snd_emu10k1 4
 191 MIDI interface code by Mathew Kanner.
 192 The
 193 .Nm
 194 device driver and this manual page were written by
 195 .An Yuriy Tsibizov .
 196 .Sh BUGS
 197 8kHz/8bit/mono recording does not work.
 198 8kHz recording was removed from the driver capabilites.
 199 .Pp
 200 The Driver does not detect lost S/PDIF signal and produces noise when S/PDIF
 201 is not connected and S/PDIF volume is not zero.
 202 .Pp
 203 The PCM driver cannot detect the presence of Live!Drive or AudigyDrive
 204 breakout boxes
 205 and tries to use them (and list their connectors in the mixer).
 206 .Pp
 207 The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive
 208 breakout boxes and tries to enable the IR receiver on them anyway.