IVA编码规范(定稿).doc

编码规范（定稿） IVA(image and video analysis 或者，intelligent video analysis) 项目 说明 结构体定义 格式 Typedef struct iva(智能视频分析标示小写)名称 { /* 注释，务必按照此种格式写注释， * 注释务必详尽简洁， * 名称除去智能视频分析标示外均大写。 */ }名称_(结构体标志S); 如果是结构体内部包含结构体定义需要使用st作为标示，枚举使用en标示 typedef struct ivaVDEC_FRAME_S { VIDEO_FRAME_INFO_S stVideoFrameInfo; HI_BOOL bValid; }VDEC_FRAME_INFO_S; typedef struct hiVDEC_CHN_ATTR_S { PAYLOAD_TYPE_E enType; HI_U32 u32BufSize; HI_VOID *pValue; }VDEC_CHN_ATTR_S 举例 typedef struct ivaMPP_SYS_CONF_S { /* stride of picture buffer must be aligned with this value. * you can choose a value from 1 to 1024, * and it except 1 must be multiple of 16.*/ HI_U32 u32AlignWidth; /** align width */ HI_U32 u32PinMuxCtrl; /** pin mux control */ }MPP_SYS_CONF_S; 宏定义 格式 #define 名称 数值 全部用大写 举例 #define DSU_VFILTER_PARAM_NUM 480 枚举定义 格式 typedef enum iva（智能视频分析标示小写）名称 { VIDEO_ENCODING_MODE_PAL=0, VIDEO_ENCODING_MODE_NTSC, VIDEO_ENCODING_MODE_AUTO, VIDEO_ENCODING_MODE_BUTT, } VIDEO_NORM_E(枚举标示E); 举例 typedef enum ivaVIDEO_NORM_E { VIDEO_ENCODING_MODE_PAL=0, /** 说明 */ VIDEO_ENCODING_MODE_NTSC, /** 说明 */ VIDEO_ENCODING_MODE_AUTO, /** 说明 */ VIDEO_ENCODING_MODE_BUTT, /** 说明 */ } VIDEO_NORM_E; 联合体定义 格式 typedef union iva（智能视频分析标示小写）名称 { VIDEO_ENCODING_MODE_PAL=0, VIDEO_ENCODING_MODE_NTSC, VIDEO_ENCODING_MODE_AUTO, VIDEO_ENCODING_MODE_BUTT, } VIDEO_NORM_U(联合体标示U); 举例 typedef union ivaEVENT_DATA_INTERNAL_U {  IVA_U8 au8Buffer[BUF_SIZE_EVENT];  EVT_SET_S stEventSet; } IVA_EVENT_DATA_INTERNAL_U; 函数定义 定义格式1 智能视频分析(IVA) _函数名，函数名首字母大写 IVA_CalcMotion() 定义格式2 智能视频分析iva函数名，函数名首字母大写，中间不加连接符，opencv定义的方式 ivaCalcMotion() 函数参数定义 枚举参数 不需要数据类型，但是第一个字母大写 VI_DEV ViDevId 结构参数 要st开始,如果是指针则以p+st的方式 IVA_S32 IVA_MPI_VI_SetPubAttr(VI_DEV ViDevId,const VI_PUB_ATTR_S *pstPubAttr); 数值参数要标明数据类型 数据类型+参数名称 IVA_U32 u32ViFramerate 如果是指针,则用p+u32的方式 指针 指针第一个字母需要用p标示 VO_CHN_ATTR_S *psetAttr 全局变量定义 需要用G标示，如： G_u16Count 变量的定义 需要数据类型作为前缀，如：IVA_U32 u32ViFramerate 字符串类型数据前缀为s,其它为u8,u16,u32,s8,