d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6e50170633
freebsd-dev/sys/dev/sound/pcm/matrix.h
Ariff Abdullah 90da2b2859 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

219 lines
7.2 KiB
C
Raw Blame History

/*-
* 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_MATRIX_H_
#define _SND_MATRIX_H_
#undef SND_MULTICHANNEL
#ifndef SND_OLDSTEREO
#define SND_MULTICHANNEL 1
#endif
/*
* XXX = unused, but part of the definition (will be used someday, maybe).
*/
#define SND_CHN_T_FL 0 /* Front Left */
#define SND_CHN_T_FR 1 /* Front Right */
#define SND_CHN_T_FC 2 /* Front Center */
#define SND_CHN_T_LF 3 /* Low Frequency */
#define SND_CHN_T_BL 4 /* Back Left */
#define SND_CHN_T_BR 5 /* Back Right */
#define SND_CHN_T_FLC 6 /* Front Left Center XXX */
#define SND_CHN_T_FRC 7 /* Front Right Center XXX */
#define SND_CHN_T_BC 8 /* Back Center */
#define SND_CHN_T_SL 9 /* Side Left */
#define SND_CHN_T_SR 10 /* Side Right */
#define SND_CHN_T_TC 11 /* Top Center XXX */
#define SND_CHN_T_TFL 12 /* Top Front Left XXX */
#define SND_CHN_T_TFC 13 /* Top Front Center XXX */
#define SND_CHN_T_TFR 14 /* Top Front Right XXX */
#define SND_CHN_T_TBL 15 /* Top Back Left XXX */
#define SND_CHN_T_TBC 16 /* Top Back Center XXX */
#define SND_CHN_T_TBR 17 /* Top Back Right XXX */
#define SND_CHN_T_MAX 18 /* Maximum channels */
#define SND_CHN_T_ZERO (SND_CHN_T_MAX + 1) /* Zero samples */
#define SND_CHN_T_LABELS { \
"fl", "fr", "fc", "lf", "bl", "br", \
"flc", "frc", "bc", "sl", "sr", "tc", \
"tfl", "tfc", "tfr", "tbl", "tbc", "tbr" \
}
#define SND_CHN_T_NAMES { \
"Front Left", "Front Right", "Front Center", \
"Low Frequency Effects", \
"Back Left", "Back Right", \
"Front Left Center", "Front Right Center", \
"Back Center", \
"Side Left", "Side Right", \
"Top Center", \
"Top Front Left", "Top Front Center", "Top Front Right", \
"Top Back Left", "Top Back Center", "Top Back Right" \
}
#define SND_CHN_T_MASK_FL (1 << SND_CHN_T_FL)
#define SND_CHN_T_MASK_FR (1 << SND_CHN_T_FR)
#define SND_CHN_T_MASK_FC (1 << SND_CHN_T_FC)
#define SND_CHN_T_MASK_LF (1 << SND_CHN_T_LF)
#define SND_CHN_T_MASK_BL (1 << SND_CHN_T_BL)
#define SND_CHN_T_MASK_BR (1 << SND_CHN_T_BR)
#define SND_CHN_T_MASK_FLC (1 << SND_CHN_T_FLC)
#define SND_CHN_T_MASK_FRC (1 << SND_CHN_T_FRC)
#define SND_CHN_T_MASK_BC (1 << SND_CHN_T_BC)
#define SND_CHN_T_MASK_SL (1 << SND_CHN_T_SL)
#define SND_CHN_T_MASK_SR (1 << SND_CHN_T_SR)
#define SND_CHN_T_MASK_TC (1 << SND_CHN_T_TC)
#define SND_CHN_T_MASK_TFL (1 << SND_CHN_T_TFL)
#define SND_CHN_T_MASK_TFC (1 << SND_CHN_T_TFC)
#define SND_CHN_T_MASK_TFR (1 << SND_CHN_T_TFR)
#define SND_CHN_T_MASK_TBL (1 << SND_CHN_T_TBL)
#define SND_CHN_T_MASK_TBC (1 << SND_CHN_T_TBC)
#define SND_CHN_T_MASK_TBR (1 << SND_CHN_T_TBR)
#define SND_CHN_LEFT_MASK (SND_CHN_T_MASK_FL | \
SND_CHN_T_MASK_BL | \
SND_CHN_T_MASK_FLC | \
SND_CHN_T_MASK_SL | \
SND_CHN_T_MASK_TFL | \
SND_CHN_T_MASK_TBL)
#define SND_CHN_RIGHT_MASK (SND_CHN_T_MASK_FR | \
SND_CHN_T_MASK_BR | \
SND_CHN_T_MASK_FRC | \
SND_CHN_T_MASK_SR | \
SND_CHN_T_MASK_TFR | \
SND_CHN_T_MASK_TBR)
#define SND_CHN_CENTER_MASK (SND_CHN_T_MASK_FC | \
SND_CHN_T_MASK_BC | \
SND_CHN_T_MASK_TC | \
SND_CHN_T_MASK_TFC | \
SND_CHN_T_MASK_TBC | \
SND_CHN_T_MASK_LF) /* XXX what?!? */
/*
* Matrix identity.
*/
/* 1 @ Mono 1.0 */
#define SND_CHN_MATRIX_1_0 0
#define SND_CHN_MATRIX_1 SND_CHN_MATRIX_1_0
/* 2 @ Stereo 2.0 */
#define SND_CHN_MATRIX_2_0 1
#define SND_CHN_MATRIX_2 SND_CHN_MATRIX_2_0
/* 3 @ 2.1 (lfe), 3.0 (rear center, DEFAULT) */
#define SND_CHN_MATRIX_2_1 2
#define SND_CHN_MATRIX_3_0 3
#define SND_CHN_MATRIX_3 SND_CHN_MATRIX_3_0
/* 4 @ 4.0 Quadraphonic */
#define SND_CHN_MATRIX_4_0 4
#define SND_CHN_MATRIX_4 SND_CHN_MATRIX_4_0
/* 5 @ 4.1 (lfe), 5.0 (center, DEFAULT) */
#define SND_CHN_MATRIX_4_1 5
#define SND_CHN_MATRIX_5_0 6
#define SND_CHN_MATRIX_5 SND_CHN_MATRIX_5_0
/* 6 @ 5.1 (lfe, DEFAULT), 6.0 (rear center) */
#define SND_CHN_MATRIX_5_1 7
#define SND_CHN_MATRIX_6_0 8
#define SND_CHN_MATRIX_6 SND_CHN_MATRIX_5_1
/* 7 @ 6.1 (lfe) */
#define SND_CHN_MATRIX_6_1 9
#define SND_CHN_MATRIX_7 SND_CHN_MATRIX_6_1
/* 8 @ 7.1 (lfe) */
#define SND_CHN_MATRIX_7_1 10
#define SND_CHN_MATRIX_8 SND_CHN_MATRIX_7_1
#define SND_CHN_MATRIX_MAX 11
#define SND_CHN_MATRIX_BEGIN SND_CHN_MATRIX_1_0
#define SND_CHN_MATRIX_END SND_CHN_MATRIX_7_1
/* Custom matrix identity */
#define SND_CHN_MATRIX_DRV -4 /* driver own identity */
#define SND_CHN_MATRIX_PCMCHANNEL -3 /* PCM channel identity */
#define SND_CHN_MATRIX_MISC -2 /* misc, custom defined */
#define SND_CHN_MATRIX_UNKNOWN -1 /* unknown */
#define SND_CHN_T_VOL_0DB SND_CHN_T_MAX
#define SND_CHN_T_VOL_MAX (SND_CHN_T_VOL_0DB + 1)
#define SND_CHN_T_BEGIN SND_CHN_T_FL
#define SND_CHN_T_END SND_CHN_T_TBR
#define SND_CHN_T_STEP 1
#define SND_CHN_MIN 1
#ifdef SND_MULTICHANNEL
#define SND_CHN_MAX 8
#else
#define SND_CHN_MAX 2
#endif
/*
* Multichannel interleaved volume matrix. Each calculated value relative
* to master and 0db will be stored in each CLASS + 1 as long as
* chn_setvolume_matrix() or the equivalent CHN_SETVOLUME() macros is
* used (see channel.c).
*/
#define SND_VOL_C_MASTER 0
#define SND_VOL_C_PCM 1
#define SND_VOL_C_PCM_VAL 2
#define SND_VOL_C_MAX 3
#define SND_VOL_C_BEGIN SND_VOL_C_PCM
#define SND_VOL_C_END SND_VOL_C_PCM
#define SND_VOL_C_STEP 2
#define SND_VOL_C_VAL(x) ((x) + 1)
#define SND_VOL_0DB_MIN 1
#define SND_VOL_0DB_MAX 100
#define SND_VOL_0DB_MASTER 100
#define SND_VOL_0DB_PCM 45
#define SND_VOL_RESOLUTION 8
#define SND_VOL_FLAT (1 << SND_VOL_RESOLUTION)
#define SND_VOL_CALC_SAMPLE(x, y) (((x) * (y)) >> SND_VOL_RESOLUTION)
#define SND_VOL_CALC_VAL(x, y, z) \
(((((x)[y][z] << SND_VOL_RESOLUTION) / \
(x)[y][SND_CHN_T_VOL_0DB]) * \
(x)[SND_VOL_C_MASTER][z]) / \
(x)[SND_VOL_C_MASTER][SND_CHN_T_VOL_0DB]) \
#endif /* !_SND_MATRIX_H_ */
Reference in New Issue View Git Blame Copy Permalink