ossaudio(3): refactor library into separate files

fix typo, WARNS=5

These directories don't handle WARNS=5

branches: 1.8.6; 1.8.8;
Remove USETBL, now that man page does not need tbl any longer.

branches: 1.7.2;
Add a table that describes the mappings from native audio mixer names
to their OSS equivalents.

drop whitespace

use CPPFLAGS not CFLAGS

back out last change

don't build shared library

Install the "soundcard.h" include file in /usr/include, because:
- The documentation says <soundcard.h>, and
- You can't install an include into /usr/include/sys, because the user
might be using "symlinks" for the sys includes.

Initial version of a user level emulation of the OSS audio API.
Useful for compiling Linux audio programs.

branches: 1.1.2;
file Version.map was initially added on branch agc-symver.

ossaudio(3): refactor library into separate files

ossaudio(3): refactor library into separate files

ossaudio(3): refactor library into separate files

Fix various typos in comments.

ossaudio(3): refactor library into separate files

ossaudio(3): continue getting capabilities if AUDIO_GETFORMAT fails

we want this to work on mixer devices too

ossaudio(3): refactor library into separate files

ossaudio(3): nested switch statements are hard to read, refactor

ossaudio(3): refactor library into separate files

ossaudio(3): refactor library into separate files

lib: Mark up error names in man pages with .Er

Remove trailing whitespace.

ossaudio.3: Bump date

ossaudio(3): Turn BUGS section into a list of potential compat issues

Use Fx and Nx. End Rs block. Remove trailing whitespace.
Remove unnecessary Pp.

ossaudio.3: note this is most/all of ossv3 and some of ossv4

ossaudio.3: Sort sections.

ossaudio.3: More information about the history and status of this API

Use .Bl -column instead of tbl(1) for the device mapping list.
OK jmcneill@

branches: 1.19.2;
Bump date for previous.

Add a table that describes the mappings from native audio mixer names
to their OSS equivalents.

Convert TNF licenses to new 2 clause variant

branches: 1.16.30;
Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

New sentence, new line. From Robert Elz.

Improve markup, sort sections.

Generate <>& symbolically.

Use EAGAIN instead of EWOULDBLOCK. The actual numeric value is
same, but EAGAIN is the posixly correct name.
Addresses misc/12960.

remove extra period in SEE ALL section

More trailing white space.

Make copyrights conform.

branches: 1.8.2;
Last of the .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Wheee!

Xref midi(4).

add LIBRARY section to man page

Fix a serious emulation bug.
Add some missing #defines.
Add a little more documentation.

Add some missing defines and add history to man page.

branches: 1.3.2;
Remove a copied line.

Add some bugs to the man page.

Initial version of a user level emulation of the OSS audio API.
Useful for compiling Linux audio programs.

ossaudio(3): refactor library into separate files

ossaudio: Set handle on OSSv4 mixer devices

libossaudio: Various OSSv4 fixes to allow reference programs to compile

- Define various new AFMT_*. These are not returned as supported
formats by SNDCTL_DSP_GETFMTS, because it would be very silly to
have Vorbis in the kernel.

- Implement PLAYTGT and RECSRC. For each NetBSD audio device
we only return one playback and recording source, "primary".

- Return preferred channel configuration in capabilities.
Either DSP_CH_STEREO, DSP_CH_MONO, or DSP_CH_MULTI
depending on the current hardware format.

- SNDCTL_DSP_HALT_* simply flushes the audio device.

branches: 1.66.2;
ossv4 mixer API: be extra careful with the inputs to AUDIO_MIXER_READ.

some drivers (not hdaudio(4), but uaudio(4), eap(4), sb(4), various other
old cards) will return error if a AUDIO_MIXER_VALUE is requested and the
number of channels is not specified as input. this is not documented as
well as it should be, unfortunately.

ossaudio(3): Do not reuse results from AUDIO_GETBUFINFO in SETINFO

Should help PR 55876.

ossaudio(3): Clone some useful behaviour from the Solaris kernel

Both SNDCTL_DSP_SPEED and SNDCTL_DSP_CHANNELS support a special value
0 to "query the configured value without changing it". In our case,
this actually means setting and querying the hardware rate.

I don't know if OSSv3 or FreeBSD or other implementations also do this.
But it seems safe and sensible to support.

ossaudio(3): Set errno and return -1 rather than returning errno.

ossaudio(3): Reduce code duplication for querying capabilities

ossaudio(3): Return device playback and capture capabilities in GETCAPS

ossaudio(3): return correctly initialized return value in unlikely
error case. pointed out by tnn.

