SetAippFunctions
产品支持情况
- Ascend 950PR/Ascend 950DT:支持
- Atlas A3 训练系列产品/Atlas A3 推理系列产品:支持
- Atlas A2 训练系列产品/Atlas A2 推理系列产品:支持
- Atlas 200I/500 A2 推理产品:支持
- Atlas 推理系列产品AI Core:支持
- Atlas 推理系列产品Vector Core:不支持
- Atlas 训练系列产品:不支持
功能说明
设置图片预处理(AIPP,AI Core pre-process)相关参数。和LoadImageToLocal接口配合使用。设置后,调用LoadImageToLocal接口可在搬运过程中完成图像预处理操作:包括数据填充、通道交换、单行读取、数据类型转换、通道填充、色域转换。调用SetAippFunctions接口时需传入源图片在Global Memory上的矩阵、源图片的图片格式。
数据填充: 在图片HW方向上padding。分为如下几种模式:
模式0:常量填充模式,padding区域各位置填充为常数,支持设置每个通道填充的常数。该模式下仅支持左右padding,不支持上下padding。
图1 常量填充模式(图片中间的绿色区域表示原始数据,其他为padding数据)

模式1:行列填充模式,padding区域各位置填充行/列上最邻近源图片位置的数据。
图2 行列填充模式(图片中间的绿色区域表示原始数据,其他为padding数据)

模式2:块填充模式,按照padding的宽高,从源图片拷贝数据块进行padding区域填充。
图3 块填充模式(图片中间的绿色区域表示原始数据,其他为padding数据)

模式3:镜像块填充模式,按照padding的宽高,从源图片拷贝数据块的镜像进行padding区域填充。
图4 镜像块填充模式(图片中间的绿色区域表示原始数据,其他为padding数据)

通道交换: 将图片通道进行交换。
- 对于RGB888格式,支持交换R和B通道。
- 对于YUV420SP格式,支持交换U和V通道。
- 对于XRGB8888格式,支持X通道后移(XRGB→RGBX)和交换R和B通道。
单行读取: 源图片中仅读取一行。
说明
调用数据搬运接口时,若开启了单行读取,设置的目的图片高度参数将无效,如LoadImageToLocal接口的loadImageToLocalParams.vertSize。
数据类型转换: 转换像素的数据类型,支持uint8_t转换为int8_t或half。当uint8_t转换成int8_t的时候,输出数据范围限制在[-128,127]。
C++// 例1:实现uint8_t ->int8_t的类型转换,同时实现零均值化:设置每个通道mean值为该通道所有数据的平均值(min和var值无效,不用设置)。 output[i][j][k] = input[i][j][k] - mean[k] // 例2:实现uint8_t -> fp16的类型转换,同时实现归一化:设置每个通道mean值为该通道所有数据的平均值,min值为该通道所有数据零均值化后的最小值,var值为该通道所有数据的最大值减最小值的倒数。 uint8_t -> fp16: output[i][j][k] = (input[i][j][k] - mean[k] - min[k]) * var[k]说明
转换后的数据类型由模板参数U决定,U为uint8_t时数据类型转换功能不生效。 调用数据搬运接口时,目的Tensor的数据类型需要与本接口输出数据类型保持一致,如LoadImageToLocal的dstLocal参数的数据类型。
通道填充: 在图片通道方向上padding。默认为模式0。
模式0:将通道padding至32Bytes。即输出数据类型为uint8_t/int8_t时,padding至32通道;输出数据类型为fp16时,padding至16通道。
模式1:将通道padding至4通道。
色域转换: RGB格式转换为YUV格式,或YUV格式转换为RGB格式。


