/github/workspace/src/TransformFunctions/kernels/plp_dwt_q16p_xpulpv2.c

Functions

	Name
void	plp_dwt_q16p_xpulpv2(void * args) Q15 fixed-point DWT for XPULPV2 extension.
void	plp_dwt_haar_q16p_xpulpv2(void * args) q15 fixed-point DWT kernel optimized for Haar Wavelet for XPULPV2 extension.

Defines

	Name
	HAAR_COEF
	MAC_SHIFT
	SHUFFLEMASK
	MAC(Acc, A, B)
	MSU(Acc, A, B)
	FILT_STEP

Functions Documentation

function plp_dwt_q16p_xpulpv2

void plp_dwt_q16p_xpulpv2(
    void * args
)

Q15 fixed-point DWT for XPULPV2 extension.

Parameters:

• args points to the plp_dwt_instance_q16

Return: none

function plp_dwt_haar_q16p_xpulpv2

void plp_dwt_haar_q16p_xpulpv2(
    void * args
)

q15 fixed-point DWT kernel optimized for Haar Wavelet for XPULPV2 extension.

Parameters:

• args points to the plp_dwt_instance_q16

Return: none

Macros Documentation

define HAAR_COEF

#define HAAR_COEF (0x5a82)

define MAC_SHIFT

#define MAC_SHIFT 15U

define SHUFFLEMASK

#define SHUFFLEMASK (v2s) { 1, 0 }

define MAC

#define MAC(
    Acc,
    A,
    B
)
Acc += ((int32_t)A * (int32_t)B);

define MSU

#define MSU(
    Acc,
    A,
    B
)
Acc -= ((int32_t)A * (int32_t)B);

define FILT_STEP

#define FILT_STEP 2

Source code

/* ----------------------------------------------------------------------
 * Project:      PULP DSP Library
 * Title:        plp_dwt_q16p_xpulpv2.c
 * Description:  Floating-point Discret Wavelet Transform on real input data for XPULPV2
 *
 * $Date:        10. Juli 2021
 * $Revision:    V1
 *
 * Target Processor: PULP cores with "F" support (wolfe)
 * -------------------------------------------------------------------- */
/*
 * Copyright (C) 2021 ETH Zurich and University of Bologna. All rights reserved.
 *
 * Author: Jakub Mandula, ETH Zurich
 *
 * 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 "plp_math.h"
#include "plp_const_structs.h"

/* HELPER FUNCTIONS */



#define HAAR_COEF (0x5a82)

#define MAC_SHIFT 15U

#define SHUFFLEMASK (v2s) { 1, 0 }

// #define MAC(Acc, A, B) Acc = __MACS(Acc, A, B);
#define MAC(Acc, A, B) Acc += ((int32_t)A * (int32_t)B);
#define MSU(Acc, A, B) Acc -= ((int32_t)A * (int32_t)B);

#define FILT_STEP 2

#include "plp_dwt_signal_ext.h"