ossaudio(3): Simplify setting rate (try to supply the nearest one possible)

libossaudio: return newfd here as we return retval elsewhere

Fix typo in comment.

ossaudio(3): Add an implementation of SNDCTL_CARDINFO

Correct some of the counts returned by SNDCTL_SYSINFO so this works.

ossaudio(3): This is not compat_linux

ossaudio(3): Add SNDCTL_AUDIOINFO_EX as an alias of SNDCTL_AUDIOINFO

ossaudio(3): Plug a fd leak in the new mixer API

ossaudio(3): add some no-op defines for ossv4 compat.

ossaudio(3): these ioctls need to return samples, not bytes

ossaudio(3): Add SNDCTL_DSP_CURRENT_(I|O)PTR

In OSSv4 these are supposed to avoid the wrapping problems with the
older GET(I|O)PTR ioctls but we don't quite get the same benefit here.

XXX: We could probably fake it by maintaining some state in-between calls.

ossaudio(3): Add initial support for the OSSv4.1 Mixer API

One or two calls from this API were supported previously and have been
moved to the correct place.

Mapping the controls correctly is a difficult task. There is a define
hidden in the OSS headers that would allow an AUDIO_MIXER_SET control
to be represented perfectly, but it seems to _only_ exist there, and
no software supports it. So for now only one member of a set can be
set at a time - unfortunate. I've hidden code that should unlock
doing this the proper way under #notyet.

I'm not too happy with the way this code is managing file descriptors.
Currently it has to open a new fd for each ioctl due to OSSv4 deciding
to specify the device number in a structure rather than in the filename.
In the future, we could reuse the file descriptor if the correct one is
detected open.

This allows the mixer programs provided with the OSSv4 sources to compile
and work cleanly. I've observed problems with it failing to work on
secondary devices, and should investigate this later. There may be
a fd leak somewhere.

ossaudio(3): Add SNDCTL_DSP_COOKEDMODE, SNDCTL_DSP_GETERROR

SNDCTL_DSP_COOKEDMODE simply always returns 1.
"Cooked mode" is a silly way the OSSv4 authors chose to refer to allowing
for reprocessed streams. The NetBSD kernel always performs format
conversion and it can't be turned off.

SNDCTL_DSP_GETERROR provides access to the read/write over/underrun
counters. There are other things it might return, but they don't make
sense for our implementation.

ossaudio: Bump copyright date and improve description.

ossaudio: Add comments for the more obscure parts of SNDCTL_AUDIOINFO

ossaudio: Various OSSv4 fixes for SNDCTL_AUDIOINFO

- Per OSSv4, make this ioctl work on the main mixer device.
Since the native NetBSD API uses queries on individual audio devices,
we have to reopen the correct audio device specified in the input to the
ioctl and fetch information from that.
- Correctly return whether the device is for playback, capture, or both.
- Return the full name of the device in the name field.
- The "handle" has to be a globally unique identifier. The closest thing
we have to that is device numbers, so use device numbers.
- Return reasonable values in min_rate/max_rate and min_channels/max_channels.

This should allow Mumble's device enumeration to work with a lot less
patching.

ossaudio: removed outdated comment

ossaudio: Implement SNDCTL_DSP_(SET|GET)TRIGGER.

ossaudio: Make SNDCTL_DSP_[GET|SET][PLAY|RECORD]VOL closer to OSSv4

