freebsd-skq/sys/dev/sound/pcm/intpcm.h
ariff e3faadaafe 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

137 lines
4.3 KiB
C

/*-
* Copyright (c) 2008-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_INTPCM_H_
#define _SND_INTPCM_H_
typedef intpcm_t intpcm_read_t(uint8_t *);
typedef void intpcm_write_t(uint8_t *, intpcm_t);
extern intpcm_read_t *feeder_format_read_op(uint32_t);
extern intpcm_write_t *feeder_format_write_op(uint32_t);
#define INTPCM_DECLARE_OP_WRITE(SIGN, BIT, ENDIAN, SHIFT) \
static __inline void \
intpcm_write_##SIGN##BIT##ENDIAN(uint8_t *dst, intpcm_t v) \
{ \
\
_PCM_WRITE_##SIGN##BIT##_##ENDIAN(dst, v >> SHIFT); \
}
#define INTPCM_DECLARE_OP_8(SIGN, ENDIAN) \
static __inline intpcm_t \
intpcm_read_##SIGN##8##ENDIAN(uint8_t *src) \
{ \
\
return (_PCM_READ_##SIGN##8##_##ENDIAN(src) << 24); \
} \
INTPCM_DECLARE_OP_WRITE(SIGN, 8, ENDIAN, 24)
#define INTPCM_DECLARE_OP_16(SIGN, ENDIAN) \
static __inline intpcm_t \
intpcm_read_##SIGN##16##ENDIAN(uint8_t *src) \
{ \
\
return (_PCM_READ_##SIGN##16##_##ENDIAN(src) << 16); \
} \
INTPCM_DECLARE_OP_WRITE(SIGN, 16, ENDIAN, 16)
#define INTPCM_DECLARE_OP_24(SIGN, ENDIAN) \
static __inline intpcm_t \
intpcm_read_##SIGN##24##ENDIAN(uint8_t *src) \
{ \
\
return (_PCM_READ_##SIGN##24##_##ENDIAN(src) << 8); \
} \
INTPCM_DECLARE_OP_WRITE(SIGN, 24, ENDIAN, 8)
#define INTPCM_DECLARE_OP_32(SIGN, ENDIAN) \
static __inline intpcm_t \
intpcm_read_##SIGN##32##ENDIAN(uint8_t *src) \
{ \
\
return (_PCM_READ_##SIGN##32##_##ENDIAN(src)); \
} \
\
static __inline void \
intpcm_write_##SIGN##32##ENDIAN(uint8_t *dst, intpcm_t v) \
{ \
\
_PCM_WRITE_##SIGN##32##_##ENDIAN(dst, v); \
}
#define INTPCM_DECLARE(t) \
\
G711_DECLARE_TABLE(t); \
\
static __inline intpcm_t \
intpcm_read_ulaw(uint8_t *src) \
{ \
\
return (_G711_TO_INTPCM((t).ulaw_to_u8, *src) << 24); \
} \
\
static __inline intpcm_t \
intpcm_read_alaw(uint8_t *src) \
{ \
\
return (_G711_TO_INTPCM((t).alaw_to_u8, *src) << 24); \
} \
\
static __inline void \
intpcm_write_ulaw(uint8_t *dst, intpcm_t v) \
{ \
\
*dst = _INTPCM_TO_G711((t).u8_to_ulaw, v >> 24); \
} \
\
static __inline void \
intpcm_write_alaw(uint8_t *dst, intpcm_t v) \
{ \
\
*dst = _INTPCM_TO_G711((t).u8_to_alaw, v >> 24); \
} \
\
INTPCM_DECLARE_OP_8(S, NE) \
INTPCM_DECLARE_OP_16(S, LE) \
INTPCM_DECLARE_OP_16(S, BE) \
INTPCM_DECLARE_OP_24(S, LE) \
INTPCM_DECLARE_OP_24(S, BE) \
INTPCM_DECLARE_OP_32(S, LE) \
INTPCM_DECLARE_OP_32(S, BE) \
INTPCM_DECLARE_OP_8(U, NE) \
INTPCM_DECLARE_OP_16(U, LE) \
INTPCM_DECLARE_OP_16(U, BE) \
INTPCM_DECLARE_OP_24(U, LE) \
INTPCM_DECLARE_OP_24(U, BE) \
INTPCM_DECLARE_OP_32(U, LE) \
INTPCM_DECLARE_OP_32(U, BE)
#endif /* !_SND_INTPCM_H_ */