xref: /onnv-gate/usr/src/cmd/audio/include/AudioGain.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1993-2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _MULTIMEDIA_AUDIOGAIN_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOGAIN_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <AudioTypePcm.h>
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #ifdef __cplusplus
35*0Sstevel@tonic-gate extern "C" {
36*0Sstevel@tonic-gate #endif
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate // Class to handle gain calculations
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate // Define bits for AudioGain::Process() type argument
41*0Sstevel@tonic-gate #define	AUDIO_GAIN_INSTANT	(1)		// Gain for level meter
42*0Sstevel@tonic-gate #define	AUDIO_GAIN_WEIGHTED	(2)		// Gain for agc
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate class AudioGain {
46*0Sstevel@tonic-gate protected:
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate static const double	LoSigInstantRange;	// normalization constants
49*0Sstevel@tonic-gate static const double	HiSigInstantRange;
50*0Sstevel@tonic-gate static const double	NoSigWeight;
51*0Sstevel@tonic-gate static const double	LoSigWeightRange;
52*0Sstevel@tonic-gate static const double	HiSigWeightRange;
53*0Sstevel@tonic-gate static const double	PeakSig;
54*0Sstevel@tonic-gate static const double	DCtimeconstant;		// DC offset time constant
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate 	AudioTypePcm	float_convert;		// used in signal processing
57*0Sstevel@tonic-gate 	unsigned	clipcnt;		// clip counter
58*0Sstevel@tonic-gate 	Double		DCaverage;		// weighted DC offset
59*0Sstevel@tonic-gate 	Double		instant_gain;		// current (instantaneous) gain
60*0Sstevel@tonic-gate 	Double		weighted_peaksum;	// peak weighted sum
61*0Sstevel@tonic-gate 	Double		weighted_sum;		// running sum of squares
62*0Sstevel@tonic-gate 	Double		weighted_avgsum;	// accumulated sums to averages
63*0Sstevel@tonic-gate 	unsigned	weighted_cnt;		// number of sums to average
64*0Sstevel@tonic-gate 	double		*gain_cache;		// weighted gains
65*0Sstevel@tonic-gate 	Double		gain_cache_size;	// number of cached gains
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate protected:
68*0Sstevel@tonic-gate 	// Internal processing methods
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate 	// filter DC bias
71*0Sstevel@tonic-gate 	virtual void process_dcfilter(
72*0Sstevel@tonic-gate 	    AudioBuffer*);
73*0Sstevel@tonic-gate 	// calculate instant gain
74*0Sstevel@tonic-gate 	virtual void process_instant(
75*0Sstevel@tonic-gate 	    AudioBuffer*);
76*0Sstevel@tonic-gate 	// calculate weighted gain
77*0Sstevel@tonic-gate 	virtual void process_weighted(
78*0Sstevel@tonic-gate 	    AudioBuffer*);
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate public:
81*0Sstevel@tonic-gate 		AudioGain();			// Constructor
82*0Sstevel@tonic-gate 	virtual	~AudioGain();			// Destructor
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate 	// TRUE if conversion ok
85*0Sstevel@tonic-gate 	virtual Boolean CanConvert(
86*0Sstevel@tonic-gate 	    const AudioHdr&) const;	// type to check against
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 	// Process new audio data
89*0Sstevel@tonic-gate 	virtual AudioError Process(
90*0Sstevel@tonic-gate 	    AudioBuffer*, int);		// buffer destroyed if not referenced!
91*0Sstevel@tonic-gate 	virtual double InstantGain();	// Get most recent gain
92*0Sstevel@tonic-gate 	virtual double WeightedGain();	// Get current weighted gain
93*0Sstevel@tonic-gate 	virtual double WeightedPeak();	// Get peak weighted gain
94*0Sstevel@tonic-gate 	virtual Boolean Clipped();	// TRUE if peak since last check
95*0Sstevel@tonic-gate 	virtual void Flush();		// Reset state
96*0Sstevel@tonic-gate };
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate #ifdef __cplusplus
99*0Sstevel@tonic-gate }
100*0Sstevel@tonic-gate #endif
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOGAIN_H */
103