FIRGetStateSize, FIRMRGetStateSize

Returns the length of the FIR filter state structure.

Syntax

Case 1: Single-rate filter

IppStatus ippsFIRGetStateSize_16s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize_32s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize_32f(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize_32fc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize_64f(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize_64fc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32s_16s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32s_16s32f(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32sc_16sc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32sc_16sc32fc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32f_16s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize32fc_16sc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64f_16s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64f_32f(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64f_32s(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64fc_16sc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64fc_32sc(int tapsLen, int* pBufferSize);

IppStatus ippsFIRGetStateSize64fc_32fc(int tapsLen, int* pBufferSize);

Case 2: Multi-rate filter

IppStatus ippsFIRMRGetStateSize_16s(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize_32f(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize_32fc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize_64f(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize_64fc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32s_16s(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32s_16s32f(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32sc_16sc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32sc_16sc32fc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32f_16s(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize32fc_16sc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64f_16s(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64f_32s(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64f_32f(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64fc_16sc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64fc_32sc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

IppStatus ippsFIRMRGetStateSize64fc_32fc(int tapsLen, int upFactor, int downFactor, int* pBufferSize);

Parameters

tapsLen	Number of elements in the array containing the tap values.
upFactor	Upsampling factor for the multi-rate filter.
downFactor	Downsampling factor for the multi-rate filter.
pBufferSize	Pointer to the computed buffer size value.

Description

The functions ippsFIRGetStateSize and ippsFIRMRGetStateSize are declared in the ipps.h file. These functions compute the size of the external buffer for a single-rate or multi-rate FIR filter state, respectively, and store the result in pBufferSize.

To compute the size of a buffer for the single-rate FIR filter state, the number of taps tapsLen only need be specified. To compute the size of a buffer for the multi-rate FIR filter state, the number of taps tapsLen and upsampling/downsampling parameters upFactor and downFactor must be specified. The parameter upFactor is the factor by which the filtered signal is internally upsampled (see description of the function ippsSampleUp for more details). That is, upFactor-1 zeros are inserted between each sample of the input signal.

The parameter downFactor is the factor by which the FIR response obtained by filtering an upsampled input signal, is internally downsampled (see description of the function ippsSampleDown for more details). That is, downFactor-1 output samples are discarded from each downFactor-length output block of the upsampled filter response.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error if the pBufferSize pointer is NULL.
ippStsFIRLenErr	Indicates an error if tapsLen is less than or equal to 0.
ippStsFIRMRFactorErr	Indicates an error if upFactor (downFactor) is less than or equal to 0.