share/man/man4/pcm.4

   1 .\"
   2 .\" Copyright (c) 2009-2011 Joel Dahl <joel@FreeBSD.org>
   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 .\" $FreeBSD$
  27 .\"
  28 .Dd March 22, 2012
  29 .Dt SOUND 4
  30 .Os
  31 .Sh NAME
  32 .Nm sound ,
  33 .Nm pcm ,
  34 .Nm snd
  35 .Nd
  36 .Fx
  37 PCM audio device infrastructure
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel, place the following line in your
  40 kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device sound"
  43 .Ed
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 driver is the main component of the
  48 .Fx
  49 sound system.
  50 It works in conjunction with a bridge device driver on supported devices
  51 and provides PCM audio record and playback once it attaches.
  52 Each bridge device driver supports a specific set of audio chipsets and
  53 needs to be enabled together with the
  54 .Nm
  55 driver.
  56 PCI and ISA PnP audio devices identify themselves so users are usually not
  57 required to add anything to
  58 .Pa /boot/device.hints .
  59 .Pp
  60 Some of the main features of the
  61 .Nm
  62 driver are: multichannel audio, per-application
  63 volume control, dynamic mixing through virtual sound channels, true full
  64 duplex operation, bit perfect audio, rate conversion and low latency
  65 modes.
  66 .Pp
  67 The
  68 .Nm
  69 driver is enabled by default, along with several bridge device drivers.
  70 Those not enabled by default can be loaded during runtime with
  71 .Xr kldload 8
  72 or during boot via
  73 .Xr loader.conf 5 .
  74 The following bridge device drivers are available:
  75 .Pp
  76 .Bl -bullet -compact
  77 .It
  78 .Xr snd_ad1816 4
  79 .It
  80 .Xr snd_ai2s 4 (enabled by default on powerpc)
  81 .It
  82 .Xr snd_als4000 4
  83 .It
  84 .Xr snd_atiixp 4
  85 .It
  86 .Xr snd_audiocs 4 (enabled by default on sparc64)
  87 .It
  88 .Xr snd_cmi 4 (enabled by default on amd64, i386)
  89 .It
  90 .Xr snd_cs4281 4
  91 .It
  92 .Xr snd_csa 4 (enabled by default on amd64, i386)
  93 .It
  94 .Xr snd_davbus 4 (enabled by default on powerpc)
  95 .It
  96 .Xr snd_ds1 4
  97 .It
  98 .Xr snd_emu10k1 4
  99 .It
 100 .Xr snd_emu10kx 4 (enabled by default on amd64, i386)
 101 .It
 102 .Xr snd_envy24 4
 103 .It
 104 .Xr snd_envy24ht 4
 105 .It
 106 .Xr snd_es137x 4 (enabled by default on amd64, i386, sparc64)
 107 .It
 108 .Xr snd_ess 4
 109 .It
 110 .Xr snd_fm801 4
 111 .It
 112 .Xr snd_gusc 4
 113 .It
 114 .Xr snd_hda 4 (enabled by default on amd64, i386)
 115 .It
 116 .Xr snd_hdspe 4
 117 .It
 118 .Xr snd_ich 4 (enabled by default on amd64, i386)
 119 .It
 120 .Xr snd_maestro 4
 121 .It
 122 .Xr snd_maestro3 4
 123 .It
 124 .Xr snd_mss 4
 125 .It
 126 .Xr snd_neomagic 4
 127 .It
 128 snd_sb16
 129 .It
 130 snd_sb8
 131 .It
 132 .Xr snd_sbc 4
 133 .It
 134 .Xr snd_solo 4
 135 .It
 136 .Xr snd_spicds 4
 137 .It
 138 .Xr snd_t4dwave 4 (enabled by default on sparc64)
 139 .It
 140 .Xr snd_uaudio 4 (enabled by default on amd64, i386, powerpc, sparc64)
 141 .It
 142 .Xr snd_via8233 4 (enabled by default on amd64, i386)
 143 .It
 144 .Xr snd_via82c686 4
 145 .It
 146 .Xr snd_vibes 4
 147 .El
 148 .Pp
 149 Refer to the manual page for each bridge device driver for driver specific
 150 settings and information.
 151 .Ss Legacy Hardware
 152 For old legacy
 153 .Tn ISA
 154 cards, the driver looks for
 155 .Tn MSS
 156 cards at addresses
 157 .Dv 0x530
 158 and
 159 .Dv 0x604 .
 160 These values can be overridden in
 161 .Pa /boot/device.hints .
 162 Non-PnP sound cards require the following lines in
 163 .Xr device.hints 5 :
 164 .Bd -literal -offset indent
 165 hint.pcm.0.at="isa"
 166 hint.pcm.0.irq="5"
 167 hint.pcm.0.drq="1"
 168 hint.pcm.0.flags="0x0"
 169 .Ed
 170 .Pp
 171 Apart from the usual parameters, the flags field is used to specify
 172 the secondary
 173 .Tn DMA
 174 channel (generally used for capture in full duplex cards).
 175 Flags are set to 0 for cards not using a secondary
 176 .Tn DMA
 177 channel, or to 0x10 + C to specify channel C.
 178 .Ss Boot Variables
 179 In general, the module
 180 .Pa snd_foo
 181 corresponds to
 182 .Cd "device snd_foo"
 183 and can be
 184 loaded by the boot
 185 .Xr loader 8
 186 via
 187 .Xr loader.conf 5
 188 or from the command line using the
 189 .Xr kldload 8
 190 utility.
 191 Options which can be specified in
 192 .Pa /boot/loader.conf
 193 include:
 194 .Bl -tag -width ".Va snd_driver_load" -offset indent
 195 .It Va snd_driver_load
 196 .Pq Dq Li NO
 197 If set to
 198 .Dq Li YES ,
 199 this option loads all available drivers.
 200 .It Va snd_hda_load
 201 .Pq Dq Li NO
 202 If set to
 203 .Dq Li YES ,
 204 only the Intel High Definition Audio bridge device driver and dependent
 205 modules will be loaded.
 206 .It Va snd_foo_load
 207 .Pq Dq Li NO
 208 If set to
 209 .Dq Li YES ,
 210 load driver for card/chipset foo.
 211 .El
 212 .Pp
 213 To define default values for the different mixer channels,
 214 set the channel to the preferred value using hints, e.g.:
 215 .Va hint.pcm.0.line Ns = Ns Qq Li 0 .
 216 This will mute the input channel per default.
 217 .Ss Multichannel Audio
 218 Multichannel audio, popularly referred to as
 219 .Dq surround sound
 220 is supported and enabled by default.
 221 The FreeBSD multichannel matrix processor supports up to 18 interleaved
 222 channels, but the limit is currently set to 8 channels (as commonly used
 223 for 7.1 surround sound).
 224 The internal matrix mapping can handle reduction, expansion or
 225 re-routing of channels.
 226 This provides a base interface for related multichannel
 227 .Fn ioctl
 228 support.
 229 Multichannel audio works both with and without
 230 .Tn VCHANs .
 231 .Pp
 232 Most bridge device drivers are still missing multichannel matrixing
 233 support, but in most cases this should be trivial to implement.
 234 Use the
 235 .Va dev.pcm.%d.[play|rec].vchanformat
 236 .Xr sysctl(8)
 237 to adjust the number of channels used.
 238 The current multichannel interleaved structure and arrangement was
 239 implemented by inspecting various popular UNIX applications.
 240 There were no single standard, so much care has been taken to try
 241 to satisfy each possible scenario, despite the fact that each
 242 application has its own conflicting standard.
 243 .Ss EQ
 244 The Parametric Software Equalizer (EQ) enables the use of
 245 .Dq tone
 246 controls (bass and treble).
 247 Commonly used for ear-candy or frequency compensation due to the vast
 248 difference in hardware quality.
 249 EQ is disabled by default, but can be enabled with the
 250 .Va hint.pcm.%d.eq
 251 tunable.
 252 .Ss VCHANs
 253 Each device can optionally support more playback and recording channels
 254 than physical hardware provides by using
 255 .Dq virtual channels
 256 or
 257 .Tn VCHANs .
 258 .Tn VCHAN
 259 options can be configured via the
 260 .Xr sysctl 8
 261 interface but can only be manipulated while the device is inactive.
 262 .Ss VPC
 263 FreeBSD supports independent and individual volume controls for each active
 264 application, without touching the master
 265 .Nm
 266 volume.
 267 This is sometimes referred to as Volume Per Channel (VPC).
 268 The
 269 .Tn VPC
 270 feature is enabled by default.
 271 .Ss Loader Tunables
 272 The following loader tunables are used to set driver configuration at the
 273 .Xr loader 8
 274 prompt before booting the kernel, or they can be stored in
 275 .Pa /boot/loader.conf
 276 in order to automatically set them before booting the kernel.
 277 It is also possible to use
 278 .Xr kenv 1
 279 to change these tunables before loading the
 280 .Nm
 281 driver.
 282 The following tunables can not be changed during runtime using
 283 .Xr sysctl 8 .
 284 .Bl -tag -width indent
 285 .It Va hint.pcm.%d.eq
 286 Set to 1 or 0 to explicitly enable (1) or disable (0) the equalizer.
 287 Requires a driver reload if changed.
 288 Enabling this will make bass and treble controls appear in mixer applications.
 289 This tunable is undefined by default.
 290 Equalizing is disabled by default.
 291 .It Va hint.pcm.%d.vpc
 292 Set to 1 or 0 to explicitly enable (1) or disable (0) the
 293 .Tn VPC
 294 feature.
 295 This tunable is undefined by default.
 296 .Tn VPC
 297 is however enabled by default.
 298 .El
 299 .Ss Runtime Configuration
 300 There are a number of
 301 .Xr sysctl 8
 302 variables available which can be modified during runtime.
 303 These values can also be stored in
 304 .Pa /etc/sysctl.conf
 305 in order to automatically set them during the boot process.
 306 .Va hw.snd.*
 307 are global settings and
 308 .Va dev.pcm.*
 309 are device specific.
 310 .Bl -tag -width indent
 311 .It Va hw.snd.compat_linux_mmap
 312 Linux
 313 .Xr mmap 2
 314 compatibility.
 315 The following values are supported (default is 0):
 316 .Bl -tag -width 2n
 317 .It -1
 318 Force disabling/denying PROT_EXEC
 319 .Xr mmap 2
 320 requests.
 321 .It 0
 322 Auto detect proc/ABI type, allow
 323 .Xr mmap 2
 324 for Linux applications, and deny for everything else.
 325 .It 1
 326 Always allow PROT_EXEC page mappings.
 327 .El
 328 .It Va hw.snd.default_auto
 329 Automatically assign the default sound unit.
 330 The following values are supported (default is 1):
 331 .Bl -tag -width 2n
 332 .It 0
 333 Do not assign the default sound unit automatically.
 334 .It 1
 335 Use the best available sound device based on playing and recording
 336 capabilities of the device.
 337 .It 2
 338 Use the most recently attached device.
 339 .El
 340 .It Va hw.snd.default_unit
 341 Default sound card for systems with multiple sound cards.
 342 When using
 343 .Xr devfs 5 ,
 344 the default device for
 345 .Pa /dev/dsp .
 346 Equivalent to a symlink from
 347 .Pa /dev/dsp
 348 to
 349 .Pa /dev/dsp Ns Va ${hw.snd.default_unit} .
 350 .It Va hw.snd.feeder_eq_exact_rate
 351 Only certain rates are allowed for precise processing.
 352 The default behavior is however to allow sloppy processing for all rates,
 353 even the unsupported ones.
 354 Enable to toggle this requirement and only allow processing for supported
 355 rates.
 356 .It Va hw.snd.feeder_rate_max
 357 Maximum allowable sample rate.
 358 .It Va hw.snd.feeder_rate_min
 359 Minimum allowable sample rate.
 360 .It Va hw.snd.feeder_rate_polyphase_max
 361 Adjust to set the maximum number of allowed polyphase entries during the
 362 process of building resampling filters.
 363 Disabling polyphase resampling has the benefit of reducing memory usage, at
 364 the expense of slower and lower quality conversion.
 365 Only applicable when the SINC interpolator is used.
 366 Default value is 183040.
 367 Set to 0 to disable polyphase resampling.
 368 .It Va hw.snd.feeder_rate_quality
 369 Sample rate converter quality.
 370 Default value is 1, linear interpolation.
 371 Available options include:
 372 .Bl -tag -width 2n
 373 .It 0
 374 Zero Order Hold, ZOH.
 375 Very fast, but with poor quality.
 376 .It 1
 377 Linear interpolation.
 378 Fast, quality is subject to personal preference.
 379 Technically the quality is poor however, due to the lack of anti-aliasing
 380 filtering.
 381 .It 2
 382 Bandlimited SINC interpolator.
 383 Implements polyphase banking to boost the conversion speed, at the cost of
 384 memory usage, with multiple high quality polynomial interpolators to improve
 385 the conversion accuracy.
 386 100% fixed point, 64bit accumulator with 32bit coefficients and high precision
 387 sample buffering.
 388 Quality values are 100dB stopband, 8 taps and 85% bandwidth.
 389 .It 3
 390 Continuation of the bandlimited SINC interpolator, with 100dB stopband, 36
 391 taps and 90% bandwidth as quality values.
 392 .It 4
 393 Continuation of the bandlimited SINC interprolator, with 100dB stopband, 164
 394 taps and 97% bandwidth as quality values.
 395 .El
 396 .It Va hw.snd.feeder_rate_round
 397 Sample rate rounding threshold, to avoid large prime division at the
 398 cost of accuracy.
 399 All requested sample rates will be rounded to the nearest threshold value.
 400 Possible values range between 0 (disabled) and 500.
 401 Default is 25.
 402 .It Va hw.snd.latency
 403 Configure the buffering latency.
 404 Only affects applications that do not explicitly request
 405 blocksize / fragments.
 406 This tunable provides finer granularity than the
 407 .Va hw.snd.latency_profile
 408 tunable.
 409 Possible values range between 0 (lowest latency) and 10 (highest latency).
 410 .It Va hw.snd.latency_profile
 411 Define sets of buffering latency conversion tables for the
 412 .Va hw.snd.latency
 413 tunable.
 414 A value of 0 will use a low and aggressive latency profile which can result
 415 in possible underruns if the application cannot keep up with a rapid irq
 416 rate, especially during high workload.
 417 The default value is 1, which is considered a moderate/safe latency profile.
 418 .It Va hw.snd.maxautovchans
 419 Global
 420 .Tn VCHAN
 421 setting that only affects devices with at least one playback or recording channel available.
 422 The sound system will dynamically create up to this many
 423 .Tn VCHANs .
 424 Set to
 425 .Dq 0
 426 if no
 427 .Tn VCHANs
 428 are desired.
 429 Maximum value is 256.
 430 .It Va hw.snd.report_soft_formats
 431 Controls the internal format conversion if it is
 432 available transparently to the application software.
 433 When disabled or not available, the application will
 434 only be able to select formats the device natively supports.
 435 .It Va hw.snd.report_soft_matrix
 436 Enable seamless channel matrixing even if the hardware does not support it.
 437 Makes it possible to play multichannel streams even with a simple stereo
 438 sound card.
 439 .It Va hw.snd.verbose
 440 Level of verbosity for the
 441 .Pa /dev/sndstat
 442 device.
 443 Higher values include more output and the highest level,
 444 four, should be used when reporting problems.
 445 Other options include:
 446 .Bl -tag -width 2n
 447 .It 0
 448 Installed devices and their allocated bus resources.
 449 .It 1
 450 The number of playback, record, virtual channels, and
 451 flags per device.
 452 .It 2
 453 Channel information per device including the channel's
 454 current format, speed, and pseudo device statistics such as
 455 buffer overruns and buffer underruns.
 456 .It 3
 457 File names and versions of the currently loaded sound modules.
 458 .It 4
 459 Various messages intended for debugging.
 460 .El
 461 .It Va hw.snd.vpc_0db
 462 Default value for
 463 .Nm
 464 volume.
 465 Increase to give more room for attenuation control.
 466 Decrease for more amplification, with the possible cost of sound clipping.
 467 .It Va hw.snd.vpc_autoreset
 468 When a channel is closed the channel volume will be reset to 0db.
 469 This means that any changes to the volume will be lost.
 470 Enabling this will preserve the volume, at the cost of possible confusion
 471 when applications tries to re-open the same device.
 472 .It Va hw.snd.vpc_mixer_bypass
 473 The recommended way to use the
 474 .Tn VPC
 475 feature is to teach applications to use
 476 the correct
 477 .Fn ioctl :
 478 .Dv SNDCTL_DSP_GETPLAYVOL, SNDCTL_DSP_SETPLAYVOL,
 479 .Dv SNDCTL_DSP_SETRECVOL, SNDCTL_DSP_SETRECVOL.
 480 This is however not always possible.
 481 Enable this to allow applications to use their own existing mixer logic
 482 to control their own channel volume.
 483 .It Va hw.snd.vpc_reset
 484 Enable to restore all channel volumes back to the default value of 0db.
 485 .It Va dev.pcm.%d.bitperfect
 486 Enable or disable bitperfect mode.
 487 When enabled, channels will skip all dsp processing, such as channel
 488 matrixing, rate converting and equalizing.
 489 The pure
 490 .Nm
 491 stream will be fed directly to the hardware.
 492 If
 493 .Tn VCHANs
 494 are enabled, the bitperfect mode will use the
 495 .Tn VCHAN
 496 format/rate as the definitive format/rate target.
 497 The recommended way to use bitperfect mode is to disable
 498 .Tn VCHANs
 499 and enable this sysctl.
 500 Default is disabled.
 501 .It Va dev.pcm.%d.[play|rec].vchans
 502 The current number of
 503 .Tn VCHANs
 504 allocated per device.
 505 This can be set to preallocate a certain number of
 506 .Tn VCHANs .
 507 Setting this value to
 508 .Dq 0
 509 will disable
 510 .Tn VCHANs
 511 for this device.
 512 .It Va dev.pcm.%d.[play|rec].vchanformat
 513 Format for
 514 .Tn VCHAN
 515 mixing.
 516 All playback paths will be converted to this format before the mixing
 517 process begins.
 518 By default only 2 channels are enabled.
 519 Available options include:
 520 .Bl -tag -width 2n
 521 .It s16le:1.0
 522 Mono.
 523 .It s16le:2.0
 524 Stereo, 2 channels (left, right).
 525 .It s16le:2.1
 526 3 channels (left, right, LFE).
 527 .It s16le:3.0
 528 3 channels (left, right, rear center).
 529 .It s16le:4.0
 530 Quadraphonic, 4 channels (front/rear left and right).
 531 .It s16le:4.1
 532 5 channels (4.0 + LFE).
 533 .It s16le:5.0
 534 5 channels (4.0 + center).
 535 .It s16le:5.1
 536 6 channels (4.0 + center + LFE).
 537 .It s16le:6.0
 538 6 channels (4.0 + front/rear center).
 539 .It s16le:6.1
 540 7 channels (6.0 + LFE).
 541 .It s16le:7.1
 542 8 channels (4.0 + center + LFE + left and right side).
 543 .El
 544 .It Va dev.pcm.%d.[play|rec].vchanmode
 545 .Tn VCHAN
 546 format/rate selection.
 547 Available options include:
 548 .Bl -tag -width 2n
 549 .It fixed
 550 Channel mixing is done using fixed format/rate.
 551 Advanced operations such as digital passthrough will not work.
 552 Can be considered as a
 553 .Dq legacy
 554 mode.
 555 This is the default mode for hardware channels which lack support for digital
 556 formats.
 557 .It passthrough
 558 Channel mixing is done using fixed format/rate, but advanced operations such
 559 as digital passthrough also work.
 560 All channels will produce sound as usual until a digital format playback is
 561 requested.
 562 When this happens all other channels will be muted and the latest incoming
 563 digital format will be allowed to pass through undisturbed.
 564 Multiple concurrent digital streams are supported, but the latest stream will
 565 take precedence and mute all other streams.
 566 .It adaptive
 567 Works like the
 568 .Dq passthrough
 569 mode, but is a bit smarter, especially for
 570 multiple
 571 .Nm
 572 channels with different format/rate.
 573 When a new channel is about to start, the entire list of virtual channels will
 574 be scanned, and the channel with the best format/rate (usually the
 575 highest/biggest) will be selected.
 576 This ensures that mixing quality depends on the best channel.
 577 The downside is that the hardware DMA mode needs to be restarted, which may
 578 cause annoying pops or clicks.
 579 .El
 580 .It Va dev.pcm.%d.[play|rec].vchanrate
 581 Sample rate speed for
 582 .Tn VCHAN
 583 mixing.
 584 All playback paths will be converted to this sample rate before the mixing
 585 process begins.
 586 .It Va dev.pcm.%d.polling
 587 Experimental polling mode support where the driver operates by querying the
 588 device state on each tick using a
 589 .Xr callout 9
 590 mechanism.
 591 Disabled by default and currently only available for a few device drivers.
 592 .El
 593 .Ss Recording Channels
 594 On devices that have more than one recording source (ie: mic and line),
 595 there is a corresponding
 596 .Pa /dev/dsp%d.r%d
 597 device.
 598 The
 599 .Xr mixer 8
 600 utility can be used to start and stop recording from an specific device.
 601 .Ss Statistics
 602 Channel statistics are only kept while the device is open.
 603 So with situations involving overruns and underruns, consider the output
 604 while the errant application is open and running.
 605 .Ss IOCTL Support
 606 The driver supports most of the
 607 .Tn OSS
 608 .Fn ioctl
 609 functions, and most applications work unmodified.
 610 A few differences exist, while memory mapped playback is
 611 supported natively and in
 612 .Tn Linux
 613 emulation, memory mapped recording is
 614 not due to
 615 .Tn VM
 616 system design.
 617 As a consequence, some applications may need to be recompiled
 618 with a slightly modified audio module.
 619 See
 620 .In sys/soundcard.h
 621 for a complete list of the supported
 622 .Fn ioctl
 623 functions.
 624 .Sh FILES
 625 The
 626 .Nm
 627 drivers may create the following
 628 device nodes:
 629 .Pp
 630 .Bl -tag -width ".Pa /dev/audio%d.%d" -compact
 631 .It Pa /dev/audio%d.%d
 632 Sparc-compatible audio device.
 633 .It Pa /dev/dsp%d.%d
 634 Digitized voice device.
 635 .It Pa /dev/dspW%d.%d
 636 Like
 637 .Pa /dev/dsp ,
 638 but 16 bits per sample.
 639 .It Pa /dev/dsp%d.p%d
 640 Playback channel.
 641 .It Pa /dev/dsp%d.r%d
 642 Record channel.
 643 .It Pa /dev/dsp%d.vp%d
 644 Virtual playback channel.
 645 .It Pa /dev/dsp%d.vr%d
 646 Virtual recording channel.
 647 .It Pa /dev/sndstat
 648 Current
 649 .Nm
 650 status, including all channels and drivers.
 651 .El
 652 .Pp
 653 The first number in the device node
 654 represents the unit number of the
 655 .Nm
 656 device.
 657 All
 658 .Nm
 659 devices are listed
 660 in
 661 .Pa /dev/sndstat .
 662 Additional messages are sometimes recorded when the
 663 device is probed and attached, these messages can be viewed with the
 664 .Xr dmesg 8
 665 utility.
 666 .Pp
 667 The above device nodes are only created on demand through the dynamic
 668 .Xr devfs 5
 669 clone handler.
 670 Users are strongly discouraged to access them directly.
 671 For specific sound card access, please instead use
 672 .Pa /dev/dsp
 673 or
 674 .Pa /dev/dsp%d .
 675 .Sh EXAMPLES
 676 Use the sound metadriver to load all
 677 .Nm
 678 bridge device drivers at once
 679 (for example if it is unclear which the correct driver to use is):
 680 .Pp
 681 .Dl kldload snd_driver
 682 .Pp
 683 Load a specific bridge device driver, in this case the Intel
 684 High Definition Audio driver:
 685 .Pp
 686 .Dl kldload snd_hda
 687 .Pp
 688 Check the status of all detected
 689 .Nm
 690 devices:
 691 .Pp
 692 .Dl cat /dev/sndstat
 693 .Pp
 694 Change the default sound device, in this case to the second device.
 695 This is handy if there are multiple
 696 .Nm
 697 devices available:
 698 .Pp
 699 .Dl sysctl hw.snd.default_unit=1
 700 .Sh DIAGNOSTICS
 701 .Bl -diag
 702 .It pcm%d:play:%d:dsp%d.p%d: play interrupt timeout, channel dead
 703 The hardware does not generate interrupts to serve incoming (play)
 704 or outgoing (record) data.
 705 .It unsupported subdevice XX
 706 A device node is not created properly.
 707 .El
 708 .Sh SEE ALSO
 709 .Xr snd_ad1816 4 ,
 710 .Xr snd_ai2s 4 ,
 711 .Xr snd_als4000 4 ,
 712 .Xr snd_atiixp 4 ,
 713 .Xr snd_audiocs 4 ,
 714 .Xr snd_cmi 4 ,
 715 .Xr snd_cs4281 4 ,
 716 .Xr snd_csa 4 ,
 717 .Xr snd_davbus 4 ,
 718 .Xr snd_ds1 4 ,
 719 .Xr snd_emu10k1 4 ,
 720 .Xr snd_emu10kx 4 ,
 721 .Xr snd_envy24 4 ,
 722 .Xr snd_envy24ht 4 ,
 723 .Xr snd_es137x 4 ,
 724 .Xr snd_ess 4 ,
 725 .Xr snd_fm801 4 ,
 726 .Xr snd_gusc 4 ,
 727 .Xr snd_hda 4 ,
 728 .Xr snd_hdspe 4 ,
 729 .Xr snd_ich 4 ,
 730 .Xr snd_maestro 4 ,
 731 .Xr snd_maestro3 4 ,
 732 .Xr snd_mss 4 ,
 733 .Xr snd_neomagic 4 ,
 734 .Xr snd_sbc 4 ,
 735 .Xr snd_solo 4 ,
 736 .Xr snd_spicds 4 ,
 737 .Xr snd_t4dwave 4 ,
 738 .Xr snd_uaudio 4 ,
 739 .Xr snd_via8233 4 ,
 740 .Xr snd_via82c686 4 ,
 741 .Xr snd_vibes 4 ,
 742 .Xr devfs 5 ,
 743 .Xr device.hints 5 ,
 744 .Xr loader.conf 5 ,
 745 .Xr dmesg 8 ,
 746 .Xr kldload 8 ,
 747 .Xr mixer 8 ,
 748 .Xr sysctl 8
 749 .Rs
 750 .%T "Cookbook formulae for audio EQ biquad filter coefficients, by Robert Bristow-Johnson"
 751 .%U "http://www.musicdsp.org/files/Audio-EQ-Cookbook.txt"
 752 .Re
 753 .Rs
 754 .%T "Julius O'Smith's Digital Audio Resampling"
 755 .%U "http://ccrma.stanford.edu/~jos/resample/"
 756 .Re
 757 .Rs
 758 .%T "Polynomial Interpolators for High-Quality Resampling of Oversampled Audio, by Olli Niemitalo"
 759 .%U "http://www.student.oulu.fi/~oniemita/dsp/deip.pdf"
 760 .Re
 761 .Rs
 762 .%T "The OSS API"
 763 .%U "http://www.opensound.com/pguide/oss.pdf"
 764 .Re
 765 .Sh HISTORY
 766 The
 767 .Nm
 768 device driver first appeared in
 769 .Fx 2.2.6
 770 as
 771 .Nm pcm ,
 772 written by
 773 .An Luigi Rizzo .
 774 It was later
 775 rewritten in
 776 .Fx 4.0
 777 by
 778 .An Cameron Grant .
 779 The API evolved from the VOXWARE
 780 standard which later became OSS standard.
 781 .Sh AUTHORS
 782 .An -nosplit
 783 .An Luigi Rizzo Aq luigi@iet.unipi.it
 784 initially wrote the
 785 .Nm pcm
 786 device driver and this manual page.
 787 .An Cameron Grant Aq gandalf@vilnya.demon.co.uk
 788 later revised the device driver for
 789 .Fx 4.0 .
 790 .An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp
 791 revised this manual page.
 792 It was then rewritten for
 793 .Fx 5.2 .
 794 .Sh BUGS
 795 Some features of your sound card (e.g., global volume control) might not
 796 be supported on all devices.