Problems in the previous code include returning values in the 0-255
range NetBSD uses instead of the 0-100 range OSSv4 expects, using
AUDIO_GETBUFINFO (which doesn't even return the mixer bits), and
not encoding channels as specified: "level=(left)|(right << 8)".

In reality, setting the gain in this way (through /dev/audio rather
than /dev/mixer) doesn't seem to work properly, and the mixer-set
value seems to be retained.

However, these changes at least ensure that the return values are
correct and the balance is set correctly.

I've only found one application using this API (audio/audacious), and
OSSv4 support in it is currently disabled precisely because it breaks
when it attempts to set the track volume using it.

ossaudio: If the user's channel count is rejected, use the hardware count

ossaudio: Make SNDCTL_DSP_SETFMT conform with OSSv4.

The OSSv4 spec says we shouldn't really error if an invalid format is
chosen by an application. Things are especially likely to be confused
if we return MULAW, since in OSSv4 terms that means that's the native
hardware format. Instead, set and return the current hardware format
if an invalid format is chosen.

For the 24-bit sample formats, note that the NetBSD kernel currently
can't handle them in its default configuration, and will return an error
code if you attempt to use them. So, if an applicaton requests 24-bit PCM,
promote it to 32-bit PCM. According to the spec, this is valid and
applications should be checking the return value anyway.

In the Linux compat layer, we just use S16LE as a fallback. The OSSv3
headers that are still being shipped with Linux don't contain definitions
for fancier formats and we can reasonably expect all applications to
support S16LE.

ossaudio: Make SNDCTL_DSP_SPEED more robust when using invalid rates.

From the perspective of reading the OSSv4 specification, NetBSD's
behaviour when an invalid sample rate is set makes no sense at all:
AUDIO_SETINFO simply returns an error code, and then we immediately
fall through to getting the sample rate, which is still set to the
legacy default of 8000 Hz.

Instead, what OSS applications generally expect is that they will be
able to receive the actual hardware sample rate. This is very, very
unlikely to be 8000 Hz on a modern machine.

No functional change when setting a sample rate between the supported
rates of 1000 and 192000 Hz. When a rate outside this range is requested,
the hardware rate is returned (on modern hardware, generally always 48000
Hz or a multiple of 48000 Hz).

Use record field for recording even on
SNDCTL_DSP_STEREO, SNDCTL_DSP_SETFMT, and SNDCTL_DSP_CHANNELS.

Use record.sample_rate for recording on SNDCTL_DSP_SPEED.
Fix PR lib/54667.

branches: 1.36.2;
Fix minor bugs of SNDCTL_DSP_GETISPACE.
- hiwat is playback-only parameter.
- 'bytes' should not be rounded down.

Revert a wrong SNDCTL_DSP_GETOSPACE part of rev1.33.
- 'fragments' is the number of full free blocks and should not be
negative value.
- 'bytes' should not be rounded down.
It makes mpv work correctly (fixes a second half of kern/53028).
Reviewed by mlelstv@

memset to zero the entire array, not just 8 bytes of it.

picked up by gcc7's checker that the array size has not
been multipled by the member size.

here, we had 8 but should have had 8 * sizeof(int).

XXX: real bug - pullup-7, pullup-8

branches: 1.33.4; 1.33.10; 1.33.12;
Calculate GETISPACE/GETOSPACE properly.
Bump version.

Addresses PR kern/51999.

speed limit is 80 (missed this one)

strncpy->strlcpy. use sizeof instead of numbers.

branches: 1.30.2; 1.30.4;
Add missing defines for 16, 24 and 32 bit NE and OE formats.
Add the ability to set 24 and 32 bit precision.

This commit was approved by wiz@

branches: 1.29.2;
Adds ioctls and defines for OSSv4 compatibility.

The ioctl definitions and accompanying structures were
taken from FreeBSD's soundcard.h, hopefully providing
some binary compatibility.

The ioctls are as follows:
SNDCTL_SYSINFO: Returns a structure containing
details about the audio device.
SNDCTL_ENGINEINFO - SNDCTL_AUDIOINFO: Returns a
structure with playback/recording
characteristics.
SNDCTL_DSP_GETPLAYVOL, SNDCTL_DSP_SETPLAYVOL,
SNDCTL_DSP_GETRECVOL, SNDCTL_DSP_SETRECVOL:
Retrieves/Sets Playback/Recording volume.
SNDCTL_DSP_SKIP - SNDCTL_DSP_SILENCE: These ioctls
were intended to manipulate the underlying
audio buffer skip or insert silence. These
return EINVAL.

SOUND_VERSION is unchanged, but is definable, It will be
changed when the mixer OSSv4 ioctls are written.

Addresses PR 46611
This commit was approved by wiz@.

branches: 1.28.2; 1.28.8;
fix typo, WARNS=5

- match regular ioctl prototype (3rd argument is optional)
- fix lint issues

branches: 1.26.2; 1.26.4;
fix non-portable shift.

Add support for AFMT_AC3

Remove clause 3 and 4 from TNF licenses

branches: 1.23.6;
Set the number of record and play channels individually -- currently
we try to set both in one ioctl, to the same value, which fails if not
both record and play direction support that many channels. (Having
more play than record channels is common these days.)
This does likely address part of the problem described in PR pkg/35444
by Mihai Chelaru, and it helped Matthew R. Green about half a year
ago -- see the thread in tech-misc in April.

Implement OSS_SNDCTL_DSP_GETODELAY and provide a no-op function
for OSS_SNDCTL_DSP_PROFILE.

branches: 1.21.4;
Add a new ioctl AUDIO_GETBUFINFO. It works like AUDIO_GETINFO, but
doesn't obtain the ports, gain and balance related parameters.
Those generally require reading from the hardware and therefore are much
more expensive to obtain. Modify OSS emulation to use the new ioctl
where possible.

This reduces CPU usage of mplayer during mp3 playback with my Thinkpad
from 20% to < 1% and from 50% to 20% during Xvid playback.

Review and comments from jmcneill@

branches: 1.20.4; 1.20.6;
appease gcc -Wuninitialized. some delint

getdevinfo():
If a mixer item does not match with AudioNsomething, check whether
it ends with '.' + AudioNsomething. PR#15441

use __RCSID()

add support for SNDCTL_DSP_SETDUPLEX ioctl to ossaudio emulation code
code provided by Andreas Wrede in PR kern/19793

Make SNDCTL_DSP_POST a nop. It's explicitly *not* supposed to sleep, and as
it's merely advisory (and in fact is implemented as a nop in the OSS->ALSA
shim), it should be safe to ignore it.

