Back to C-ASPT Contents Page
asptLbpef32f
API Summary
API to create and delete an asptLbpef32f filter
API to filter and update an asptLbpef32f filter
API to retrieve the properties of an asptLbpef32f filter
- DT32S lbpef32fGetCoef(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
- DT32S lbpef32fGetParcor(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
- DT32S lbpef32fGetDelayLine(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
- lbpef32fGetCoefPtr( asptLbpef32f
*lbpef )
- lbpef32fGetParcorPtr( asptLbpef32f
*lbpef )
- lbpef32fGetDelayLinePtr( asptLbpef32f
*lbpef )
- lbpef32fGetFilterLength( asptLbpef32f
*lbpef )
- lbpef32fGetPcStepSize( asptLbpef32f
*lbpef )
- lbpef32fGetLastErrorSample( asptLbpef32f
*lbpef )
- lbpef32fGetFirFlag( asptLbpef32f
*lbpef )
API to set the properties of an asptLbpef32f filter
- DT32S lbpef32fReset(asptLbpef32f *lbpef)
- DT32S lbpef32fResize(asptLbpef32f *lbpef, DT32S newLength)
- DT32S lbpef32fSetCoef(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
- DT32S lbpef32fSetParcor(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
- DT32S lbpef32fSetDelayLine(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
- lbpef32fSetPcStepSize( asptLbpef32f
*lbpef, newStep )
- lbpef32fSetFirFlag( asptLbpef32f
*lbpef, newFlag )
Description
Implements the LMS Lattice Backward Predictor Error Filter.
Copyright
Copyright (c) DSP ALGORITHMS 2003; all rights reserved.
<< Back to top
lbpef32fInit
DT32S lbpef32fInit(asptLbpef32f *lbpef, DT32S L, DT32F mu_p)
Initializes an asptLbpef32f filter and allocates its necessary storage buffers - Returns :
-
Error code. On failure, the filterLength member of the filter is set to zero.
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be initializes
- len : number of lattice stages
- mu_p : PARCOR step size.
- Output Parameters :
- lbpef is initialized using the given input arguments.
- Error Conditions
- ASPT_NO_ERR : Initialization is successful
- ASPT_NULL_PTR_ERR : lbpef is a NULL pointer
- ASPT_RANGE_ERR : len is not a valid input value
- ASPT_NO_MEM_ERR : could not allocate memory
<< Back to top
lbpef32fInitStatic
DT32S lbpef32fInitStatic(asptLbpef32f *lbpef,DT32S L, DT32F mu_p, DT32F *pCof, DT32F *pDat)
Initializes an asptLbpef32f filter to use pre-allocated memory blocks - Returns :
-
Error code. On failure, the filterLength member of the filter is set to zero.
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be initializes
- len : number of lattice stages
- mu_p : PARCOR step size.
- pCof : pointer to a pre-allocated memory in program memory
of at least [2*len] DT32F locations to be used for the filter/PARCOR coefficients.
- pDat : pointer to a pre-allocated memory in data memory of at least
[4*(len+1)] DT32F locations to be used for data storage.
- Output Parameters :
- lbpef is initialized using the given input arguments.
- Error Conditions
- ASPT_NO_ERR : Initialization is successful
- ASPT_NULL_PTR_ERR : lbpef/pCof/pDat is a NULL pointer
- ASPT_RANGE_ERR : len is not a valid input value
- ASPT_NO_MEM_ERR : could not allocate memory
<< Back to top
lbpef32fFilterUpdate
DT32F lbpef32fFilterUpdate(asptLbpef32f *lbpef, DT32F x)
Calculates the filter output and updates the PARCOR and linear combiner coefficients of an asptLbpef32f filter. - Returns :
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter.
- x : input sample.
- Remarks :
-
The error sample is stored internally and can be retrieved by calling lbpef32fGetLastErrorSample().
<< Back to top
lbpef32fFilterOnly
DT32F lbpef32fFilterOnly(asptLbpef32f *lbpef, DT32F x)
Calculates the filter output but does not updates the PARCOR nor the linear combiner coefficients. It updates the internal buffers. - Returns :
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter.
- x : input sample.
<< Back to top
lbpef32fFree
void lbpef32fFree(asptLbpef32f *lbpef)
Frees the allocated memory for this asptLbpef32f filter. - Returns :
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter
- Remarks :
-
Use this function only for asptLbpef32f filters created using lbpef32fInit(). Do not use with filters created with lmsLattice32fInitStatic().
<< Back to top
lbpef32fReset
DT32S lbpef32fReset(asptLbpef32f *lbpef)
Resets all PARCOR and linear combiner coefficients to zero.- Returns :
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be reset
- Error Conditions
- ASPT_NO_ERR : success
- ASPT_NULL_PTR_ERR : NULL pointer error
<< Back to top
lbpef32fGetCoef
DT32S lbpef32fGetCoef(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
Copies N internal linear combiner coefficients starting from coef[ind] to dstBuf. - Returns :
-
On success returns the number of coefficients copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter.
- dstBuf : pointer to the destination buffer.
- ind : index to the first coefficient to be copied.
- N : number of coefficients to be copied.
- flip : if 1, will flip the coefficients order
- Error Conditions
- ASPT_NULL_PTR_ERR : dstBuf/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fSetCoef
DT32S lbpef32fSetCoef(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
Initializes N internal linear combiner filter coefficients starting from coef[ind] to the contents of newCoef. - Returns :
-
On success returns the number of coefficients copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be set.
- newCoef : pointer to the new coefficients vector.
- ind : index to the first coefficient to be set.
- N : number of coefficients to be set.
- flip : if 1, will flip the coefficients order.
- Error Conditions
- ASPT_NULL_PTR_ERR : newCoef/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fGetParcor
DT32S lbpef32fGetParcor(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
Copies N internal PARCOR coefficients starting from coef[ind] to dstBuf. - Returns :
-
On success returns the number of coefficients copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter.
- dstBuf : pointer to the destination buffer.
- ind : index to the first coefficient to be copied.
- N : number of coefficients to be copied.
- flip : if 1, will flip the coefficients order.
- Error Conditions
- ASPT_NULL_PTR_ERR : dstBuf/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fSetCoef
DT32S lbpef32fSetCoef(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
Initializes N internal PARCOR filter coefficients starting from coef[ind] to the contents of newCoef. - Returns :
-
On success returns the number of coefficients copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be set.
- newCoef : pointer to the new PARCOR vector.
- ind : index to the first coefficient to be set.
- N : number of coefficients to be set.
- flip : if 1, will flip the coefficients order.
- Error Conditions
- ASPT_NULL_PTR_ERR : newCoef/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fGetDelayLine
DT32S lbpef32fGetDelayLine(asptLbpef32f *lbpef, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
Copies the N internal backward prediction error samples starting from delayLine[ind] sample to the given array. - Returns :
-
On success returns the number of samples copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter.
- dstBuf : pointer to the destination buffer.
- ind : index to the first sample to be copied.
- N : number of samples to be copied.
- flip : if 1, will flip the samples order.
- Error Conditions
- ASPT_NULL_PTR_ERR : newCoef/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fSetDelayLine
DT32S lbpef32fSetDelayLine(asptLbpef32f *lbpef, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
Initializes N internal backward prediction samples starting from delayLine[ind] to the contents of newBuf. - Returns :
-
On success returns the number of coefficients copied, otherwise the error code (negative DT32S).
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be set.
- newBuf : pointer to the new PARCOR vector.
- ind : index to the first coefficient to be set.
- N : number of coefficients to be set.
- flip : if 1, will flip the coefficients order.
- Error Conditions
- ASPT_NULL_PTR_ERR : newBuf/lbpef is a NULL pointer
- ASPT_RANGE_ERR : ind/N is not a valid input value
<< Back to top
lbpef32fResize
DT32S lbpef32fResize(asptLbpef32f *lbpef, DT32S newLength)
Resizes an asptLbpef32f filter keeping as much of the filter state as possible. - Returns :
- Input Parameters :
- lbpef : pointer to asptLbpef32f filter to be resized.
- newLen : required new filter length.
- Error Conditions
- ASPT_NO_ERR : Resizing is successful
- ASPT_NULL_PTR_ERR : NULL pointer error
- ASPT_RANGE_ERR : newLength is not a valid input value
- ASPT_NO_MEM_ERR : Could not allocate the necessary filter storage
- Remarks :
-
Use this function only with dynamically allocated asptLbpef32f filters.