git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_fir_interpolate_init_f32.c

   1 /*-----------------------------------------------------------------------------
   2 * Copyright (C) 2010 ARM Limited. All rights reserved.
   3 *
   4 * $Date:        15. July 2011
   5 * $Revision:    V1.0.10
   6 *
   7 * Project:          CMSIS DSP Library
   8 * Title:        arm_fir_interpolate_init_f32.c
   9 *
  10 * Description:  Floating-point FIR interpolator initialization function
  11 *
  12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
  13 *
  14 * Version 1.0.10 2011/7/15
  15 *    Big Endian support added and Merged M0 and M3/M4 Source code.
  16 *
  17 * Version 1.0.3 2010/11/29
  18 *    Re-organized the CMSIS folders and updated documentation.
  19 *
  20 * Version 1.0.2 2010/11/11
  21 *    Documentation updated.
  22 *
  23 * Version 1.0.1 2010/10/05
  24 *    Production release and review comments incorporated.
  25 *
  26 * Version 1.0.0 2010/09/20
  27 *    Production release and review comments incorporated
  28 *
  29 * Version 0.0.7  2010/06/10
  30 *    Misra-C changes done
  31 * ---------------------------------------------------------------------------*/
  32
  33 #include "arm_math.h"
  34
  35 /**
  36  * @ingroup groupFilters
  37  */
  38
  39 /**
  40  * @addtogroup FIR_Interpolate
  41  * @{
  42  */
  43
  44 /**
  45  * @brief  Initialization function for the floating-point FIR interpolator.
  46  * @param[in,out] *S        points to an instance of the floating-point FIR interpolator structure.
  47  * @param[in]     L         upsample factor.
  48  * @param[in]     numTaps   number of filter coefficients in the filter.
  49  * @param[in]     *pCoeffs  points to the filter coefficient buffer.
  50  * @param[in]     *pState   points to the state buffer.
  51  * @param[in]     blockSize number of input samples to process per call.
  52  * @return        The function returns ARM_MATH_SUCCESS if initialization was successful or ARM_MATH_LENGTH_ERROR if
  53  * the filter length <code>numTaps</code> is not a multiple of the interpolation factor <code>L</code>.
  54  *
  55  * <b>Description:</b>
  56  * \par
  57  * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order:
  58  * <pre>
  59  *    {b[numTaps-1], b[numTaps-2], b[numTaps-2], ..., b[1], b[0]}
  60  * </pre>
  61  * The length of the filter <code>numTaps</code> must be a multiple of the interpolation factor <code>L</code>.
  62  * \par
  63  * <code>pState</code> points to the array of state variables.
  64  * <code>pState</code> is of length <code>(numTaps/L)+blockSize-1</code> words
  65  * where <code>blockSize</code> is the number of input samples processed by each call to <code>arm_fir_interpolate_f32()</code>.
  66  */
  67
  68 arm_status arm_fir_interpolate_init_f32(
  69   arm_fir_interpolate_instance_f32 * S,
  70   uint8_t L,
  71   uint16_t numTaps,
  72   float32_t * pCoeffs,
  73   float32_t * pState,
  74   uint32_t blockSize)
  75 {
  76   arm_status status;
  77
  78   /* The filter length must be a multiple of the interpolation factor */
  79   if((numTaps % L) != 0u)
  80   {
  81     /* Set status as ARM_MATH_LENGTH_ERROR */
  82     status = ARM_MATH_LENGTH_ERROR;
  83   }
  84   else
  85   {
  86
  87     /* Assign coefficient pointer */
  88     S->pCoeffs = pCoeffs;
  89
  90     /* Assign Interpolation factor */
  91     S->L = L;
  92
  93     /* Assign polyPhaseLength */
  94     S->phaseLength = numTaps / L;
  95
  96     /* Clear state buffer and size of state array is always phaseLength + blockSize - 1 */
  97     memset(pState, 0,
  98            (blockSize +
  99             ((uint32_t) S->phaseLength - 1u)) * sizeof(float32_t));
 100
 101     /* Assign state pointer */
 102     S->pState = pState;
 103
 104     status = ARM_MATH_SUCCESS;
 105   }
 106
 107   return (status);
 108
 109 }
 110
 111  /**
 112   * @} end of FIR_Interpolate group
 113   */