Map OSS mixer device "line1" to native mixer device "aux".

Impproved fix of PR12796, from Frederick Bruckman <fb@enteract.com>

Apply patch in PR lib/12796 from Frederick Bruckman <fb@enteract.com>

Use accurate rounding in conversion between OSS and NetBSD volume values.
The optimized integer formula was supplied by Wolfgang Solfrank on
"tech-kern@netbsd.org". This fixes problems with e.g FreeBSD TV (fxtv),
RealPlayer-7.0 Beta 2 (PR pkg/10818) and KDE's "kscd".

Implement OSS_GETVERSION.
Accept mixer values above max (100).
Handle the info from AUDIO_MIXER_DEVINFO properly, parts of it is opaque.

branches: 1.10.4;
Implement SOUND_MIXER_INFO.

branches: 1.9.4;
Per discussion with Lennart Augustsson, change the behaviour to report emulated
encodings, too. (This is currently an issue with the eso(4) driver, which,
due to different byte orders in playing and recording directions, sets the
emulated flag for all 16-bit encodings, although it could be argued that this
is an unfortunate weakness of the query_encoding() interface.)

More trailing white space.

Make copyrights conform.

branches: 1.6.2;
Fix off by one error.

Track mycroft's change in src/sys/compat/oss/ossaudio.c.

Fix a serious emulation bug.
Add some missing #defines.
Add a little more documentation.

Add some missing defines and add history to man page.

branches: 1.2.2;
Update for SunOS compatibility.

Initial version of a user level emulation of the OSS audio API.
Useful for compiling Linux audio programs.

branches: 1.1.4;
libossaudio: Add expected symbols list.

PR lib/58838: shared libraries in base should all have expsym lists

ABI of libossaudio did not change, so there was no need to bump the version
number.

Pointed out by mrg@

Calculate GETISPACE/GETOSPACE properly.
Bump version.

Addresses PR kern/51999.

branches: 1.7.6; 1.7.10;
libossaudio minor version bump to signify new ioctls.

branches: 1.6.14; 1.6.24;
bump shared libraries.

Add a note to update src/distrib/sets/lists/base/shl.*, and add a missing
RCS Id.

RCSID Police.

back out last change

don't build shared library

Initial version of a user level emulation of the OSS audio API.
Useful for compiling Linux audio programs.

libossaudio: Various OSSv4 fixes to allow reference programs to compile

- Define various new AFMT_*. These are not returned as supported
formats by SNDCTL_DSP_GETFMTS, because it would be very silly to
have Vorbis in the kernel.

- Implement PLAYTGT and RECSRC. For each NetBSD audio device
we only return one playback and recording source, "primary".

- Return preferred channel configuration in capabilities.
Either DSP_CH_STEREO, DSP_CH_MONO, or DSP_CH_MULTI
depending on the current hardware format.

- SNDCTL_DSP_HALT_* simply flushes the audio device.

branches: 1.33.2;
Add some missing channel order related ioctl defines.

These are no-ops (unimplemented) on both FreeBSD and Solaris
and the one piece of code I've found that uses it seems to assume the
call will fail so it should be safe to leave this returning EINVAL.

However, it does need the definitions to compile...

ossaudio(3): More capability defines from OSSv4

ossaudio(3): Add an implementation of SNDCTL_CARDINFO

Correct some of the counts returned by SNDCTL_SYSINFO so this works.

ossaudio(3): Add SNDCTL_AUDIOINFO_EX as an alias of SNDCTL_AUDIOINFO

ossaudio(3): Add some endian-specific U16 formats

for compatibility with FreeBSD

ossaudio(3): add some no-op defines for ossv4 compat.

ossaudio(3): Add SNDCTL_DSP_CURRENT_(I|O)PTR

In OSSv4 these are supposed to avoid the wrapping problems with the
older GET(I|O)PTR ioctls but we don't quite get the same benefit here.

