Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
.\"	$NetBSD: audio.4,v 1.104 2020/12/09 05:48:56 isaki Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by John T. Kohl.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd March 28, 2020
.Dt AUDIO 4
.Os
.Sh NAME
.Nm audio
.Nd device-independent audio driver layer
.Sh SYNOPSIS
.In sys/audioio.h
.Sh DESCRIPTION
The
.Nm
driver provides support for various audio peripherals.
It provides a uniform programming interface layer above different
underlying audio hardware drivers.
The audio layer provides full-duplex operation if the
underlying hardware configuration supports it.
.Pp
There are four device files available for audio operation:
.Pa /dev/audio ,
.Pa /dev/sound ,
.Pa /dev/audioctl ,
and
.Pa /dev/mixer .
.Pp
.Pa /dev/audio
and
.Pa /dev/sound
are used for recording or playback of digital samples.
.Pp
.Pa /dev/mixer
is used to manipulate volume, recording source, or other audio mixer
functions.
.Pp
.Pa /dev/audioctl
accepts the same
.Xr ioctl 2
operations as
.Pa /dev/sound ,
but no other operations.
It can be opened at any time and can be used to manipulate the
audio device while it is in use.
.Sh SAMPLING DEVICES
When
.Pa /dev/audio
is opened, it automatically sets the track to manipulate
monaural 8-bit mu-law 8000Hz.
When
.Pa /dev/sound
is opened, it maintains the audio format and pause/unpause
state of the most recently opened track.
In all other respects
.Pa /dev/audio
and
.Pa /dev/sound
are identical.
.Pp
On a full-duplex device, reads and writes may operate concurrently
without interference.
.Pp
On a half-duplex device, if there are any recording descriptors already,
opening with write mode will fail.
Similarly, if there are any playback descriptors already,
opening with read mode will fail.
If both playback and recording are requested on a half-duplex device,
it will be treated as playback mode.
.Pp
On either type of device, opening with write mode will start in playback mode,
opening with read mode will start in recording mode.
.Pp
If the playback mode is paused then silence is
played instead of the provided samples, and if recording is paused then
the process blocks in
.Xr read 2
until recording is unpaused.
.Pp
If a writing process does not call
.Xr write 2
frequently enough to provide samples at the pace the hardware
consumes them silence is inserted.
If a reading process does not call
.Xr read 2
frequently enough, it will simply miss samples.
.Pp
The audio driver supports track multiplexing.
All sampling devices can be opened at any time without interference.
For playback, all tracks opened simultaneously are mixed,
even if their specified format is different.
For recording, recorded data is distributed to all opened tracks,
even if their specified format is different.
To achieve this, the audio driver has a small efficient encoding converter,
a channel mixer, and a frequency converter.
The frequency conversion adapts the simplest way
(interpolation method for upward, and simple thinning method for downward)
due to restriction in kernel resources and processing time.
It will work well in most case but don't expect excessive quality.
.Pp
The audio device is normally accessed with
.Xr read 2
or
.Xr write 2
calls, but it can also be mapped into user memory with
.Xr mmap 2 .
Once the device has been mapped it can no longer be accessed
by read or write; all access is by reading and writing to
the mapped memory.
The mmap'ped buffer appears as a block of memory of size
.Va buffersize
(as available via
.Dv AUDIO_GETINFO
or
.Dv AUDIO_GETBUFINFO ) .
The audio driver will continuously move data from this buffer
from/to the mixing buffer, wrapping around at the end of the buffer.
To find out where the hardware is currently accessing data in the buffer the
.Dv AUDIO_GETIOFFS
and
.Dv AUDIO_GETOOFFS
calls can be used.
Note that
.Xr mmap 2
no longer maps hardware buffers directly.
Now it is achieved by emulation so don't expect any improvements excessively
rather than normal
.Xr write 2 .
For historical reasons, only encodings that are not set
.Dv AUDIO_ENCODINGFLAG_EMULATED
are able to
.Xr mmap 2 .
.Pp
The audio device, like most devices, can be used in
.Xr select 2 ,
can be set in non-blocking mode and can be set (with a
.Dv FIOASYNC
ioctl) to send a
.Dv SIGIO
when I/O is possible.
The mixer device can be set to generate a
.Dv SIGIO
whenever a mixer value is changed.
.Pp
The following
.Xr ioctl 2
commands are supported on the sample devices:
.Bl -tag -width indent
.It Dv AUDIO_FLUSH
This command stops all playback and recording, clears all queued
buffers, resets error counters on this track,
and restarts recording and playback as
appropriate for the current sampling mode.
.It Dv AUDIO_PERROR (int)
.It Dv AUDIO_RERROR (int)
This command fetches the count of dropped output (input)
bytes into its integer argument.
There is no information regarding when in the sample stream
they were dropped.
.It Dv AUDIO_WSEEK (u_long)
This command fetches the count of bytes that are queued ahead of the
first sample in the most recent sample block written into its integer argument.
.It Dv AUDIO_DRAIN
This command suspends the calling process until all queued playback
samples have been played.
.It Dv AUDIO_GETDEV (audio_device_t)
This command fetches the current hardware device information into the
.Vt audio_device_t
argument.
.Bd -literal
typedef struct audio_device {
        char name[MAX_AUDIO_DEV_LEN];
        char version[MAX_AUDIO_DEV_LEN];
        char config[MAX_AUDIO_DEV_LEN];
} audio_device_t;
.Ed
.It Dv AUDIO_GETENC (audio_encoding_t)
This command is used iteratively to fetch sample encoding names and
format ids into the input/output audio_encoding_t argument.
The encoding returned by the command is user accessible encoding and
is not hardware supported encoding.
.Bd -literal
typedef struct audio_encoding {
	int index;      /* input: nth encoding */
	char name[MAX_AUDIO_DEV_LEN]; /* name of encoding */
	int encoding;   /* value for encoding parameter */
	int precision;  /* value for precision parameter */
	int flags;
#define AUDIO_ENCODINGFLAG_EMULATED 1 /* software emulation mode */
} audio_encoding_t;
.Ed
.Pp
To query
all the supported encodings, start with an index field of 0 and
continue with successive encodings (1, 2, ...) until the command returns
an error.
.It Dv AUDIO_GETFD (int)
This command is obsolete.
.It Dv AUDIO_SETFD (int)
This command is obsolete.
.It Dv AUDIO_GETPROPS (int)
This command gets a bit set of hardware properties.
If the hardware
has a certain property the corresponding bit is set, otherwise it is not.
The properties can have the following values:
.Pp
.Bl -tag -width AUDIO_PROP_INDEPENDENT -compact
.It Dv AUDIO_PROP_FULLDUPLEX
the device admits full duplex operation.
.It Dv AUDIO_PROP_MMAP
the device can be used with
.Xr mmap 2 .
.It Dv AUDIO_PROP_INDEPENDENT
the device can set the playing and recording encoding parameters
independently.
.It Dv AUDIO_PROP_PLAYBACK
the device is capable of audio playback.
.It Dv AUDIO_PROP_CAPTURE
the device is capable of audio capture.
.El
.It Dv AUDIO_GETIOFFS (audio_offset_t)
.It Dv AUDIO_GETOOFFS (audio_offset_t)
This command fetches the current offset in the input(output) buffer where
the track mixer will be putting(getting) data.
It mostly useful when the device
buffer is available in user space via the
.Xr mmap 2
call.
The information is returned in the
.Vt audio_offset_t
structure.
.Bd -literal
typedef struct audio_offset {
	u_int	samples;   /* Total number of bytes transferred */
	u_int	deltablks; /* Blocks transferred since last checked */
	u_int	offset;    /* Physical transfer offset in buffer */
} audio_offset_t;
.Ed
.It Dv AUDIO_GETINFO (audio_info_t)
.It Dv AUDIO_GETBUFINFO (audio_info_t)
.It Dv AUDIO_SETINFO (audio_info_t)
Get or set audio information as encoded in the audio_info structure.
For historical reasons, the audio_info structure has three different
layer's parameters: track, track mixer and hardware rich mixer.
.Bd -literal
typedef struct audio_info {
	struct	audio_prinfo play;   /* info for play (output) side */
	struct	audio_prinfo record; /* info for record (input) side */
        u_int	monitor_gain;			/* input to output mix [HWmixer] */
	/* BSD extensions */
	u_int	blocksize;	/* read/write block size [track] */
	u_int	hiwat;		/* output high water mark [track] */
	u_int	lowat;		/* output low water mark [track] */
	u_int	_ispare1;
	u_int	mode;		/* current operation mode [track] */
#define AUMODE_PLAY	0x01
#define AUMODE_RECORD	0x02
#define AUMODE_PLAY_ALL 0x04	/* Not used anymore */
} audio_info_t;
.Ed
.Pp
When setting the current state with
.Dv AUDIO_SETINFO ,
the audio_info structure should first be initialized with
.Li AUDIO_INITINFO(&info)
and then the particular values to be changed should be set.
This allows the audio driver to only set those things that you wish
to change and eliminates the need to query the device with
.Dv AUDIO_GETINFO
or
.Dv AUDIO_GETBUFINFO
first.
.Pp
The
.Va mode
field indicates current operation mode, either one of
.Dv AUMODE_PLAY
or
.Dv AUMODE_RECORD .
These two flags can not be changed once this descriptor is opened.
For playback mode, the obsolete
.Dv AUMODE_PLAY_ALL
flag can be set but has no effect.
.Pp
.Va hiwat
and
.Va lowat
are used to control write behavior.
Writes to the audio devices will queue up blocks until the high-water
mark is reached, at which point any more write calls will block
until the queue is drained to the low-water mark.
.Va hiwat
and
.Va lowat
set those high- and low-water marks (in audio blocks).
The default for
.Va hiwat
is the maximum value and for
.Va lowat
75% of
.Va hiwat .
.Pp
.Va blocksize
sets the current audio blocksize.
The generic audio driver layer and the hardware driver have the
opportunity to adjust this block size to get it within
implementation-required limits.
Normally the
.Va blocksize
is calculated to correspond to the value of the
.Em hw.audioX.blk_ms
sysctl and is recalculated when the encoding parameters change.
If the descriptor is opened for read only,
.Va blocksize
indicates the blocksize for the recording track.
Otherwise,
.Va blocksize
indicates the blocksize for the playback track.
.Bd -literal
struct audio_prinfo {
	u_int	sample_rate;	/* sample rate in samples/s [track] */
	u_int	channels;	/* number of channels, usually 1 or 2 [track] */
	u_int	precision;	/* number of bits/sample [track] */
	u_int	encoding;	/* data encoding (AUDIO_ENCODING_* below) [track] */
	u_int	gain;		/* volume level [HWmixer] */
	u_int	port;		/* selected I/O port [HWmixer] */
	u_long	seek;		/* BSD extension [track] */
	u_int	avail_ports;	/* available I/O ports [HWmixer] */
	u_int	buffer_size;	/* total size audio buffer [track] */
	u_int	_ispare[1];
	u_int	samples;	/* number of samples [track] */
	u_int	eof;		/* End Of File (zero-size writes) counter [track] */
	u_char	pause;		/* non-zero if paused, zero to resume [track] */
	u_char	error;		/* non-zero if underflow/overflow occurred [track] */
	u_char	waiting;	/* non-zero if another process hangs in open [track] */
	u_char	balance;	/* stereo channel balance [HWmixer] */
	u_char	cspare[2];
	u_char	open;		/* non-zero if currently open [trackmixer] */
	u_char	active;		/* non-zero if I/O is currently active [trackmixer] */
};
.Ed
.Pp
Note: many hardware audio drivers require identical playback and
recording sample rates, sample encodings, and channel counts.
The playing information is always set last and will prevail on such hardware.
If the hardware can handle different settings the
.Dv AUDIO_PROP_INDEPENDENT
property is set.
.Pp
The encoding parameter can have the following values:
.Pp
.Bl -tag -width AUDIO_ENCODING_SLINEAR_BE -compact
.It Dv AUDIO_ENCODING_ULAW
mu-law encoding, 8 bits/sample
.It Dv AUDIO_ENCODING_ALAW
A-law encoding, 8 bits/sample
.It Dv AUDIO_ENCODING_SLINEAR
two's complement signed linear encoding with the platform byte order
.It Dv AUDIO_ENCODING_ULINEAR
unsigned linear encoding
with the platform byte order
.It Dv AUDIO_ENCODING_ADPCM
ADPCM encoding, 8 bits/sample
.It Dv AUDIO_ENCODING_SLINEAR_LE
two's complement signed linear encoding with little endian byte order
.It Dv AUDIO_ENCODING_SLINEAR_BE
two's complement signed linear encoding with big endian byte order
.It Dv AUDIO_ENCODING_ULINEAR_LE
unsigned linear encoding with little endian byte order
.It Dv AUDIO_ENCODING_ULINEAR_BE
unsigned linear encoding with big endian byte order
.It Dv AUDIO_ENCODING_AC3
Dolby Digital AC3
.El
.Pp
The
.Nm
driver accepts the following formats.
.Va encoding
and
.Va precision
are one of the values obtained by
.Dv AUDIO_GETENC ,
regardless of formats supported by underlying driver.
.Va frequency
ranges from 1000Hz to 192000Hz,
regardless of frequency (ranges) supported by underlying driver.
.Va channels
depends your underlying driver.
If the underlying driver only supports monaural (1channel)
or stereo (2channels), you can specify 1 or 2 regardless of
number of channels supported by underlying driver.
If the underlying driver supports three or more channels, you can specify
the number of channels supported by the underlying driver or less.
.Pp
The
.Va gain ,
.Va port
and
.Va balance
settings provide simple shortcuts to the richer mixer
interface described below and are not obtained by
.Dv AUDIO_GETBUFINFO .
The gain should be in the range
.Bq Dv AUDIO_MIN_GAIN , Dv AUDIO_MAX_GAIN
and the balance in the range
.Bq Dv AUDIO_LEFT_BALANCE , Dv AUDIO_RIGHT_BALANCE
with the normal setting at
.Dv AUDIO_MID_BALANCE .
.Pp
The input port should be a combination of:
.Pp
.Bl -tag -width AUDIO_MICROPHONE -compact
.It Dv AUDIO_MICROPHONE
to select microphone input.
.It Dv AUDIO_LINE_IN
to select line input.
.It Dv AUDIO_CD
to select CD input.
.El
.Pp
The output port should be a combination of:
.Pp
.Bl -tag -width AUDIO_HEADPHONE -compact
.It Dv AUDIO_SPEAKER
to select speaker output.
.It Dv AUDIO_HEADPHONE
to select headphone output.
.It Dv AUDIO_LINE_OUT
to select line output.
.El
.Pp
The available ports can be found in
.Va avail_ports
.Dv ( AUDIO_GETBUFINFO
only).
.Pp
.Va buffer_size
is the total size of the audio buffer.
The buffer size divided by the
.Va blocksize
gives the maximum value for
.Va hiwat .
Currently the
.Va buffer_size
can only be read and not set.
.Pp
The
.Va seek
and
.Va samples
fields are only used by
.Dv AUDIO_GETINFO
and
.Dv AUDIO_GETBUFINFO .
.Va seek
represents the count of
bytes pending;
.Va samples
represents the total number of bytes recorded or played, less those
that were dropped due to inadequate consumption/production rates.
.Pp
.Va pause
returns the current pause/unpause state for recording or playback.
For
.Dv AUDIO_SETINFO ,
if the pause value is specified it will either pause
or unpause the particular direction.
.It Dv AUDIO_QUERYFORMAT (audio_format_query_t)
This command enumerates formats supported by the hardware.
Similarly to
.Dv AUDIO_GETENC ,
to query all the supported formats,
start with an index field of 0 and continue with successive formats
(1, 2, ...) until the command returns an error.
.Bd -literal
typedef struct audio_format_query {
	u_int	index;
	struct audio_format fmt;
} audio_format_query_t;
.Ed
.It Dv AUDIO_GETFORMAT (audio_info_t)
This command fetches the current hardware format.
Only the following members in audio_info_t are used.
Members which are not listed here or belong in invalid direction are
filled by \-1.
.Bl -bullet
.It
mode
.It
play.encoding
.It
play.precision
.It
play.channels
.It
play.sample_rate
.It
record.encoding
.It
record.precision
.It
record.channels
.It
record.sample_rate
.El
.Pp
.Va mode
indicates which direction is valid.
.It Dv AUDIO_SETFORMAT (audio_info_t)
This command sets the hardware format.
It will fail if there are any opened descriptors.
So obviously, it must be issued on
.Pa /dev/audioctl .
Similarly to
.Dv AUDIO_GETFORMAT ,
only above members in audio_info_t are used.
Members which is not listed or belong in invalid direction are ignored.
The parameters can be chosen from the choices obtained by
.Dv AUDIO_QUERYFORMAT .
.It Dv AUDIO_GETCHAN (int)
This command is obsolete.
.It Dv AUDIO_SETCHAN (int)
This command is obsolete.
.El
.Sh MIXER DEVICE
The mixer device,
.Pa /dev/mixer ,
may be manipulated with
.Xr ioctl 2
but does not support
.Xr read 2
or
.Xr write 2 .
It supports the following
.Xr ioctl 2
commands:
.Bl -tag -width indent
.It Dv AUDIO_GETDEV (audio_device_t)
This command is the same as described above for the sampling devices.
.It Dv AUDIO_MIXER_READ (mixer_ctrl_t)
.It Dv AUDIO_MIXER_WRITE (mixer_ctrl_t)
These commands read the current mixer state or set new mixer state for
the specified device
.Va dev .
.Va type
identifies which type of value is supplied in the
.Vt mixer_ctrl_t
argument.
.Bd -literal
#define AUDIO_MIXER_CLASS  0
#define AUDIO_MIXER_ENUM   1
#define AUDIO_MIXER_SET    2
#define AUDIO_MIXER_VALUE  3
typedef struct mixer_ctrl {
	int dev;			/* input: nth device */
	int type;
	union {
		int ord;		/* enum */
		int mask;		/* set */
		mixer_level_t value;	/* value */
	} un;
} mixer_ctrl_t;