函数原型
输入图片格式为YUV400、RGB888、XRGB8888
C++template<typename T, typename U> __aicore__ inline void SetAippFunctions(const GlobalTensor<T>& src0, AippInputFormat format, AippParams<U> config)输入图片格式为YUV420 Semi-Planar
C++template<typename T, typename U> __aicore__ inline void SetAippFunctions(const GlobalTensor<T>& src0, const GlobalTensor<T>& src1, AippInputFormat format, AippParams<U> config)
参数说明
表1 模板参数说明
| 参数名称 | 含义 |
|---|---|
| T | 输入的数据类型,需要与format中设置的数据类型保持一致。 |
| U | 输出的数据类型,需要在搬运接口配置同样的数据类型,如LoadImageToLocal的dstLocal参数数据类型。 •如果不使能数据类型转换功能,需要与输入类型保持一致; •如果使能数据类型转换功能,需要与期望转换后的类型保持一致。 |
表2 参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| src0 | 输入 | 源图片在Global Memory上的矩阵。 源图片格式为YUV420SP时,表示Y维度在Global Memory上的矩阵。 |
| src1 | 输入 | 源图片格式为YUV420SP时,表示UV维度在Global Memory上的矩阵。 源图片格式为其他格式时,该参数无效。 |
| format | 输入 | 源图片的图片格式。AippInputFormat为枚举类型,取值为: AippInputFormat::YUV420SP_U8:图片格式为YUV420 Semi-Planar,数据类型为uint8_t AippInputFormat::XRGB8888_U8:图片格式为XRGB8888,数据类型为uint8_t AippInputFormat::RGB888_U8:图片格式为RGB888,数据类型为uint8_t AippInputFormat::YUV400_U8:图片格式为YUV400,数据类型为uint8_t enum class AippInputFormat : uint8_t { |
| config | 输入 | 图片预处理的相关参数,类型为AippParams,结构体具体定义为:template <typename T> AippParams结构体内各子结构体定义如下: •数据填充功能相关参数,说明见表3。 template <typename T> •通道交换功能相关参数,说明见表4。 struct AippSwapParams {•单行读取功能相关参数,说明见表5。 struct AippSingleLineParams {•数据类型转换功能相关参数,说明见表6。 struct AippDataTypeConvParams {•通道填充功能相关参数,说明见表7。 template <typename T> •色域转换功能相关参数,说明见表8。 struct AippColorSpaceConvParams { |
表3 AippPaddingParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| paddingMode | 输入 | padding的模式,取值范围[0, 3],默认值为0。 0:常数填充模式,此模式仅支持左右填充。 1:行列拷贝模式。 2:块拷贝模式。 3:镜像块拷贝模式。 |
| paddingValueCh0 | 输入 | padding区域中channel0填充的数据,仅常数填充模式有效,数据类型为T,默认值为0。 |
| paddingValueCh1 | 输入 | padding区域中channel1填充的数据,仅常数填充模式有效,数据类型为T,默认值为0。 |
| paddingValueCh2 | 输入 | padding区域中channel2填充的数据,仅常数填充模式有效,数据类型为T,默认值为0。 |
| paddingValueCh3 | 输入 | padding区域中channel3填充的数据,仅常数填充模式有效,数据类型为T,默认值为0。 |
表4 AippSwapParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| isSwapRB | 输入 | 对于RGB888、XRGB8888格式,是否交换R和B通道。默认值为false。 |
| isSwapUV | 输入 | 对于YUV420SP格式,是否交换U和V通道。默认值为false。 |
| isSwapAX | 输入 | 对于XRGB8888格式,是否将X通道后移,即XRGB→RGBX。默认值为false。 |
表5 AippSingleLineParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| isSingleLineCopy | 输入 | 是否开启单行读取模式。开启后,仅从源图片读取一行。默认值为false。 |
表6 AippDataTypeConvParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| dtcMeanCh0 | 输入 | 计算公式内的mean值,channel0,数据类型为uint8_t,默认值为0。 |
| dtcMeanCh1 | 输入 | 计算公式内的mean值,channel1,数据类型为uint8_t,默认值为0。 |
| dtcMeanCh2 | 输入 | 计算公式内的mean值,channel2,数据类型为uint8_t,默认值为0。 |
| dtcMinCh0 | 输入 | 计算公式内的min值,channel0,数据类型为half,默认值为0。 Atlas 200I/500 A2 推理产品不支持配置该参数。 |
| dtcMinCh1 | 输入 | 计算公式内的min值,channel1,数据类型为half,默认值为0。 Atlas 200I/500 A2 推理产品不支持配置该参数。 |
| dtcMinCh2 | 输入 | 计算公式内的min值,channel2,数据类型为half,默认值为0。 Atlas 200I/500 A2 推理产品不支持配置该参数。 |
| dtcVarCh0 | 输入 | 计算公式内的var值,channel0,数据类型为half,默认值为1.0。 |
| dtcVarCh1 | 输入 | 计算公式内的var值,channel1,数据类型为half,默认值为1.0。 |
| dtcVarCh2 | 输入 | 计算公式内的var值,channel2,数据类型为half,默认值为1.0。 |
| dtcRoundMode | 输入 | 控制dtc做数据类型转换的模式,数据类型为uint32_t,默认值为0。 0:四舍五入到最接近的整数值(C语言round)。 1:四舍五入到最接近的偶数(C语言rint)。 |
说明
参数dtcRoundMode,仅在Atlas 200I/500 A2 推理产品支持配置。
表7 AippChannelPaddingParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| cPaddingMode | 输入 | channel padding的类型,取值范围为[0, 1],默认值为0。 0:填充到32B。即输出数据类型U为int8_t、uint8_t时填充到32通道,为half时填充到16通道。 1:填充到4通道。 |
| cPaddingValue | 输入 | channel padding填充的值,数据类型为T,默认值为0。 |
表8 AippColorSpaceConvParams结构体内参数说明
| 参数名称 | 输入/输出 | 含义 |
|---|---|---|
| isEnableCsc | 输入 | 是否开启色域转换功能,默认值为false。 |
| cscMatrixR0C0 | 输入 | 色域转换矩阵cscMatrix[0][0]。 |
| cscMatrixR0C1 | 输入 | 色域转换矩阵cscMatrix[0][1]。 |
| cscMatrixR0C2 | 输入 | 色域转换矩阵cscMatrix[0][2]。 |
| cscMatrixR1C0 | 输入 | 色域转换矩阵cscMatrix[1][0]。 |
| cscMatrixR1C1 | 输入 | 色域转换矩阵cscMatrix[1][1]。 |
| cscMatrixR1C2 | 输入 | 色域转换矩阵cscMatrix[1][2]。 |
| cscMatrixR2C0 | 输入 | 色域转换矩阵cscMatrix[2][0]。 |
| cscMatrixR2C1 | 输入 | 色域转换矩阵cscMatrix[2][1]。 |
| cscMatrixR2C2 | 输入 | 色域转换矩阵cscMatrix[2][2]。 |
| cscBiasIn0 | 输入 | RGB转YUV偏置cscBiasIn[0]。YUV转RGB时无效。 |
| cscBiasIn1 | 输入 | RGB转YUV偏置cscBiasIn[1]。YUV转RGB时无效。 |
| cscBiasIn2 | 输入 | RGB转YUV偏置cscBiasIn[2]。YUV转RGB时无效。 |
| cscBiasOut0 | 输入 | YUV转RGB偏置cscBiasOut0[0]。RGB转YUV时无效。 |
| cscBiasOut1 | 输入 | YUV转RGB偏置cscBiasOut1[1]。RGB转YUV时无效。 |
| cscBiasOut2 | 输入 | YUV转RGB偏置cscBiasOut2[2]。RGB转YUV时无效。 |
返回值说明
无
约束说明
src0、src1在Global Memory上的地址对齐要求如下:
| 图片格式 | src0 | src1 |
|---|---|---|
| YUV420SP | 必须2Bytes对齐 | 必须2Bytes对齐 |
| XRGB8888 | 必须4Bytes对齐 | - |
| RGB888 | 无对齐要求 | - |
| YUV400 | 无对齐要求 | - |
- 对于XRGB输入格式的数据,芯片会默认丢弃第四个通道的数据输出RGB格式的数据。如果X在channel0的场景下,X通道后移功能必须使能,将输入通道转换为RGBX;反之如果X在channel3的场景下,X通道后移功能必须不使能,以输出RGB格式的数据。
调用示例
SetAippFunctions需与LoadImageToLocal接口配合使用,完整调用示例(含搬运过程)请参考LoadImageToLocal的调用示例。