/* ----------------------------------------------------------------------
 * Project:      CMSIS DSP Library
 * Title:        arm_biquad_cascade_df1_q31.c
 * Description:  Processing function for the Q31 Biquad cascade filter
 *
 * $Date:        23 April 2021
 * $Revision:    V1.9.0
 *
 * Target Processor: Cortex-M and Cortex-A cores
 * -------------------------------------------------------------------- */
/*
 * Copyright (C) 2010-2021 ARM Limited or its affiliates. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the License); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "dsp/filtering_functions.h"

/**
  @ingroup groupFilters
 */

/**
  @addtogroup BiquadCascadeDF1
  @{
 */

/**
  @brief         Processing function for the Q31 Biquad cascade filter.
  @param[in]     S         points to an instance of the Q31 Biquad cascade structure
  @param[in]     pSrc      points to the block of input data
  @param[out]    pDst      points to the block of output data
  @param[in]     blockSize  number of samples to process

  @par           Scaling and Overflow Behavior
                   The function is implemented using an internal 64-bit accumulator.
                   The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit.
                   Thus, if the accumulator result overflows it wraps around rather than clip.
                   In order to avoid overflows completely the input signal must be scaled down by 2 bits and lie in the range [-0.25 +0.25).
                   After all 5 multiply-accumulates are performed, the 2.62 accumulator is shifted by <code>postShift</code> bits and the result truncated to
                   1.31 format by discarding the low 32 bits.
  @remark
                   Refer to \ref arm_biquad_cascade_df1_fast_q31() for a faster but less precise implementation of this filter.
 */
#if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE)

