opensolaris man page for mlib_signalfir_f32s_f32s

mlib_SignalFIR_F32S_F32S(3MLIB) 			    mediaLib Library Functions				   mlib_SignalFIR_F32S_F32S(3MLIB)

NAME
       mlib_SignalFIR_F32S_F32S - Finite Impulse Response (FIR) filtering

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

       mlib_status mlib_SignalFIR_F32S_F32S(mlib_f32 *dst, const mlib_f32 *src,
	    void *filter, mlib_s32 n);

DESCRIPTION
       The mlib_SignalFIR_F32S_F32S() function applies the FIR filter to one signal packet and updates the filter state.

PARAMETERS
       The function takes the following arguments:

       dst	 Output stereo signal array . . dst[2*i] contains Channel 0, and dst[2*i+1] contains Channel 1.

       src	 Input stereo signal array. src[2*i] contains Channel 0, and src[2*i+1] contains Channel 1.

       filter	 Internal filter structure.

       n	 Number of samples in the input signal array.

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_SignalFIR_F32S_F32S(3MLIB)