#define AUDIO_MIN_GAIN  0
#define AUDIO_MAX_GAIN  255
typedef struct mixer_level {
        int num_channels;
        u_char level[8];               /* [num_channels] */
} mixer_level_t;
#define AUDIO_MIXER_LEVEL_MONO  0
#define AUDIO_MIXER_LEVEL_LEFT  0
#define AUDIO_MIXER_LEVEL_RIGHT 1
.Ed
.Pp
For a mixer value, the
.Va value
field specifies both the number of channels and the values for each
channel.
If the channel count does not match the current channel count, the
attempt to change the setting may fail (depending on the hardware
device driver implementation).
For an enumeration value, the
.Va ord
field should be set to one of the possible values as returned by a prior
.Dv AUDIO_MIXER_DEVINFO
command.
The type
.Dv AUDIO_MIXER_CLASS
is only used for classifying particular mixer device
types and is not used for
.Dv AUDIO_MIXER_READ
or
.Dv AUDIO_MIXER_WRITE .
.It Dv AUDIO_MIXER_DEVINFO (mixer_devinfo_t)
This command is used iteratively to fetch audio mixer device information
into the input/output
.Vt mixer_devinfo_t
argument.
To query all the supported devices, start with an index field of
0 and continue with successive devices (1, 2, ...) until the
command returns an error.
.Bd -literal
typedef struct mixer_devinfo {
	int index;		/* input: nth mixer device */
	audio_mixer_name_t label;
	int type;
	int mixer_class;
	int next, prev;
#define AUDIO_MIXER_LAST	-1
	union {
		struct audio_mixer_enum {
			int num_mem;
			struct {
				audio_mixer_name_t label;
				int ord;
			} member[32];
		} e;
		struct audio_mixer_set {
			int num_mem;
			struct {
				audio_mixer_name_t label;
				int mask;
			} member[32];
		} s;
		struct audio_mixer_value {
			audio_mixer_name_t units;
			int num_channels;
			int delta;
		} v;
	} un;
} mixer_devinfo_t;
.Ed
.Pp
The
.Va label
field identifies the name of this particular mixer control.
The
.Va index
field may be used as the
.Va dev
field in
.Dv AUDIO_MIXER_READ
and
.Dv AUDIO_MIXER_WRITE
commands.
The
.Va type
field identifies the type of this mixer control.
Enumeration types are typically used for on/off style controls (e.g. a
mute control) or for input/output device selection (e.g. select
recording input source from CD, line in, or microphone).
Set types are similar to enumeration types but any combination
of the mask bits can be used.
.Pp
The
.Va mixer_class
field identifies what class of control this is.
The
.Pq arbitrary
value set by the hardware driver may be determined by examining the
.Va mixer_class
field of the class itself,
a mixer of type
.Dv AUDIO_MIXER_CLASS .
For example, a mixer controlling the input gain on the line in circuit
would have a
.Va mixer_class
that matches an input class device with the name
.Dq inputs
.Dv ( AudioCinputs ) ,
and would have a
.Va label
of
.Dq line
.Dv ( AudioNline ) .
Mixer controls which control audio circuitry for a particular audio
source (e.g. line-in, CD in, DAC output) are collected under the input class,
while those which control all audio sources (e.g. master volume,
equalization controls) are under the output class.
Hardware devices capable of recording typically also have a record class,
for controls that only affect recording,
and also a monitor class.
.Pp
The
.Va next
and
.Va prev
may be used by the hardware device driver to provide hints for the next
and previous devices in a related set (for example, the line in level
control would have the line in mute as its
.Dq next
value).
If there is no relevant next or previous value,
.Dv AUDIO_MIXER_LAST
is specified.
.Pp
For
.Dv AUDIO_MIXER_ENUM
mixer control types,
the enumeration values and their corresponding names are filled in.
For example, a mute control would return appropriate values paired with
.Dv AudioNon
and
.Dv AudioNoff .
For
.Dv AUDIO_MIXER_VALUE
and
.Dv AUDIO_MIXER_SET
mixer control types, the channel count is
returned; the units name specifies what the level controls (typical
values are
.Dv AudioNvolume ,
.Dv AudioNtreble ,
.Dv AudioNbass ) .
.\" For AUDIO_MIXER_SET mixer control types, what is what?
.El
.Pp
By convention, all the mixer devices can be distinguished from other
mixer controls because they use a name from one of the
.Dv AudioC*
string values.
.Sh FILES
.Bl -tag -width /dev/audioctl -compact
.It Pa /dev/audio
.It Pa /dev/audioctl
.It Pa /dev/sound
.It Pa /dev/mixer
.El
.Sh SEE ALSO
.Xr audiocfg 1 ,
.Xr audioctl 1 ,
.Xr audioplay 1 ,
.Xr audiorecord 1 ,
.Xr mixerctl 1 ,
.Xr ioctl 2 ,
.Xr ossaudio 3 ,
.Xr acorn32/vidcaudio 4 ,
.\" .Xr amiga/aucc 4 ,
.\" .Xr amiga/melody 4 ,
.Xr arcofi 4 ,
.Xr aria 4 ,
.Xr auacer 4 ,
.Xr audiocs 4 ,
.Xr auich 4 ,
.Xr auixp 4 ,
.\" .Xr ausoc 4 ,
.Xr autri 4 ,
.Xr auvia 4 ,
.Xr bba 4 ,
.Xr btsco 4 ,
.Xr clcs 4 ,
.Xr clct 4 ,
.Xr cmpci 4 ,
.Xr dreamcast/aica 4 ,
.Xr eap 4 ,
.Xr emuxki 4 ,
.Xr esa 4 ,
.Xr esm 4 ,
.Xr eso 4 ,
.Xr ess 4 ,
.\" .Xr evbarm/aaci 4 ,
.\" .Xr evbarm/digfilt 4 ,
.\" .Xr evbarm/pxaacu 4 ,
.\" .Xr evbarm/udassio 4 ,
.Xr fms 4 ,
.Xr gcscaudio 4 ,
.Xr gus 4 ,
.Xr guspnp 4 ,
.Xr hdafg 4 ,
.Xr hdaudio 4 ,
.Xr hppa/harmony 4 ,
.Xr macppc/awacs 4 ,
.Xr macppc/snapper 4 ,
.Xr midi 4 ,
.Xr neo 4 ,
.Xr pad 4 ,
.Xr pas 4 ,
.\" .Xr paud 4 ,
.Xr radio 4 ,
.\" .Xr repluse 4 ,
.Xr sb 4 ,
.Xr sgimips/haltwo 4 ,
.Xr sgimips/mavb 4 ,
.Xr sparc/audioamd 4 ,
.Xr sparc/dbri 4 ,
.Xr sv 4 ,
.\" .Xr toccata 4 ,
.Xr uaudio 4 ,
.\" .Xr vaudio 4 ,
.\" .Xr vcaudio 4 ,
.\" .Xr vraiu 4 ,
.\" .Xr vsaudio 4 ,
.Xr wss 4 ,
.Xr x68k/vs 4 ,
.Xr yds 4 ,
.Xr ym 4
.\" .Xr zaudio 4
.Sh HISTORY
Support for virtual channels and mixing first appeared in
.Nx 8.0 .
.Sh BUGS
If the device is used in
.Xr mmap 2
it is currently always mapped for writing (playing) due to VM system weirdness.