void plp_dwt_q16p_xpulpv2(void *args) {

    plp_dwt_instance_q16 *S = (plp_dwt_instance_q16*) args;

    const int16_t *pSrc = S->pSrc;
    const uint32_t length = S->length;
    const plp_dwt_wavelet_q16 wavelet = S->wavelet;
    plp_dwt_extension_mode mode = S->mode;

    const uint32_t nPE = S->nPE;

    const uint32_t core_id = hal_core_id();

    int16_t *pCurrentA = S->pDstA + core_id;
    int16_t *pCurrentD = S->pDstD + core_id;

    int32_t offset = 1 + FILT_STEP * core_id;

    const uint32_t step = FILT_STEP * nPE;


    /***
     * The filter convolution is done in 4 steps handling cases where
     *  1. Filter is hanging over the left side of the signal
     *  2. Filter is same size, or totally enclosed in signal
     *  3. Filter is larger than the enclosed signal and hangs over both edges
     *  4. Filter hangs over the right side of the signal
     * 
     *  Each of the cases, where signal hangs over the boundary of the signal, values are computed 
     *  on demand based on the edge extension mode.
     */


    /*  Step 1.
     *  Handle Left overhanging
     *
     * X() =  x x[A B C D E F]
     * H() = [d c b a]
     *          ^   ^
     *          |   First compute the filter part overlapping with the signal
     *          Then extend the signal (x x) by computing the values based on the extension mode
     */
    for(; offset < wavelet.length - 1 && offset < length; offset += step){
        int32_t sum_lo = 0;
        int32_t sum_hi = 0;

        uint32_t filt_j = 0;

        // Compute Filter overlapping with signal
        for(; filt_j <= offset; filt_j++){
            MAC(sum_lo, wavelet.dec_lo[filt_j], pSrc[offset - filt_j]);
            MAC(sum_hi, wavelet.dec_hi[filt_j], pSrc[offset - filt_j]);
        }

        // Compute Left edge extension
        switch(mode){
            case PLP_DWT_MODE_CONSTANT:
                CONSTANT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_SYMMETRIC:
                SYMMETRIC_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_REFLECT:
                REFLECT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTISYMMETRIC:
                ANTISYMMETRIC_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTIREFLECT:
                ANTIREFLECT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset, int32_t);
                break;
            case PLP_DWT_MODE_PERIODIC:
            case PLP_DWT_MODE_ZERO:
            default:
                break;
        }


        *pCurrentA = sum_lo >> MAC_SHIFT;
        *pCurrentD = sum_hi >> MAC_SHIFT;

        pCurrentA += nPE;
        pCurrentD += nPE;
    }

    /*  Step 2.
     *  Compute center (length >= wavelet.length)
     *
     *  X() = [A B C D E F]
     *  h() =   [d c b a]
     *                 ^
     *                 Compute a full convolution of the filter with the signal
     */ 


    for(;offset < length; offset += step){

        int32_t sum_lo = 0;
        int32_t sum_hi = 0;

        /* We can process 2 elements at a time (Filter length should always be even)
         *
         * X =  ... x3[x4 x5]x6 ...
         * Y1 = ... y5[y4 y3]y1 ...
         * 
         * Acc += DOTP2([x5 x4], [y3 y4])
         **/
        uint32_t blkCnt = wavelet.length >> 1U;

        const int16_t *pYlo = wavelet.dec_lo; // Start of wavelet lo
        const int16_t *pYhi = wavelet.dec_hi; // Start of wavelet hi
        const int16_t *pX = pSrc + offset;

        while (blkCnt > 0U){
            v2s v_ylo = *((v2s *)pYlo);     // {lo[0], lo[1]}
            v2s v_yhi = *((v2s *)pYhi);     // {hi[0], hi[1]}
            v2s v_x   = *((v2s *)(pX - 1)); // { x[0],  x[1]}

            // We flip the input order for convolution
            v2s v_sx = __builtin_shuffle(v_x, v_x, SHUFFLEMASK); // {x[1], x[0]}

            sum_lo = __SUMDOTP2(v_sx, v_ylo, sum_lo);
            sum_hi = __SUMDOTP2(v_sx, v_yhi, sum_hi);

            pYlo += 2;
            pYhi += 2;
            pX   -= 2;

            blkCnt--;
        }

        *pCurrentA = sum_lo >> MAC_SHIFT;
        *pCurrentD = sum_hi >> MAC_SHIFT;

        pCurrentA += nPE;
        pCurrentD += nPE;
    }

    /*  Step 3.
     *  Compute center (length < wavelet.length)
     *
     *  X() =   y y[A B C]x x x
     *  h() =  [h g f e d c b a]
     *            ^     ^     ^
     *            |     |     Compute Right extension (x x x) based on extension mode
     *            |     Compute a full convolution of the filter overlapping with the signal
     *            Compute Left extension (y y) based on extension mode
     */      

    for(;offset < wavelet.length - 1; offset += step){

        int32_t sum_lo = 0;
        int32_t sum_hi = 0;

        uint32_t filt_j = 0;

        // Filter Right extension
        switch(mode){
            case PLP_DWT_MODE_CONSTANT:
                CONSTANT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_SYMMETRIC:
                SYMMETRIC_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_REFLECT:
                REFLECT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTISYMMETRIC:
                ANTISYMMETRIC_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTIREFLECT:
                ANTIREFLECT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset, int32_t);
                break;
            case PLP_DWT_MODE_PERIODIC:
            case PLP_DWT_MODE_ZERO:
            default:
                filt_j = offset - length + 1;
                break;
        }

        // Filter Center overlapp
        for(; filt_j <= offset; filt_j++){
            MAC(sum_lo, wavelet.dec_lo[filt_j], pSrc[offset - filt_j]);
            MAC(sum_hi, wavelet.dec_hi[filt_j], pSrc[offset - filt_j]);
        }   

        // Filter Left extension
        switch(mode){
            case PLP_DWT_MODE_CONSTANT:
                CONSTANT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_SYMMETRIC:
                SYMMETRIC_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_REFLECT:
                REFLECT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTISYMMETRIC:
                ANTISYMMETRIC_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTIREFLECT:
                ANTIREFLECT_EDGE_LEFT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset, int32_t);
                break;
            case PLP_DWT_MODE_PERIODIC:
            case PLP_DWT_MODE_ZERO:
            default:
                break;
        }

        *pCurrentA = sum_lo >> MAC_SHIFT;
        *pCurrentD = sum_hi >> MAC_SHIFT;

        pCurrentA += nPE;
        pCurrentD += nPE;
    }


    /*  Step 4.
     *  Handle Right overhanging
     *
     * X() = [A B C D E F]x x
     * H() =         [d c b a]
     *                  ^   ^
     *                  |   First extend the signal (x x) by computing the values based on the extension mode
     *                  Then compute the filter part overlapping with the signal
     */
    for(; offset < length + wavelet.length - 1; offset += step){
        int32_t sum_lo = 0;
        int32_t sum_hi = 0;

        uint32_t filt_j = 0;

        // Compute Left edge extension
        switch(mode){
            case PLP_DWT_MODE_CONSTANT:
                CONSTANT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_SYMMETRIC:
                SYMMETRIC_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_REFLECT:
                REFLECT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTISYMMETRIC:
                ANTISYMMETRIC_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset);
                break;
            case PLP_DWT_MODE_ANTIREFLECT:
                ANTIREFLECT_EDGE_RIGHT(sum_lo, sum_hi, pSrc, length, wavelet, filt_j, offset, int32_t);
                break;
            case PLP_DWT_MODE_PERIODIC:
            case PLP_DWT_MODE_ZERO:
            default:
                filt_j = offset - length + 1;
                break;
        }

        // Filter overlapping with signal
        for(; filt_j < wavelet.length; filt_j++){
            MAC(sum_lo, wavelet.dec_lo[filt_j], pSrc[offset - filt_j]);
            MAC(sum_hi, wavelet.dec_hi[filt_j], pSrc[offset - filt_j]);
        }

        *pCurrentA = sum_lo >> MAC_SHIFT;
        *pCurrentD = sum_hi >> MAC_SHIFT;

        pCurrentA += nPE;
        pCurrentD += nPE;
    }
}




