asptRlslattice32f

API Summary

• DT32S rlslattice32fInit(asptRlslattice32f *rlsl, DT32S L, DT32F mu)
  
• DT32S rlslattice32fInitStatic(asptRlslattice32f *rlsl, DT32S L, DT32F mu, DT32F *pCof, DT32F *pDat)
  
• void rlslattice32fFree(asptRlslattice32f *rlsl)
  

• DT32F rlslattice32fFilterUpdate(asptRlslattice32f *rlsl, DT32F x, DT32F d)
  
• DT32F rlslattice32fFilterOnly(asptRlslattice32f *rlsl, DT32F x)
  

• DT32S rlslattice32fGetCoef(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S rlslattice32fGetForwardParcors(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S rlslattice32fGetBackwardParcors(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S rlslattice32fGetDelayLine(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• rlslattice32fGetCoefPtr( asptRlslattice32f *rlsl )
• rlslattice32fGetForwardParcorPtr( asptRlslattice32f *rlsl )
• rlslattice32fGetBackwardParcorPtr( asptRlslattice32f *rlsl )
• rlslattice32fGetDelayLinePtr( asptRlslattice32f *rlsl )
• rlslattice32fGetFilterLength( asptRlslattice32f *rlsl )
• rlslattice32fGetForgetFactor( asptRlslattice32f *rlsl )
• rlslattice32fGetLastErrorSample( asptRlslattice32f *rlsl )

• DT32S rlslattice32fReset(asptRlslattice32f *rlsl)
  
• DT32S rlslattice32fResize(asptRlslattice32f *rlsl, DT32S newLength)
  
• DT32S rlslattice32fSetDelayLine(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• rlslattice32fSetForgetFactor( asptRlslattice32f *rlsl, newFactor )

Description

Copyright

<< Back to top

rlslattice32fInit

DT32S rlslattice32fInit(asptRlslattice32f *rlsl, DT32S L, DT32F mu)

Initializes an asptRlslattice32f filter and allocates its necessary storage buffers
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f filter to be initializes
  • L : number of linear combiner coefficients
  • mu : forgetting factor
• Output Parameters :
  • rlsl is initialized using the given input arguments.
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_NULL_PTR_ERR : rlsl is a NULL pointer
  • ASPT_RANGE_ERR : L is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

rlslattice32fInitStatic

DT32S rlslattice32fInitStatic(asptRlslattice32f *rlsl, DT32S L, DT32F mu, DT32F *pCof, DT32F *pDat)

Initializes an asptRlslattice32f filter to use pre-allocated memory blocks
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f filter to be initialized
  • L : number of linear combiner coefficients
  • mu : forgetting factor
  • pCof : pointer to a pre-allocated memory in program memory of at least [3*len] DT32F locations to be used for the filter/PARCOR coefficients.
  • pDat : pointer to a pre-allocated memory in data memory of at least [6*len] DT32F locations to be used for data storage.
• Output Parameters :
  • rlsl is initialized using the given input arguments.
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_NULL_PTR_ERR : rlsl/pCof/pDat is a NULL pointer
  • ASPT_RANGE_ERR : len is not a valid input value

<< Back to top

rlslattice32fFilterUpdate

DT32F rlslattice32fFilterUpdate(asptRlslattice32f *rlsl, DT32F x, DT32F d)

Calculates the filter output and updates the PARCOR and linear combiner coefficients of an asptRlslattice32f filter.
• Returns :
  • The filter output.
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f filter.
  • x : input sample.
  • d : desired sample.
• Remarks :
  • The error sample is stored internally and can be retrieved by calling rlslattice32fGetLastErrorSample().

<< Back to top

rlslattice32fFilterOnly

DT32F rlslattice32fFilterOnly(asptRlslattice32f *rlsl, DT32F x)

Calculates the filter output but does not updates the PARCOR nor the linear combiner coefficients. It updates the internal buffers.
• Returns :
  • The filter output.
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f filter.
  • x : input sample.

<< Back to top

rlslattice32fFree

void rlslattice32fFree(asptRlslattice32f *rlsl)

Frees the allocated memory for this asptRlslattice32f filter.
• Returns :
  • void
• Input Parameters :
  • rlsl : pointer to the rlsl filter
• Remarks :
  • Use this function only for asptRlslattice32f filters created using rlslattice32fInit(). Do not use with filters created with rlsLattice32fInitStatic().

<< Back to top

rlslattice32fReset

DT32S rlslattice32fReset(asptRlslattice32f *rlsl)

Resets all internal filter states to pre-defined initial state.
• Returns :
  • Error code
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f filter to be reset
• Error Conditions
  • ASPT_NO_ERR : success
  • ASPT_NULL_PTR_ERR : NULL pointer error

<< Back to top

rlslattice32fGetCoef

DT32S rlslattice32fGetCoef(asptRlslattice32f *rlsl, 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 int).
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f 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/rlsl is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

rlslattice32fGetForwardParcors

DT32S rlslattice32fGetForwardParcors(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)

Copies N internal forward PARKOR coefficients starting from coef[ind] to dstBuf.
• Returns :
  • On success returns the number of coefficients copied, otherwise the error code (negative int).
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f 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/rlsl is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

rlslattice32fGetBackwardParcors

DT32S rlslattice32fGetBackwardParcors(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)

Copies N internal backward PARKOR coefficients starting from coef[ind] to dstBuf.
• Returns :
  • On success returns the number of coefficients copied, otherwise the error code (negative int).
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f 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/rlsl is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

rlslattice32fGetDelayLine

DT32S rlslattice32fGetDelayLine(asptRlslattice32f *rlsl, 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 int).
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f 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/rlsl is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

rlslattice32fSetDelayLine

DT32S rlslattice32fSetDelayLine(asptRlslattice32f *rlsl, DT32F *buf, DT32S ind, DT32S N, DT32S flip)

Initializes N internal backward prediction error samples starting from delayLine[ind] to the contents of newBuf.
• Returns :
  • On success returns the number of samples copied, otherwise the error code (negative int).
• Input Parameters :
  • rlsl : pointer to asptRlslattice32f 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/rlsl is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

rlslattice32fResize

DT32S rlslattice32fResize(asptRlslattice32f *rlsl, DT32S newLength)

Resizes an asptRlslattice32f filter keeping as much of the filter state as possible.
• Returns :
  • Error code
• Input Parameters :
  • rlsl : pointer to the asptRlslattice32f 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 asptRlslattice32f filters.