freebsd-dev/sys/dev/sound/pcm/sndstat.h

171 lines
5.8 KiB
C
Raw Normal View History

Sound Mega-commit. Expect further cleanup until code freeze. For a slightly thorough explaination, please refer to [1] http://people.freebsd.org/~ariff/SOUND_4.TXT.html . Summary of changes includes: 1 Volume Per-Channel (vpc). Provides private / standalone volume control unique per-stream pcm channel without touching master volume / pcm. Applications can directly use SNDCTL_DSP_[GET|SET][PLAY|REC]VOL, or for backwards compatibility, SOUND_MIXER_PCM through the opened dsp device instead of /dev/mixer. Special "bypass" mode is enabled through /dev/mixer which will automatically detect if the adjustment is made through /dev/mixer and forward its request to this private volume controller. Changes to this volume object will not interfere with other channels. Requirements: - SNDCTL_DSP_[GET|SET][PLAY|REC]_VOL are newer ioctls (OSSv4) which require specific application modifications (preferred). - No modifications required for using bypass mode, so applications like mplayer or xmms should work out of the box. Kernel hints: - hint.pcm.%d.vpc (0 = disable vpc). Kernel sysctls: - hw.snd.vpc_mixer_bypass (default: 1). Enable or disable /dev/mixer bypass mode. - hw.snd.vpc_autoreset (default: 1). By default, closing/opening /dev/dsp will reset the volume back to 0 db gain/attenuation. Setting this to 0 will preserve its settings across device closing/opening. - hw.snd.vpc_reset (default: 0). Panic/reset button to reset all volume settings back to 0 db. - hw.snd.vpc_0db (default: 45). 0 db relative to linear mixer value. 2 High quality fixed-point Bandlimited SINC sampling rate converter, based on Julius O'Smith's Digital Audio Resampling - http://ccrma.stanford.edu/~jos/resample/. It includes a filter design script written in awk (the clumsiest joke I've ever written) - 100% 32bit fixed-point, 64bit accumulator. - Possibly among the fastest (if not fastest) of its kind. - Resampling quality is tunable, either runtime or during kernel compilation (FEEDER_RATE_PRESETS). - Quality can be further customized during kernel compilation by defining FEEDER_RATE_PRESETS in /etc/make.conf. Kernel sysctls: - hw.snd.feeder_rate_quality. 0 - Zero-order Hold (ZOH). Fastest, bad quality. 1 - Linear Interpolation (LINEAR). Slightly slower than ZOH, better quality but still does not eliminate aliasing. 2 - (and above) - Sinc Interpolation(SINC). Best quality. SINC quality always start from 2 and above. Rough quality comparisons: - http://people.freebsd.org/~ariff/z_comparison/ 3 Bit-perfect mode. Bypasses all feeder/dsp effects. Pure sound will be directly fed into the hardware. 4 Parametric (compile time) Software Equalizer (Bass/Treble mixer). Can be customized by defining FEEDER_EQ_PRESETS in /etc/make.conf. 5 Transparent/Adaptive Virtual Channel. Now you don't have to disable vchans in order to make digital format pass through. It also makes vchans more dynamic by choosing a better format/rate among all the concurrent streams, which means that dev.pcm.X.play.vchanformat/rate becomes sort of optional. 6 Exclusive Stream, with special open() mode O_EXCL. This will "mute" other concurrent vchan streams and only allow a single channel with O_EXCL set to keep producing sound. Other Changes: * most feeder_* stuffs are compilable in userland. Let's not speculate whether we should go all out for it (save that for FreeBSD 16.0-RELEASE). * kobj signature fixups, thanks to Andriy Gapon <avg@freebsd.org> * pull out channel mixing logic out of vchan.c and create its own feeder_mixer for world justice. * various refactoring here and there, for good or bad. * activation of few more OSSv4 ioctls() (see [1] above). * opt_snd.h for possible compile time configuration: (mostly for debugging purposes, don't try these at home) SND_DEBUG SND_DIAGNOSTIC SND_FEEDER_MULTIFORMAT SND_FEEDER_FULL_MULTIFORMAT SND_FEEDER_RATE_HP SND_PCM_64 SND_OLDSTEREO Manual page updates are on the way. Tested by: joel, Olivier SMEDTS <olivier at gid0 d org>, too many unsung / unnamed heroes.
2009-06-07 19:12:08 +00:00
/*-
* Copyright (c) 2007-2009 Ariff Abdullah <ariff@FreeBSD.org>
* All rights reserved.
*
* 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 AUTHOR 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 AUTHOR 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.
*
* $FreeBSD$
*/
#ifndef _SND_SNDSTAT_H_
#define _SND_SNDSTAT_H_
#define SNDSTAT_PREPARE_PCM_ARGS \
struct sbuf *s, device_t dev, int verbose
#define SNDSTAT_PREPARE_PCM_BEGIN() do { \
struct snddev_info *d; \
struct pcm_channel *c; \
struct pcm_feeder *f; \
\
d = device_get_softc(dev); \
PCM_BUSYASSERT(d); \
\
if (CHN_EMPTY(d, channels.pcm)) { \
sbuf_printf(s, " (mixer only)"); \
return (0); \
} \
\
if (verbose < 1) { \
sbuf_printf(s, " (%s%s%s", \
d->playcount ? "play" : "", \
(d->playcount && d->reccount) ? "/" : "", \
d->reccount ? "rec" : ""); \
} else { \
sbuf_printf(s, " (%dp:%dv/%dr:%dv", \
d->playcount, d->pvchancount, \
d->reccount, d->rvchancount); \
} \
sbuf_printf(s, "%s)%s", \
((d->playcount != 0 && d->reccount != 0) && \
(d->flags & SD_F_SIMPLEX)) ? " simplex" : "", \
Sound Mega-commit. Expect further cleanup until code freeze. For a slightly thorough explaination, please refer to [1] http://people.freebsd.org/~ariff/SOUND_4.TXT.html . Summary of changes includes: 1 Volume Per-Channel (vpc). Provides private / standalone volume control unique per-stream pcm channel without touching master volume / pcm. Applications can directly use SNDCTL_DSP_[GET|SET][PLAY|REC]VOL, or for backwards compatibility, SOUND_MIXER_PCM through the opened dsp device instead of /dev/mixer. Special "bypass" mode is enabled through /dev/mixer which will automatically detect if the adjustment is made through /dev/mixer and forward its request to this private volume controller. Changes to this volume object will not interfere with other channels. Requirements: - SNDCTL_DSP_[GET|SET][PLAY|REC]_VOL are newer ioctls (OSSv4) which require specific application modifications (preferred). - No modifications required for using bypass mode, so applications like mplayer or xmms should work out of the box. Kernel hints: - hint.pcm.%d.vpc (0 = disable vpc). Kernel sysctls: - hw.snd.vpc_mixer_bypass (default: 1). Enable or disable /dev/mixer bypass mode. - hw.snd.vpc_autoreset (default: 1). By default, closing/opening /dev/dsp will reset the volume back to 0 db gain/attenuation. Setting this to 0 will preserve its settings across device closing/opening. - hw.snd.vpc_reset (default: 0). Panic/reset button to reset all volume settings back to 0 db. - hw.snd.vpc_0db (default: 45). 0 db relative to linear mixer value. 2 High quality fixed-point Bandlimited SINC sampling rate converter, based on Julius O'Smith's Digital Audio Resampling - http://ccrma.stanford.edu/~jos/resample/. It includes a filter design script written in awk (the clumsiest joke I've ever written) - 100% 32bit fixed-point, 64bit accumulator. - Possibly among the fastest (if not fastest) of its kind. - Resampling quality is tunable, either runtime or during kernel compilation (FEEDER_RATE_PRESETS). - Quality can be further customized during kernel compilation by defining FEEDER_RATE_PRESETS in /etc/make.conf. Kernel sysctls: - hw.snd.feeder_rate_quality. 0 - Zero-order Hold (ZOH). Fastest, bad quality. 1 - Linear Interpolation (LINEAR). Slightly slower than ZOH, better quality but still does not eliminate aliasing. 2 - (and above) - Sinc Interpolation(SINC). Best quality. SINC quality always start from 2 and above. Rough quality comparisons: - http://people.freebsd.org/~ariff/z_comparison/ 3 Bit-perfect mode. Bypasses all feeder/dsp effects. Pure sound will be directly fed into the hardware. 4 Parametric (compile time) Software Equalizer (Bass/Treble mixer). Can be customized by defining FEEDER_EQ_PRESETS in /etc/make.conf. 5 Transparent/Adaptive Virtual Channel. Now you don't have to disable vchans in order to make digital format pass through. It also makes vchans more dynamic by choosing a better format/rate among all the concurrent streams, which means that dev.pcm.X.play.vchanformat/rate becomes sort of optional. 6 Exclusive Stream, with special open() mode O_EXCL. This will "mute" other concurrent vchan streams and only allow a single channel with O_EXCL set to keep producing sound. Other Changes: * most feeder_* stuffs are compilable in userland. Let's not speculate whether we should go all out for it (save that for FreeBSD 16.0-RELEASE). * kobj signature fixups, thanks to Andriy Gapon <avg@freebsd.org> * pull out channel mixing logic out of vchan.c and create its own feeder_mixer for world justice. * various refactoring here and there, for good or bad. * activation of few more OSSv4 ioctls() (see [1] above). * opt_snd.h for possible compile time configuration: (mostly for debugging purposes, don't try these at home) SND_DEBUG SND_DIAGNOSTIC SND_FEEDER_MULTIFORMAT SND_FEEDER_FULL_MULTIFORMAT SND_FEEDER_RATE_HP SND_PCM_64 SND_OLDSTEREO Manual page updates are on the way. Tested by: joel, Olivier SMEDTS <olivier at gid0 d org>, too many unsung / unnamed heroes.
2009-06-07 19:12:08 +00:00
(device_get_unit(dev) == snd_unit) ? " default" : "")
#define SNDSTAT_PREPARE_PCM_END() \
if (verbose <= 1) \
return (0); \
\
sbuf_printf(s, "\n\t"); \
sbuf_printf(s, "snddev flags=0x%b", d->flags, SD_F_BITS); \
\
CHN_FOREACH(c, d, channels.pcm) { \
\
KASSERT(c->bufhard != NULL && c->bufsoft != NULL, \
("hosed pcm channel setup")); \
\
sbuf_printf(s, "\n\t"); \
\
sbuf_printf(s, "%s[%s]: ", \
(c->parentchannel != NULL) ? \
c->parentchannel->name : "", c->name); \
sbuf_printf(s, "spd %d", c->speed); \
if (c->speed != sndbuf_getspd(c->bufhard)) \
sbuf_printf(s, "/%d", \
sndbuf_getspd(c->bufhard)); \
sbuf_printf(s, ", fmt 0x%08x", c->format); \
if (c->format != sndbuf_getfmt(c->bufhard)) \
sbuf_printf(s, "/0x%08x", \
sndbuf_getfmt(c->bufhard)); \
sbuf_printf(s, ", flags 0x%08x, 0x%08x", \
c->flags, c->feederflags); \
if (c->pid != -1) \
sbuf_printf(s, ", pid %d (%s)", \
c->pid, c->comm); \
sbuf_printf(s, "\n\t"); \
\
sbuf_printf(s, "interrupts %d, ", c->interrupts); \
\
if (c->direction == PCMDIR_REC) \
sbuf_printf(s, \
"overruns %d, feed %u, hfree %d, " \
"sfree %d [b:%d/%d/%d|bs:%d/%d/%d]", \
c->xruns, c->feedcount, \
sndbuf_getfree(c->bufhard), \
sndbuf_getfree(c->bufsoft), \
sndbuf_getsize(c->bufhard), \
sndbuf_getblksz(c->bufhard), \
sndbuf_getblkcnt(c->bufhard), \
sndbuf_getsize(c->bufsoft), \
sndbuf_getblksz(c->bufsoft), \
sndbuf_getblkcnt(c->bufsoft)); \
else \
sbuf_printf(s, \
"underruns %d, feed %u, ready %d " \
"[b:%d/%d/%d|bs:%d/%d/%d]", \
c->xruns, c->feedcount, \
sndbuf_getready(c->bufsoft), \
sndbuf_getsize(c->bufhard), \
sndbuf_getblksz(c->bufhard), \
sndbuf_getblkcnt(c->bufhard), \
sndbuf_getsize(c->bufsoft), \
sndbuf_getblksz(c->bufsoft), \
sndbuf_getblkcnt(c->bufsoft)); \
sbuf_printf(s, "\n\t"); \
\
sbuf_printf(s, "channel flags=0x%b", c->flags, \
CHN_F_BITS); \
sbuf_printf(s, "\n\t"); \
\
sbuf_printf(s, "{%s}", \
(c->direction == PCMDIR_REC) ? "hardware" : \
"userland"); \
sbuf_printf(s, " -> "); \
f = c->feeder; \
while (f->source != NULL) \
f = f->source; \
while (f != NULL) { \
sbuf_printf(s, "%s", f->class->name); \
if (f->desc->type == FEEDER_FORMAT) \
sbuf_printf(s, "(0x%08x -> 0x%08x)", \
f->desc->in, f->desc->out); \
else if (f->desc->type == FEEDER_MATRIX) \
sbuf_printf(s, "(%d.%d -> %d.%d)", \
AFMT_CHANNEL(f->desc->in) - \
AFMT_EXTCHANNEL(f->desc->in), \
AFMT_EXTCHANNEL(f->desc->in), \
AFMT_CHANNEL(f->desc->out) - \
AFMT_EXTCHANNEL(f->desc->out), \
AFMT_EXTCHANNEL(f->desc->out)); \
else if (f->desc->type == FEEDER_RATE) \
sbuf_printf(s, \
"(0x%08x q:%d %d -> %d)", \
f->desc->out, \
FEEDER_GET(f, FEEDRATE_QUALITY), \
FEEDER_GET(f, FEEDRATE_SRC), \
FEEDER_GET(f, FEEDRATE_DST)); \
else \
sbuf_printf(s, "(0x%08x)", \
f->desc->out); \
sbuf_printf(s, " -> "); \
f = f->parent; \
} \
sbuf_printf(s, "{%s}", \
(c->direction == PCMDIR_REC) ? "userland" : \
"hardware"); \
} \
\
return (0); \
} while (0)
#endif /* !_SND_SNDSTAT_H_ */