opensolaris man page for mlib_signalconvertshift_f32_s32

mlib_SignalConvertShift_F32_U8(3MLIB)			    mediaLib Library Functions			     mlib_SignalConvertShift_F32_U8(3MLIB)

NAME
       mlib_SignalConvertShift_F32_U8, mlib_SignalConvertShift_F32_S8, mlib_SignalConvertShift_F32_S16, mlib_SignalConvertShift_F32_S32, mlib_Sig-
       nalConvertShift_F32S_U8S, mlib_SignalConvertShift_F32S_S8S,  mlib_SignalConvertShift_F32S_S16S,	mlib_SignalConvertShift_F32S_S32S  -  data
       type convert with shifting

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

       mlib_status mlib_SignalConvertShift_F32_U8(mlib_f32 *dst, const mlib_u8 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32_S8(mlib_f32 *dst, const mlib_s8 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32_S16(mlib_f32 *dst, const mlib_s16 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32_S32(mlib_f32 *dst, const mlib_s32 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32S_U8S(mlib_f32 *dst, const mlib_u8 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32S_S8S(mlib_f32 *dst, const mlib_s8 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32S_S16S(mlib_f32 *dst, const mlib_s16 *src,
	    mlib_s32 shift, mlib_s32 n);

       mlib_status mlib_SignalConvertShift_F32S_S32S(mlib_f32 *dst, const mlib_s32 *src,
	    mlib_s32 shift, mlib_s32 n);

DESCRIPTION
       Each of these functions performs data type convert with shifting.

       The following equation is used:

	 dst[i] = src[i] * 2**shift

       See the following table for available variations of this group of data type convert functions.

	    Type [*]		    F32 		 F32S
       --------------------------------------------------------------
       U8		    Y
       S8		    Y
       --------------------------------------------------------------

       S16		    Y
       --------------------------------------------------------------
       S32		    Y
       --------------------------------------------------------------
       U8S					  Y
       --------------------------------------------------------------
       S8S					  Y
       --------------------------------------------------------------
       S16S					  Y
       --------------------------------------------------------------
       S32S					  Y

       [*] Each row represents a source data type. Each column represents a destination data type.

PARAMETERS
       Each of the functions takes the following arguments:

       dst	Destination signal array.

       src	Source signal array.

       shift	Left shifting factor.

       n	Number of samples in the source 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_SignalConvertShift_U8_S8_Sat(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				     mlib_SignalConvertShift_F32_U8(3MLIB)