void plp_dwt_haar_q16p_xpulpv2(void *args) {

    plp_dwt_instance_q16 *S = (plp_dwt_instance_q16*) args;

    const int16_t *pSrc = S->pSrc;
    const uint32_t length = S->length;
    plp_dwt_extension_mode mode = S->mode;

    const uint32_t nPE = S->nPE;

    const uint32_t core_id = hal_core_id();

    int16_t *pCurrentA = S->pDstA + 2U * core_id;
    int16_t *pCurrentD = S->pDstD + 2U * core_id;

    // Vectored filter coefficients
    static v2s v_ylo = (v2s){HAAR_COEF, HAAR_COEF};
    static v2s v_yhi = (v2s){HAAR_COEF, -HAAR_COEF};
    v2s v_x1, v_x2;

    /***
     * The filter convolution is done in 2 steps handling cases where
     *  1. Filter is same size, or totally enclosed in signal center
     *  2. Filter hangs over the right side of the signal
     * 
     *  In of the cases, where signal hangs over the boundary of the signal, values are computed 
     *  on demand based on the edge extension mode.
     */



    /*  Step 1.
     *  Compute center (length >= wavelet.length)
     *
     *  X() = [A B C D E F]
     *  h() =       [b a]
     *                 ^
     *                 Compute a full convolution of the filter with the signal
     */ 

    // We read 2 numbers at a time performing one convolution per loop
    int32_t blkCnt = (length >> 2U) - core_id;
    const int16_t *pS = pSrc + 4U * core_id;

    int16_t destA1, destA2, destD1, destD2;

    while(blkCnt > 0){

        v_x1   = *((v2s *)(pS));     // { x[0],  x[1]}
        pS   += 2U;
        v_x2   = *((v2s *)(pS));     // { x[0],  x[1]}
        pS   += 4U * nPE - 2U;

        destA1 = __DOTP2(v_x1, v_ylo) >> MAC_SHIFT;
        destD1 = __DOTP2(v_x1, v_yhi) >> MAC_SHIFT;

        destA2 = __DOTP2(v_x2, v_ylo) >> MAC_SHIFT;
        destD2 = __DOTP2(v_x2, v_yhi) >> MAC_SHIFT;

        *((v2s *)pCurrentA) = __PACK2(destA1, destA2);
        *((v2s *)pCurrentD) = __PACK2(destD1, destD2);

        pCurrentA += 2 * nPE;
        pCurrentD += 2 * nPE;
        blkCnt -= nPE;
    }

    if(blkCnt != 0) {
        return;
    }

    switch(length % 4U){
    case 1:
        //We have one element left (odd length)
        break;
    case 2:
    case 3:
        // We have a pair left
        v_x1   = *((v2s *)(pS));     // { x[0],  x[1]}

        *pCurrentA++ = __DOTP2(v_x1, v_ylo) >> MAC_SHIFT;
        *pCurrentD++ = __DOTP2(v_x1, v_yhi) >> MAC_SHIFT;

        break;

    case 0:
    default:
        // We are done actually (signal divisible by 4)
        return;
    }



    // while(blkCnt > 0){
    //     v_x   = *((v2s *)(pS));     // { x[0],  x[1]}

    //     *pCurrentA = __DOTP2(v_x, v_ylo) >> MAC_SHIFT;
    //     *pCurrentD = __DOTP2(v_x, v_yhi) >> MAC_SHIFT;

    //     pCurrentA += nPE;
    //     pCurrentD += nPE;

    //     pS   += 2U * nPE;
    //     blkCnt -= nPE;
    // }





    /*  Step 2.
     *  Handle Right overhanging (only for odd signal lengths)
     *
     * X() = [A B C D E F]x
     * H() =           [b a]
     *                  ^ ^
     *                  | Extend the signal (x) by computing the values based on the extension mode
     *                  Then compute the filter part overlapping with the signal
     */
    if(length % 2U && blkCnt == 0){
        int32_t sum_lo = 0;
        int32_t sum_hi = 0;

        uint32_t filt_j = 0;

        // Compute Left edge extension
        switch(mode){
            case PLP_DWT_MODE_CONSTANT:
            case PLP_DWT_MODE_SYMMETRIC:
                sum_lo = 2 * HAAR_COEF * pSrc[length - 1];   // dec_lo[0] * src[N-1] + dec_lo[1] * src[N-1]
                sum_hi = 0;                                  // dec_hi[0] * src[N-1] + dec_hi[1] * src[N-1] == -dec_hi[1] * src[N-1] + dec_hi[1] * src[N-1]
                break;
            case PLP_DWT_MODE_REFLECT:
                sum_lo = HAAR_COEF * (pSrc[length - 1] + pSrc[length - 2]);
                sum_hi = HAAR_COEF * (pSrc[length - 1] - pSrc[length - 2]);
                break;
            case PLP_DWT_MODE_ANTISYMMETRIC:
                sum_lo = HAAR_COEF * (pSrc[length - 1] - pSrc[length - 1]);
                sum_hi = HAAR_COEF * (pSrc[length - 1] + pSrc[length - 1]);
                break;
            case PLP_DWT_MODE_ANTIREFLECT:
                sum_lo = HAAR_COEF * (3*pSrc[length - 1] - pSrc[length - 2]);
                sum_hi = HAAR_COEF * ( -pSrc[length - 1] + pSrc[length - 2]);
                break;
            case PLP_DWT_MODE_PERIODIC:
            case PLP_DWT_MODE_ZERO:
            default:
                sum_lo = HAAR_COEF * pSrc[length - 1];
                sum_hi = HAAR_COEF * pSrc[length - 1];
                break;
        }

        *pCurrentA = sum_lo >> MAC_SHIFT;
        *pCurrentD = sum_hi >> MAC_SHIFT;
    }
}

---

Updated on 2023-03-01 at 16:16:33 +0000