opensolaris man page for mlib_signalfir_s16_s16_sat

mlib_SignalFIR_S16_S16_Sat(3MLIB)			    mediaLib Library Functions				 mlib_SignalFIR_S16_S16_Sat(3MLIB)

NAME
       mlib_SignalFIR_S16_S16_Sat, mlib_SignalFIR_S16S_S16S_Sat - Finite Impulse Response (FIR) filtering

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

       mlib_status mlib_SignalFIR_S16_S16_Sat(mlib_s16 *dst,
	    const mlib_s16 *src,void *filter, mlib_s32 n);

       mlib_status mlib_SignalFIR_S16S_S16S_Sat(mlib_s16 *dst,
	    const mlib_s16 *src,void *filter, mlib_s32 n);

DESCRIPTION
       Each of these functions applies the FIR filter to one signal packet and updates the filter state.

PARAMETERS
       Each of the functions takes the following arguments:

       dst	 Output signal array.

       src	 Input signal array.

       filter	 Internal filter structure.

       n	 Number of samples in the input signal array.

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_SignalFIRFree_S16_S16(3MLIB), mlib_SignalFIRInit_S16_S16(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					 mlib_SignalFIR_S16_S16_Sat(3MLIB)