share/man/man4/uaudio.4

   1 .\" $NetBSD: uaudio.4,v 1.22 2005/06/22 04:30:08 kent Exp $
   2 .\"
   3 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Lennart Augustsson.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd June 22, 2005
  31 .Dt UAUDIO 4
  32 .Os
  33 .Sh NAME
  34 .Nm uaudio
  35 .Nd USB audio device driver
  36 .Sh SYNOPSIS
  37 .Cd "uaudio* at uhub?"
  38 .Cd "audio*  at audiobus?"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides support for
  43 .Tn USB
  44 audio class devices.
  45 .Pp
  46 A
  47 .Tn USB
  48 audio device consists of a number of components:
  49 input terminals (e.g. USB digital input), output terminals (e.g.
  50 speakers), and a number of units in between (e.g. volume control).
  51 The following types of units are handled by the
  52 .Nm
  53 driver and are accessible via the mixer (see
  54 .Xr audio 4 )
  55 interface:
  56 .Bl -tag -width Dv -offset 3n -compact
  57 .It mixer
  58 A mixer has a number of inputs and one output.  Each input has a control
  59 that determines its volume in the output.
  60 The name of the control is
  61 .Ar mixN-S ,
  62 where
  63 .Ar N
  64 is a number that identifies which mixer it is and
  65 .Ar S
  66 which input.
  67 .It selector
  68 A selector unit selects one of multiple audio sources such as mic-in
  69 and line-in.
  70 The name of the control is
  71 .Ar selN-S1S2S3... ,
  72 where
  73 .Ar N
  74 is a number that identifies which selector unit it is and the sequence of
  75 .Ar Sn
  76 indicates candidate units for the audio source.
  77 .It feature
  78 A feature unit changes the sound in some way, like bass, treble,
  79 mute, or volume.
  80 The name of the control is determined in a heuristic way.
  81 If the unit changes the sound to a speaker output terminal,
  82 the names of the controls may be outputs.speaker.bass, outputs.speaker.treble,
  83 outputs.speaker.mute, outputs.speaker, or likewise.
  84 .It processing
  85 A processing unit does one of a number of audio processing functions
  86 (e.g., channel up-down mixing, Dolby ProLogic, or chorus effects).
  87 The name of the on-off control is
  88 .Ar proN.M-enable ,
  89 where
  90 .Ar N
  91 is a number that identifies which processing unit it is and
  92 .Ar M
  93 which kind.
  94 Depending on the type of processing unit there may be other controls
  95 as well.
  96 .It extension
  97 An extension unit performs some unspecified audio processing
  98 The name of the on-off control is
  99 .Ar extN-enable ,
 100 where
 101 .Ar N
 102 is a number that identifies which processing unit it is.
 103 .El
 104 .Pp
 105 For more information the
 106 .Tn USB
 107 Audio class specification is indispensable
 108 reading.
 109 .Sh SEE ALSO
 110 The
 111 .Tn USB
 112 specifications can be found at:
 113 .Dv http://www.usb.org/developers/docs.html
 114 .Pp
 115 .Xr audio 4 ,
 116 .Xr usb 4
 117 .Sh HISTORY
 118 The
 119 .Nm
 120 driver
 121 appeared in
 122 .Nx 1.5 .
 123 .Sh BUGS
 124 There is no support for multiple-endpoints audio stream,
 125 adaptive recording, async playback, and TYPE-II/III formats.
 126 .Pp
 127 There is the possibility that a device has multiple mixer items
 128 which have the same name.