opensolaris man page for mlib_signalmulsshift_s16_sat

mlib_SignalMulSShift_S16_Sat(3MLIB)			    mediaLib Library Functions			       mlib_SignalMulSShift_S16_Sat(3MLIB)

NAME
       mlib_SignalMulSShift_S16_Sat, mlib_SignalMulSShift_S16S_Sat - multiplication by a scalar with shifting

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

       mlib_status mlib_SignalMulSShift_S16_Sat(mlib_s16 *srcdst,
	    const mlib_s16 *c, mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalMulSShift_S16S_Sat(mlib_s16 *srcdst,
	    const mlib_s16 *c, mlib_s32 shift, mlib_s32 n);

DESCRIPTION
       Each of these functions performs multiplication by a scalar with shifting.

PARAMETERS
       Each of the functions takes the following arguments:

       srcdst	 Source and destination signal array.

       c	 Scaling  factor.  The scaling factor is in Q15 format. In the stereo version; c[0] contains the scaling factor for channel 0, and
		 c[1] holds the scaling factor for channel 1.

       shift	 Left shifting factor.

       n	 Number of samples in the input signal arrays.

RETURN VALUES
       Each of the functions 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	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_SignalMulSShift_S16_S16_Sat(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				       mlib_SignalMulSShift_S16_Sat(3MLIB)