解析xfPackPixels和xfExtractPixels函数

一、xfPackPixels

1、函数功能

    将多个一定位宽的像素数据打包成一个更高位宽的组合数据。

2、函数定义

template  //输入像素的位宽
void xfPackPixels(
    XF_PTNAME(PIXELDEPTH) * tmp_buf, // 输入变量：像素数据

    XF_SNAME(WORDWIDTH) & val,    //输出变量：打包像素后新的变量

    uint16_t pos,//需要打包的像素在tmp_buf中的位置position

    int16_t loopIter, //迭代次数，确定打包的像素的数量

    uint16_t& shift)  //数据移位操作，指示移位计数

3、函数详细分析

template 
void xfPackPixels(
    XF_PTNAME(PIXELDEPTH) * tmp_buf, XF_SNAME(WORDWIDTH) & val, uint16_t pos, int16_t loopIter, uint16_t& shift) {
// clang-format off
    #pragma HLS INLINE   //函数内连，移除函数层次，节省调用时间和资源利用率
    // clang-format on
    ap_uint<8> STEP = XF_PIXELDEPTH(PIXELDEPTH); //移位步长，设置为像素的宽度

    for (ap_int<9> i = 0; i < loopIter; i++) {  //迭代次数，即loopIter个像素拼接成一个数据
// clang-format off
        #pragma HLS unroll  //循环完全展开，减少耗时
        // clang-format on
        XF_PTUNAME(PIXELDEPTH) tmp = tmp_buf[pos]; //将tmp_buf对应位置的数据赋值给tmp
        val = val | (((XF_SNAME(WORDWIDTH))tmp) << (shift * STEP)); //将tmp赋值给val指定位置
        pos++;//pos累加，拼接下一个像素
        shift++; //shift累加，改变像素插入到val的位置
    }
}

    xfPackPixels函数，将输入的像素按照先输入像素在低字节，后输入像素在高字节的小端模式进行保存。读取tmp_buf中的像素数据，按照小端模式拼接，拼成成需要的WORDWIDTH宽度的val，拼接完成后，输出val。拼接的次数为loopIter次。

    需要注意的是，该函数可设置的参数很多，若参数不匹配，可能会导致输出数据异常。当然也可以根据此函数逻辑有规律的舍弃掉某些像素。需要根据实际项目决定。

    还需要注意，val和shift为引用变量，每次调用此函数的时候，最好在父函数中，将val和shift变量赋值为0。（不是绝对的，根据逻辑决定）

二、xfExtractPixels

1、函数功能

    将一定高位宽的组合数据拆包成多个低位宽的像素数据。

2、函数定义

template  //输入像素的位宽
void xfExtractPixels(XF_PTNAME(PIXELDEPTH) * tmp_buf,  //拆包后的像素数据指针
                     XF_SNAME(WORDWIDTH) & val1,   //组合数据
                     int pos) //偏移tmp_buf的位置 比如pos=0,表示val1拆分后的数据直接赋值给tmp_buf

3、函数详细分析

template 
void xfExtractPixels(XF_PTNAME(PIXELDEPTH) * tmp_buf, XF_SNAME(WORDWIDTH) & val1, int pos) {
// clang-format off 
    #pragma HLS inline off  //函数内连，移除函数层次，节省调用时间和资源利用率
    // clang-format on
    XF_SNAME(WORDWIDTH) v = val1; //组合数据赋值

    int shift = 0;  //偏移计数，初始值为0
    int STEP = XF_PIXELDEPTH(PIXELDEPTH); //移位数，为像素的位宽
Extract_pixels_loop:
    for (int i = 0; i < (1 << (XF_BITSHIFT(NPC))); i++) {  //循环此处为NPC，即拆分成每个时钟并行处理的像素数
// clang-format off
        #pragma HLS UNROLL //循环展开
        // clang-format on
        tmp_buf[pos + i] = v.range(shift + STEP - 1, shift); //将组合数据指定的bit写入到tmp_buf对应的顺序指针上
        shift = shift + STEP; //shift累加，用于切换读取v指定bit位置的数据
    }
}

    xfExtractPixels函数，将输入的组合数据从低bit开始读取，并写入到tmp_buf指针对应的低地址位置，组合数据的高bit数据写入到顺序增加的高地址位置。完成数据的拆分。拆分的次数为NPC次。