mlib_signallpcperceptweightfree_s16(3mlib) [opensolaris man page]

mlib_SignalLPCPerceptWeightFree_S16(3MLIB)		    mediaLib Library Functions			mlib_SignalLPCPerceptWeightFree_S16(3MLIB)

NAME

       mlib_SignalLPCPerceptWeightFree_S16, mlib_SignalLPCPerceptWeightFree_F32 - clean up for perceptual weighting

SYNOPSIS

       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       void mlib_SignalLPCPerceptWeightFree_S16(void *state);

       void mlib_SignalLPCPerceptWeightFree_F32(void *state);

DESCRIPTION

       Each of these functions frees the internal state structure for perceptual weighting of linear predictive coding (LPC).

       This function cleans up the internal state structure and releases all memory buffers.

PARAMETERS

       Each of the functions takes the following arguments:

       state	Pointer to the internal state structure.

RETURN VALUES

       None.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       mlib_SignalLPCPerceptWeightInit_S16(3MLIB),  mlib_SignalLPCPerceptWeightInit_F32(3MLIB),  mlib_SignalLPCPerceptWeight_S16(3MLIB), mlib_Sig-
       nalLPCPerceptWeight_F32(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				mlib_SignalLPCPerceptWeightFree_S16(3MLIB)

mlib_SignalLPCPerceptWeight_S16(3MLIB)			    mediaLib Library Functions			    mlib_SignalLPCPerceptWeight_S16(3MLIB)

NAME

       mlib_SignalLPCPerceptWeight_S16 - perform perceptual weighting on input signal

SYNOPSIS

       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status  mlib_SignalLPCPerceptWeight_S16(mlib_s16  *sigwgt,	const mlib_s16 *signal, const mlib_s16 *lpc, mlib_s32 lscale, mlib_s16 r1,
       mlib_s16 r2, void *state);

DESCRIPTION

       The mlib_SignalLPCPerceptWeight_S16() function performs perceptual weighting on input signal.

       The perceptual weighting filter is defined as following.

		    A(z*r1)
	    W(z) = ---------
		    A(z*r2)

       where A(z) is the inverse filter

			M	   -i
	    A(z) = 1 - SUM a(i) * z
		       i=1

       See G.723.1, G.728, G.729, G.729A, GSM EFR standards.

PARAMETERS

       The function takes the following arguments:

       sigwgt	       The weighted signal vector, the signal samples are in Q15 format.

       signal	       The input signal vector, the signal samples are in Q15 format.

       lpc	       The linear prediction coefficients.

       lscale	       The scaling factor of the linear prediction coefficients, where actual_data = input_data * 2**(-scaling_factor).

       r1	       The perceptual weighting filter coefficient, the coefficient is in Q15 format, it is treated as 1 if 0 is supplied.

       r2	       The perceptual weighting filter coefficient, the coefficient is in Q15 format, it is treated as 1 if 0 is supplied.

       state	       Pointer to the internal state structure.

RETURN VALUES

       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       mlib_SignalLPCPerceptWeightInit_S16(3MLIB), mlib_SignalLPCPerceptWeightFree_S16(3MLIB), attributes(5)

SunOS 5.10							    10 Nov 2004 			    mlib_SignalLPCPerceptWeight_S16(3MLIB)