'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved 
.TH mlib_SignalFIRInit_S16_S16 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions"
.SH NAME
mlib_SignalFIRInit_S16_S16, mlib_SignalFIRInit_S16S_S16S \- Finite Impulse Response (FIR) filtering
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ]
#include <mlib.h>

\fBmlib_status\fR \fBmlib_SignalFIRInit_S16_S16\fR(\fBvoid **\fR\fIfilter\fR,
     \fBconst mlib_f32 *\fR\fIflt\fR,\fBmlib_s32\fR \fItap\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalFIRInit_S16S_S16S\fR(\fBvoid **\fR\fIfilter\fR,
     \fBconst mlib_f32 *\fR\fIflt\fR,\fBmlib_s32\fR \fItap\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Each of these functions allocates memory for the internal filter structure and converts the filter coefficients to an internal representation.
.SH PARAMETERS
.sp
.LP
Each of the functions takes the following arguments:
.sp
.ne 2
.mk
.na
\fB\fIfilter\fR\fR
.ad
.RS 10n
.rt  
Internal filter structure.
.RE

.sp
.ne 2
.mk
.na
\fB\fIflt\fR\fR
.ad
.RS 10n
.rt  
Filter coefficient array.
.RE

.sp
.ne 2
.mk
.na
\fB\fItap\fR\fR
.ad
.RS 10n
.rt  
Taps of the filter.
.RE

.SH RETURN VALUES
.sp
.LP
Each of the functions returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBmlib_SignalFIR_S16_S16_Sat\fR(3MLIB), \fBmlib_SignalFIRFree_S16_S16\fR(3MLIB), \fBattributes\fR(5)