xref: /netbsd-src/share/man/man4/uaudio.4 (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1.\" $NetBSD: uaudio.4,v 1.15 2002/02/12 19:53:57 jdolecek 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd July 12, 1998
38.Dt UAUDIO 4
39.Os
40.Sh NAME
41.Nm uaudio
42.Nd USB audio device driver
43.Sh SYNOPSIS
44.Cd "uaudio* at uhub?"
45.Cd "audio*  at uaudio?"
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for
50.Tn USB
51audio class devices.
52.Pp
53A
54.Tn USB
55audio device consists of a number of components:
56input terminals (e.g. USB digital input), output terminals (e.g.
57speakers), and a number of units in between (e.g. volume control).
58The following types of units are handled by the
59.Nm
60driver and are accessible via the mixer (see
61.Xr audio 4 )
62interface:
63.Bl -tag -width Dv -offset 3n -compact
64.It mixer
65A mixer has a number of inputs and one output.  Each input has a control
66that determines its volume in the output.
67The name of the control is
68.Ar mixN-S ,
69where
70.Ar N
71is a number that identifies which mixer it is and
72.Ar S
73which input.
74.It selector
75Not implemented yet.
76.It feature
77A feature unit changes the sound in some way, like bass, treble, or
78volume.
79The name of the control is
80.Ar feaN-S-F ,
81where
82.Ar N
83is a number that identifies which feature unit it is,
84.Ar S
85which input, and
86.Ar F
87which feature is affected.
88.It processing
89A processing unit does one of a number of audio processing functions
90(e.g., channel up-down mixing, Dolby ProLogic, or chorus effects).
91The name of the on-off control is
92.Ar proN.M-enable ,
93where
94.Ar N
95is a number that identifies which processing unit it is and
96.Ar M
97which kind.
98Depending on the type of processing unit there may be other controls
99as well.
100.It extension
101An extension unit performs some unspecified audio processing
102The name of the on-off control is
103.Ar extN-enable ,
104where
105.Ar N
106is a number that identifies which processing unit it is.
107.El
108.Pp
109For more information the
110.Tn USB
111Audio class specification is indispensable
112reading.
113.Sh SEE ALSO
114The
115.Tn USB
116specifications can be found at:
117.Dv http://www.usb.org/developers/docs.html
118.Pp
119.Xr audio 4 ,
120.Xr usb 4
121.Sh HISTORY
122The
123.Nm
124driver
125appeared in
126.Nx 1.5 .
127.Sh BUGS
128The mixer interface is really incomplete.
129.Pp
130There should be some heuristics that allows important controls,
131e.g., volume, to be identified and given its traditional name.
132