ARM_DSP_ATTRIBUTE void arm_biquad_cascade_df1_q31(
  const arm_biquad_casd_df1_inst_q31 * S,
  const q31_t * pSrc,
        q31_t * pDst,
        uint32_t blockSize)
{
    const q31_t    *pIn = pSrc; /*  input pointer initialization  */
    q31_t          *pOut = pDst;        /*  output pointer initialization */
    int             shift;
    uint32_t        stages = S->numStages;      /*  loop counters                 */
    int             postShift = S->postShift;
    q31x4_t         b0Coeffs, b1Coeffs, a0Coeffs, a1Coeffs;     /*  Coefficients vector           */
    q31x4_t         stateVec = { 0 };
    q31_t          *pState = S->pState; /*  pState pointer initialization */
    q31x4_t         inVec0;
    int64_t         acc;
    const q31_t          *pCoeffs = S->pCoeffs;       /*  coeff pointer initialization  */
    q31_t           out, out1;


    shift = (postShift + 1 + 8);

    do {
        /*
         * Reading the coefficients
         * generates :
         * Fwd0 { b2  b1  b0  0  }
         * Fwd1 { 0   b2  b1  b0 }
         * Bwd0 { 0   0   a2  a1 }
         * Bwd0 { 0   0   a1  a2 }
         * (can be moved in init)
         */
        b0Coeffs = vdupq_n_s32(0);
        a0Coeffs = vdupq_n_s32(0);

        b0Coeffs[0] = pCoeffs[2];       // b2
        b0Coeffs[1] = pCoeffs[1];       // b1
        b0Coeffs[2] = pCoeffs[0];       // b0

        b1Coeffs = b0Coeffs;
        uint32_t        zero = 0;
        b1Coeffs = vshlcq_s32(b1Coeffs, &zero, 32);

        a0Coeffs[2] = pCoeffs[4];
        a0Coeffs[3] = pCoeffs[3];
        a1Coeffs = vrev64q_s32(a0Coeffs);


        /*
         * prologue consumes history samples
         */

        /* 2 first elements are garbage, will be updated with history */
        inVec0 = vld1q(pIn - 2);

        inVec0[0] = pState[1];
        inVec0[1] = pState[0];

        stateVec[2] = pState[3];
        stateVec[3] = pState[2];

        acc = vrmlaldavhq(b0Coeffs, inVec0);
        acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
        acc = lsll(acc, shift);
        out = (q31_t) ((acc >> 32) & 0xffffffff);

        stateVec[2] = out;
        acc = vrmlaldavhq(b1Coeffs, inVec0);
        acc = vrmlaldavhaq(acc, a1Coeffs, stateVec);

        acc = lsll(acc, shift);
        out1 = (q31_t) ((acc >> 32) & 0xffffffff);


        inVec0 = vld1q(pIn);
        pIn += 2;

        /*
         * main loop
         */
        uint32_t            sample = (blockSize - 2) >> 2U;
        /*
         * First part of the processing with loop unrolling.
         * Compute 4 outputs at a time.
         */
        while (sample > 0U) {

            stateVec[3] = out1;

            *pOut++ = out;
            *pOut++ = out1;

            /*
             * in         { x0  x1  x2  x3 }
             *                    x
             * b0Coeffs   { b2  b1  b0  0  }
             */
            acc = vrmlaldavhq(b0Coeffs, inVec0);
            /*
             * out         { 0   0   yn2 yn1 }
             *                    x
             * a0Coeffs    { 0   0   a2  a1  }
             */
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[2] = out;

            /*
             * in         { x0  x1  x2  x3 }
             *                    x
             * b0Coeffs   {  0  b2  b1  b0 }
             */
            acc = vrmlaldavhq(b1Coeffs, inVec0);
            /*
             * out         { 0   0   y0  yn1 }
             *                    x
             * a0Coeffs    { 0   0   a1  a2  }
             */
            acc = vrmlaldavhaq(acc, a1Coeffs, stateVec);
            acc = lsll(acc, shift);
            out1 = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[3] = out1;

            inVec0 = vld1q(pIn);
            pIn += 2;

            /* unrolled part */
            *pOut++ = out;
            *pOut++ = out1;

            acc = vrmlaldavhq(b0Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[2] = out;

            acc = vrmlaldavhq(b1Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a1Coeffs, stateVec);
            acc = lsll(acc, shift);
            out1 = (q31_t) ((acc >> 32) & 0xffffffff);

            inVec0 = vld1q(pIn);
            pIn += 2;

            sample--;
        }

        *pOut++ = out;
        *pOut++ = out1;

        /*
         * Tail handling
         */
        int32_t         loopRemainder = blockSize & 3;
        if (loopRemainder == 2) {
            /*
             * Store the updated state variables back into the pState array
             */
            pState[0] = inVec0[1];
            pState[1] = inVec0[0];
            pState[3] = out;
            pState[2] = out1;
        } else if (loopRemainder == 1) {
            stateVec[3] = out1;

            acc = vrmlaldavhq(b0Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[2] = out;

            acc = vrmlaldavhq(b1Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a1Coeffs, stateVec);
            acc = lsll(acc, shift);
            out1 = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[3] = out1;

            inVec0 = vld1q(pIn);
            pIn += 2;

            *pOut++ = out;
            *pOut++ = out1;

            acc = vrmlaldavhq(b0Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            *pOut++ = out;

            /*
             * Store the updated state variables back into the pState array
             */
            pState[0] = inVec0[2];
            pState[1] = inVec0[1];
            pState[3] = out1;
            pState[2] = out;
        } else if (loopRemainder == 0) {
            stateVec[3] = out1;

            acc = vrmlaldavhq(b0Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            stateVec[2] = out;

            acc = vrmlaldavhq(b1Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a1Coeffs, stateVec);
            acc = lsll(acc, shift);
            out1 = (q31_t) ((acc >> 32) & 0xffffffff);

            *pOut++ = out;
            *pOut++ = out1;

            /*
             * Store the updated state variables back into the pState array
             */
            pState[0] = inVec0[3];
            pState[1] = inVec0[2];
            pState[3] = out;
            pState[2] = out1;
        } else {
            stateVec[3] = out1;

            acc = vrmlaldavhq(b0Coeffs, inVec0);
            acc = vrmlaldavhaq(acc, a0Coeffs, stateVec);
            acc = lsll(acc, shift);
            out = (q31_t) ((acc >> 32) & 0xffffffff);

            *pOut++ = out;

            /*
             * Store the updated state variables back into the pState array
             */
            pState[0] = inVec0[2];
            pState[1] = inVec0[1];
            pState[3] = out1;
            pState[2] = out;
        }


        pCoeffs += 5;
        pState += 4;

        /*  The first stage goes from the input buffer to the output buffer. */
        /*  Subsequent stages occur in-place in the output buffer */
        pIn = pDst;

        /* Reset to destination pointer */
        pOut = pDst;
    }
    while (--stages);
}
#else
ARM_DSP_ATTRIBUTE void arm_biquad_cascade_df1_q31(
  const arm_biquad_casd_df1_inst_q31 * S,
  const q31_t * pSrc,
        q31_t * pDst,
        uint32_t blockSize)
{
  const q31_t *pIn = pSrc;                             /* Source pointer */
        q31_t *pOut = pDst;                            /* Destination pointer */
        q31_t *pState = S->pState;                     /* pState pointer */
  const q31_t *pCoeffs = S->pCoeffs;                   /* Coefficient pointer */
        q63_t acc;                                     /* Accumulator */
        q31_t b0, b1, b2, a1, a2;                      /* Filter coefficients */
        q31_t Xn1, Xn2, Yn1, Yn2;                      /* Filter pState variables */
        q31_t Xn;                                      /* Temporary input */
        uint32_t uShift = ((uint32_t) S->postShift + 1U);
        uint32_t lShift = 32U - uShift;                /* Shift to be applied to the output */
        uint32_t sample, stage = S->numStages;         /* Loop counters */

#if defined (ARM_MATH_LOOPUNROLL)
        q31_t acc_l, acc_h;                            /* temporary output variables */
#endif

  do
  {
    /* Reading the coefficients */
    b0 = *pCoeffs++;
    b1 = *pCoeffs++;
    b2 = *pCoeffs++;
    a1 = *pCoeffs++;
    a2 = *pCoeffs++;

    /* Reading the pState values */
    Xn1 = pState[0];
    Xn2 = pState[1];
    Yn1 = pState[2];
    Yn2 = pState[3];

#if defined (ARM_MATH_LOOPUNROLL)

    /* Apply loop unrolling and compute 4 output values simultaneously. */
    /* Variable acc hold output values that are being computed:
     *
     * acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2]
     */

    /* Loop unrolling: Compute 4 outputs at a time */
    sample = blockSize >> 2U;

    while (sample > 0U)
    {
      /* Read the first input */
      Xn = *pIn++;

      /* acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2] */
      acc = ((q63_t) b0 * Xn) + ((q63_t) b1 * Xn1) + ((q63_t) b2 * Xn2) + ((q63_t) a1 * Yn1) + ((q63_t) a2 * Yn2);

      /* The result is converted to 1.31 , Yn2 variable is reused */
      acc_l = (acc      ) & 0xffffffff; /* Calc lower part of acc */
      acc_h = (acc >> 32) & 0xffffffff; /* Calc upper part of acc */

      /* Apply shift for lower part of acc and upper part of acc */
      Yn2 = (uint32_t) acc_l >> lShift | acc_h << uShift;

      /* Store output in destination buffer. */
      *pOut++ = Yn2;

      /* Read the second input */
      Xn2 = *pIn++;

      /* acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2] */
      acc = ((q63_t) b0 * Xn2) + ((q63_t) b1 * Xn) + ((q63_t) b2 * Xn1) + ((q63_t) a1 * Yn2) + ((q63_t) a2 * Yn1);

      /* The result is converted to 1.31, Yn1 variable is reused  */
      acc_l = (acc      ) & 0xffffffff; /* Calc lower part of acc */
      acc_h = (acc >> 32) & 0xffffffff; /* Calc upper part of acc */

      /* Apply shift for lower part of acc and upper part of acc */
      Yn1 = (uint32_t) acc_l >> lShift | acc_h << uShift;

      /* Store output in destination buffer. */
      *pOut++ = Yn1;

      /* Read the third input */
      Xn1 = *pIn++;

      /* acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2] */
      acc = ((q63_t) b0 * Xn1) + ((q63_t) b1 * Xn2) + ((q63_t) b2 * Xn) + ((q63_t) a1 * Yn1) + ((q63_t) a2 * Yn2);

      /* The result is converted to 1.31, Yn2 variable is reused  */
      acc_l = (acc      ) & 0xffffffff; /* Calc lower part of acc */
      acc_h = (acc >> 32) & 0xffffffff; /* Calc upper part of acc */

      /* Apply shift for lower part of acc and upper part of acc */
      Yn2 = (uint32_t) acc_l >> lShift | acc_h << uShift;

      /* Store output in destination buffer. */
      *pOut++ = Yn2;

      /* Read the forth input */
      Xn = *pIn++;

      /* acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2] */
      acc = ((q63_t) b0 * Xn) + ((q63_t) b1 * Xn1) + ((q63_t) b2 * Xn2) + ((q63_t) a1 * Yn2) + ((q63_t) a2 * Yn1);

      /* The result is converted to 1.31, Yn1 variable is reused  */
      acc_l = (acc      ) & 0xffffffff; /* Calc lower part of acc */
      acc_h = (acc >> 32) & 0xffffffff; /* Calc upper part of acc */

      /* Apply shift for lower part of acc and upper part of acc */
      Yn1 = (uint32_t) acc_l >> lShift | acc_h << uShift;

      /* Store output in destination buffer. */
      *pOut++ = Yn1;

      /* Every time after the output is computed state should be updated. */
      /* The states should be updated as: */
      /* Xn2 = Xn1 */
      /* Xn1 = Xn  */
      /* Yn2 = Yn1 */
      /* Yn1 = acc */
      Xn2 = Xn1;
      Xn1 = Xn;

      /* decrement loop counter */
      sample--;
    }

    /* Loop unrolling: Compute remaining outputs */
    sample = blockSize & 0x3U;

#else

    /* Initialize blkCnt with number of samples */
    sample = blockSize;

#endif /* #if defined (ARM_MATH_LOOPUNROLL) */

    while (sample > 0U)
    {
      /* Read the input */
      Xn = *pIn++;

      /* acc =  b0 * x[n] + b1 * x[n-1] + b2 * x[n-2] + a1 * y[n-1] + a2 * y[n-2] */
      acc = ((q63_t) b0 * Xn) + ((q63_t) b1 * Xn1) + ((q63_t) b2 * Xn2) + ((q63_t) a1 * Yn1) + ((q63_t) a2 * Yn2);

      /* The result is converted to 1.31  */
      acc = acc >> lShift;

      /* Store output in destination buffer. */
      *pOut++ = (q31_t) acc;

      /* Every time after the output is computed state should be updated. */
      /* The states should be updated as: */
      /* Xn2 = Xn1 */
      /* Xn1 = Xn  */
      /* Yn2 = Yn1 */
      /* Yn1 = acc */
      Xn2 = Xn1;
      Xn1 = Xn;
      Yn2 = Yn1;
      Yn1 = (q31_t) acc;

      /* decrement loop counter */
      sample--;
    }

    /* Store the updated state variables back into the pState array */
    *pState++ = Xn1;
    *pState++ = Xn2;
    *pState++ = Yn1;
    *pState++ = Yn2;

    /* The first stage goes from the input buffer to the output buffer. */
    /* Subsequent numStages occur in-place in the output buffer */
    pIn = pDst;

    /* Reset output pointer */
    pOut = pDst;

    /* decrement loop counter */
    stage--;

  } while (stage > 0U);

}
#endif /* defined(ARM_MATH_MVEI) */

/**
  @} end of BiquadCascadeDF1 group
 */