XXX: We could probably fake it by maintaining some state in-between calls.

ossaudio(3): Add initial support for the OSSv4.1 Mixer API

One or two calls from this API were supported previously and have been
moved to the correct place.

Mapping the controls correctly is a difficult task. There is a define
hidden in the OSS headers that would allow an AUDIO_MIXER_SET control
to be represented perfectly, but it seems to _only_ exist there, and
no software supports it. So for now only one member of a set can be
set at a time - unfortunate. I've hidden code that should unlock
doing this the proper way under #notyet.

I'm not too happy with the way this code is managing file descriptors.
Currently it has to open a new fd for each ioctl due to OSSv4 deciding
to specify the device number in a structure rather than in the filename.
In the future, we could reuse the file descriptor if the correct one is
detected open.

This allows the mixer programs provided with the OSSv4 sources to compile
and work cleanly. I've observed problems with it failing to work on
secondary devices, and should investigate this later. There may be
a fd leak somewhere.

ossaudio(3): Add SNDCTL_DSP_COOKEDMODE, SNDCTL_DSP_GETERROR

SNDCTL_DSP_COOKEDMODE simply always returns 1.
"Cooked mode" is a silly way the OSSv4 authors chose to refer to allowing
for reprocessed streams. The NetBSD kernel always performs format
conversion and it can't be turned off.

SNDCTL_DSP_GETERROR provides access to the read/write over/underrun
counters. There are other things it might return, but they don't make
sense for our implementation.

Add missing defines for 16, 24 and 32 bit NE and OE formats.
Add the ability to set 24 and 32 bit precision.

This commit was approved by wiz@

branches: 1.23.2;
Adds ioctls and defines for OSSv4 compatibility.

The ioctl definitions and accompanying structures were
taken from FreeBSD's soundcard.h, hopefully providing
some binary compatibility.

The ioctls are as follows:
SNDCTL_SYSINFO: Returns a structure containing
details about the audio device.
SNDCTL_ENGINEINFO - SNDCTL_AUDIOINFO: Returns a
structure with playback/recording
characteristics.
SNDCTL_DSP_GETPLAYVOL, SNDCTL_DSP_SETPLAYVOL,
SNDCTL_DSP_GETRECVOL, SNDCTL_DSP_SETRECVOL:
Retrieves/Sets Playback/Recording volume.
SNDCTL_DSP_SKIP - SNDCTL_DSP_SILENCE: These ioctls
were intended to manipulate the underlying
audio buffer skip or insert silence. These
return EINVAL.

SOUND_VERSION is unchanged, but is definable, It will be
changed when the mixer OSSv4 ioctls are written.

Addresses PR 46611
This commit was approved by wiz@.

branches: 1.22.2; 1.22.8;
fix typo, WARNS=5

avoid using cpp variadic macros and explain why.

- match regular ioctl prototype (3rd argument is optional)
- fix lint issues

branches: 1.19.2; 1.19.4;
Add support for AFMT_AC3

Remove clause 3 and 4 from TNF licenses

branches: 1.17.2;
s/prototyoe/prototype/

branches: 1.16.4;
Implement OSS_SNDCTL_DSP_GETODELAY and provide a no-op function
for OSS_SNDCTL_DSP_PROFILE.

branches: 1.15.16;
work around a prototype conflict by including ioctl.h
before we redefile ioctl()

de-__P

Add SOUND_MASK_* for the last SOUND_MIXER_* values that didn't have any.

Determine the 'native' endianness using _BYTE_ORDER from
<machine/endian_machdep.h>.

The previous method of wrapping a definition of _POSIX_SOURCE around the
inclusion of other headers to reduce namespace pollution had the
side-effect of not all required identifiers being defined when included
thereafter by the application itself (due to multiple-inclusion protection),
and is not blessed by that standard.

Apply patch in PR lib/12796 from Frederick Bruckman <fb@enteract.com>

branches: 1.10.4;
Implement SOUND_MIXER_INFO.

branches: 1.9.4;
Make copyrights conform.

branches: 1.8.2;
Avoid defining _POSIX_SOURCE.

Make protection against multiple inclusion non-invasive wrt. name space.

Revert the #define of ioctl to its previous state since my
"improvement" broke some packages.

Add __BEGIN_DECLS & __END_DECLS for C++ and clean up a little.

Add even more defines.

Fix a serious emulation bug.
Add some missing #defines.
Add a little more documentation.

Add some missing defines and add history to man page.

branches: 1.1.2;
Initial version of a user level emulation of the OSS audio API.
Useful for compiling Linux audio programs.