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