opensolaris man page for mlib_signalfirinit_f32_f32

mlib_SignalFIRInit_F32_F32(3MLIB)			    mediaLib Library Functions				 mlib_SignalFIRInit_F32_F32(3MLIB)

NAME
       mlib_SignalFIRInit_F32_F32 - Finite Impulse Response (FIR) filtering

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

       mlib_status mlib_SignalFIRInit_F32_F32(void **filter,
	    const mlib_f32 *flt,mlib_s32 tap);

DESCRIPTION
       The  mlib_SignalFIRInit_F32_F32()  function  allocates  memory for the internal filter structure and converts the filter coefficients to an
       internal representation.

PARAMETERS
       The function takes the following arguments:

       filter	 Internal filter structure.

       flt	 Filter coefficient array.

       tap	 Taps of the filter.

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	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    2 Mar 2007					 mlib_SignalFIRInit_F32_F32(3MLIB)