9.4. 数据类型¶
RGN 模块相关数据类型定义如下:
RGN_MIN_WIDTH :定义区域的最小宽度。
RGN_MIN_HEIGHT :定义区域的最小高度。
RGN_COVER_MAX_WIDTH :定义 COVER 区域的最大宽度。
RGN_COVER_MAX_HEIGHT :定义 COVER 区域的最大高度。
RGN_COVER_MIN_X :定义 COVER 区域起始位置的 X 坐标最小值。
RGN_COVER_MIN_Y :定义 COVER 区域起始位置的 Y 坐标最小值。
RGN_COVER_MAX_X :定义 COVER 区域起始位置的 X 坐标最大值。
RGN_COVER_MAX_Y :定义 COVER 区域起始位置的 Y 坐标最大值。
RGN_COVEREX_MAX_NUM :定义 COVEREX 区域的最大个数。
RGN_COVEREX_MAX_WIDTH :定义 COVEREX 区域的最大宽度。
RGN_COVEREX_MAX_HEIGHT :定义 COVEREX 区域的最大高度。
RGN_COVEREX_MIN_X :定义 COVEREX 区域起始位置的 X 坐标最小值。
RGN_COVEREX_MIN_Y :定义 COVEREX 区域起始位置的 Y 坐标最小值。
RGN_COVEREX_MAX_X :定义 COVEREX 区域起始位置的 X 坐标最大值。
RGN_COVEREX_MAX_Y :定义 COVEREX 区域起始位置的 Y 坐标最大值。
RGN_OVERLAY_MAX_WIDTH :定义 OVERLAY 区域的最大宽度。
RGN_OVERLAY_MAX_HEIGHT :定义 OVERLAY 区域的最大高度。
RGN_OVERLAY_MIN_X :定义 OVERLAY 区域起始位置的 X 坐标最小值。
RGN_OVERLAY_MIN_Y :定义 OVERLAY 区域起始位置的 Y 坐标最小值。
RGN_OVERLAY_MAX_X :定义 OVERLAY 区域起始位置的 X 坐标最大值。
RGN_OVERLAY_MAX_Y :定义 OVERLAY 区域起始位置的 Y 坐标最大值。
RGN_MOSAIC_MAX_NUM :定义 MOSAIC 区域的最大个数。
RGN_MOSAIC_X_ALIGN :定义 MOSAIC 区域的 X 坐标对齐。
RGN_MOSAIC_Y_ALIGN :定义 MOSAIC 区域的 Y 坐标对齐。
RGN_MOSAIC_WIDTH_ALIGN :定义 MOSAIC 区域的宽度对齐。
RGN_MOSAIC_HEIGHT_ALIGN :定义 MOSAIC 区域的高度对齐。
RGN_MOSAIC_MIN_WIDTH :定义 MOSAIC 区域的最小宽度。
RGN_MOSAIC_MIN_HEIGHT :定义 MOSAIC 区域的最小高度。
RGN_MOSAIC_MAX_WIDTH :定义 MOSAIC 区域的最大宽度。
RGN_MOSAIC_MAX_HEIGHT :定义 MOSAIC 区域的最大高度。
RGN_MOSAIC_MIN_X :定义 MOSAIC 区域起始位置的 X 坐标最小值。
RGN_MOSAIC_MIN_Y :定义 MOSAIC 区域起始位置的 Y 坐标最小值。
RGN_MOSAIC_MAX_X :定义 MOSAIC 区域起始位置的 X 坐标最大值。
RGN_MOSAIC_MAX_Y :定义 MOSAIC 区域起始位置的 Y 坐标最大值。
RGN_MAX_LAYER_VPSS :定义一个 VPSS 通道最多可显示的区域层数。
RGN_ODEC_LAYER_VPSS :定义一个 VPSS 通道的 ODEC 区域层。
RGN_NORMAL_LAYER_VPSS :定义一个 VPSS 通道的 NORMAL 区域层。
RGN_MAX_NUM_VPSS :定义一个 VPSS 通道最多可显示的区域的个数。
RGN_EX_MAX_NUM_VPSS :定义扩展区域的最大个数。
RGN_EX_MAX_WIDTH :定义扩展区域的最大宽度。
RGN_MAX_BUF_NUM :定义区域使用的最大内存数量。
RGN_MAX_NUM :定义区域的最大个数。
RGN_INVALID_HANDLE :定义区域无效句柄。
RGN_CMPR_MIN_SIZE :定义区域压缩的最小尺寸。
RGN_HANDLE :定义区域句柄。
RGN_TYPE_E :定义区域类型。
RGN_AREA_TYPE_E :定义 COVER、COVEREX 区域类型。
OSD_COMPRESS_MODE_E :定义 OSD 压缩模式类型。
OSD_COMPRESS_INFO_S :定义 OSD 压缩模式属性。
COVER_CHN_ATTR_S :定义 COVER 区域的通道属性。
COVEREX_CHN_ATTR_S :定义 COVEREX 区域的通道属性。
OVERLAY_ATTR_S :定义视频迭加区域的属性。
OVERLAY_CHN_ATTR_S :定义视频迭加区域的通道属性。
OVERLAYEX_ATTR_S :定义扩展视频迭加区域的属性。
OVERLAYEX_CHN_ATTR_S :定义扩展视频迭加区域的通道属性。
RGN_ATTR_U :定义区域属性联合体。
RGN_CHN_ATTR_U :定义区域通道属性联合体。
RGN_ATTR_S :定义区域属性结构体。
RGN_CHN_ATTR_S :定义区域通道属性结构体。
RGN_COORDINATE_E :定义坐标类型。
RGN_QUADRANGLE_S :定义任意四边形结构体。
MOSAIC_BLK_SIZE_E :定义 MOSAIC 区域的块大小类型。
MOSAIC_CHN_ATTR_S :定义 MOSAIC 区域通道属性。
INVERT_COLOR_MODE_E :定义 OSD 反色模式。
OVERLAY_INVERT_COLOR_S :定义 OSD 反色属性。
RGN_CMPR_TYPE_E :定义区域压缩类型。
RGN_LINE_ATTR_S :定义线条属性。
RGN_RECT_ATTR_S :定义矩形属性。
RGN_BITMAP_ATTR_S :定义位图属性。
RGN_CMPR_OBJ_ATTR_S :定义压缩对象属性。
RGN_CANVAS_CMPR_ATTR_S :定义画布压缩属性。
RGN_CANVAS_INFO_S :定义画布信息。
RGN_RGBQUARD_S :定义调色盘颜色。
RGN_COLOR_FMT_E :定义 OSD 支持的颜色格式。
RGN_PALETTE_S :定义调色盘属性。
9.4.1. RGN_MIN_WIDTH¶
【说明】
定义区域的最小宽度。
【定义】
#define RGN_MIN_WIDTH 2
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.2. RGN_MIN_HEIGHT¶
【说明】
定义区域的最小高度。
【定义】
#define RGN_MIN_HEIGHT 2
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.3. RGN_COVER_MAX_WIDTH¶
【说明】
定义 COVER 区域的最大宽度。
【定义】
#define RGN_COVER_MAX_WIDTH 3840
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.4. RGN_COVER_MAX_HEIGHT¶
【说明】
定义 COVER 区域的最大高度。
【定义】
#define RGN_COVER_MAX_HEIGHT 2160
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.5. RGN_COVER_MIN_X¶
【说明】
定义 COVER 区域起始位置的 X 坐标最小值。
【定义】
#define RGN_COVER_MIN_X 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.6. RGN_COVER_MIN_Y¶
【说明】
定义 COVER 区域起始位置的 Y 坐标最小值。
【定义】
#define RGN_COVER_MIN_Y 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.7. RGN_COVER_MAX_X¶
【说明】
定义 COVER 区域起始位置的 X 坐标最大值。
【定义】
#define RGN_COVER_MAX_X (RGN_COVER_MAX_WIDTH - RGN_MIN_WIDTH)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.8. RGN_COVER_MAX_Y¶
【说明】
定义 COVER 区域起始位置的 Y 坐标最大值。
【定义】
#define RGN_COVER_MAX_Y (RGN_COVER_MAX_HEIGHT - RGN_MIN_HEIGHT)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.9. RGN_COVEREX_MAX_NUM¶
【说明】
定义 COVEREX 区域的最大个数。
【定义】
#define RGN_COVEREX_MAX_NUM 4
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.10. RGN_COVEREX_MAX_WIDTH¶
【说明】
定义 COVEREX 区域的最大宽度。
【定义】
#define RGN_COVEREX_MAX_WIDTH 3840
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.11. RGN_COVEREX_MAX_HEIGHT¶
【说明】
定义 COVEREX 区域的最大高度。
【定义】
#define RGN_COVEREX_MAX_HEIGHT 2160
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.12. RGN_COVEREX_MIN_X¶
【说明】
定义 COVEREX 区域起始位置的 X 坐标最小值。
【定义】
#define RGN_COVEREX_MIN_X 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.13. RGN_COVEREX_MIN_Y¶
【说明】
定义 COVEREX 区域起始位置的 Y 坐标最小值。
【定义】
#define RGN_COVEREX_MIN_Y 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.14. RGN_COVEREX_MAX_X¶
【说明】
定义 COVEREX 区域起始位置的 X 坐标最大值。
【定义】
#define RGN_COVEREX_MAX_X (RGN_COVEREX_MAX_WIDTH - RGN_MIN_WIDTH)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.15. RGN_COVEREX_MAX_Y¶
【说明】
定义 COVEREX 区域起始位置的 Y 坐标最大值。
【定义】
#define RGN_COVEREX_MAX_Y (RGN_COVEREX_MAX_HEIGHT - RGN_MIN_HEIGHT)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.16. RGN_OVERLAY_MAX_WIDTH¶
【说明】
定义 OVERLAY 区域的最大宽度。
【定义】
#define RGN_OVERLAY_MAX_WIDTH 3840
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.17. RGN_OVERLAY_MAX_HEIGHT¶
【说明】
定义 OVERLAY 区域的最大高度。
【定义】
#define RGN_OVERLAY_MAX_HEIGHT 2160
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.18. RGN_OVERLAY_MIN_X¶
【说明】
定义 OVERLAY 区域起始位置的 X 坐标最小值。
【定义】
#define RGN_OVERLAY_MIN_X 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.19. RGN_OVERLAY_MIN_Y¶
【说明】
定义 OVERLAY 区域起始位置的 Y 坐标最小值。
【定义】
#define RGN_OVERLAY_MIN_Y 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.20. RGN_OVERLAY_MAX_X¶
【说明】
定义 OVERLAY 区域起始位置的 X 坐标最大值。
【定义】
#define RGN_OVERLAY_MAX_X (RGN_OVERLAY_MAX_WIDTH - RGN_MIN_WIDTH)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.21. RGN_OVERLAY_MAX_Y¶
【说明】
定义 OVERLAY 区域起始位置的 Y 坐标最大值。
【定义】
#define RGN_OVERLAY_MAX_Y (RGN_OVERLAY_MAX_HEIGHT - RGN_MIN_HEIGHT)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.22. RGN_MOSAIC_MAX_NUM¶
【说明】
定义 MOSAIC 区域的最大个数。
【定义】
#define RGN_MOSAIC_MAX_NUM 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.23. RGN_MOSAIC_X_ALIGN¶
【说明】
定义 MOSAIC 区域的 X 坐标对齐。
【定义】
#define RGN_MOSAIC_X_ALIGN 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.24. RGN_MOSAIC_Y_ALIGN¶
【说明】
定义 MOSAIC 区域的 Y 坐标对齐。
【定义】
#define RGN_MOSAIC_Y_ALIGN 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.25. RGN_MOSAIC_WIDTH_ALIGN¶
【说明】
定义 MOSAIC 区域的宽度对齐。
【定义】
#define RGN_MOSAIC_WIDTH_ALIGN 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.26. RGN_MOSAIC_HEIGHT_ALIGN¶
【说明】
定义 MOSAIC 区域的高度对齐。
【定义】
#define RGN_MOSAIC_HEIGHT_ALIGN 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.27. RGN_MOSAIC_MIN_WIDTH¶
【说明】
定义 MOSAIC 区域的最小宽度。
【定义】
#define RGN_MOSAIC_MIN_WIDTH 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.28. RGN_MOSAIC_MIN_HEIGHT¶
【说明】
定义 MOSAIC 区域的最小高度。
【定义】
#define RGN_MOSAIC_MIN_HEIGHT 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.29. RGN_MOSAIC_MAX_WIDTH¶
【说明】
定义 MOSAIC 区域的最大宽度。
【定义】
#define RGN_MOSAIC_MAX_WIDTH 3840
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.30. RGN_MOSAIC_MAX_HEIGHT¶
【说明】
定义 MOSAIC 区域的最大高度。
【定义】
#define RGN_MOSAIC_MAX_HEIGHT 2160
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.31. RGN_MOSAIC_MIN_X¶
【说明】
定义 MOSAIC 区域起始位置的 X 坐标最小值。
【定义】
#define RGN_MOSAIC_MIN_X 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.32. RGN_MOSAIC_MIN_Y¶
【说明】
定义 MOSAIC 区域起始位置的 Y 坐标最小值。
【定义】
#define RGN_MOSAIC_MIN_Y 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.33. RGN_MOSAIC_MAX_X¶
【说明】
定义 MOSAIC 区域起始位置的 X 坐标最大值。
【定义】
#define RGN_MOSAIC_MAX_X (RGN_MOSAIC_MAX_WIDTH - RGN_MOSAIC_MIN_WIDTH)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.34. RGN_MOSAIC_MAX_Y¶
【说明】
定义 MOSAIC 区域起始位置的 Y 坐标最大值。
【定义】
#define RGN_MOSAIC_MAX_Y (RGN_MOSAIC_MAX_HEIGHT - RGN_MOSAIC_MIN_HEIGHT)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.35. RGN_MAX_LAYER_VPSS¶
【说明】
定义一个 VPSS 通道最多可显示的区域层数。
【定义】
#define RGN_MAX_LAYER_VPSS 2
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.36. RGN_ODEC_LAYER_VPSS¶
【说明】
定义一个 VPSS 通道的 ODEC 区域层。
【定义】
#define RGN_ODEC_LAYER_VPSS 0
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.37. RGN_NORMAL_LAYER_VPSS¶
【说明】
定义一个 VPSS 通道的 NORMAL 区域层。
【定义】
#define RGN_NORMAL_LAYER_VPSS 1
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.38. RGN_MAX_NUM_VPSS¶
【说明】
定义一个 VPSS 通道最多可显示的区域的个数。
【定义】
#define RGN_MAX_NUM_VPSS 8
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.39. RGN_EX_MAX_NUM_VPSS¶
【说明】
定义扩展区域的最大个数。
【定义】
#define RGN_EX_MAX_NUM_VPSS 16
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.40. RGN_EX_MAX_WIDTH¶
【说明】
定义扩展区域的最大宽度。
【定义】
#define RGN_EX_MAX_WIDTH 3840
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.41. RGN_MAX_BUF_NUM¶
【说明】
定义区域使用的最大内存数量。
【定义】
#define RGN_MAX_BUF_NUM 2
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.42. RGN_MAX_NUM¶
【说明】
定义区域的最大个数。
【定义】
#define RGN_MAX_NUM 108
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.43. RGN_INVALID_HANDLE¶
【说明】
定义区域无效句柄。
【定义】
#define RGN_INVALID_HANDLE (-1U)
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.44. RGN_CMPR_MIN_SIZE¶
【说明】
定义区域压缩的最小尺寸。
【定义】
#define RGN_CMPR_MIN_SIZE 128000
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.45. RGN_HANDLE¶
【说明】
定义区域句柄。
【定义】
typedef CVI_U32 RGN_HANDLE;
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.46. RGN_TYPE_E¶
【说明】
定义区域类型。
【定义】
typedef enum _RGN_TYPE_E {
OVERLAY_RGN = 0,
COVER_RGN,
COVEREX_RGN,
OVERLAYEX_RGN,
MOSAIC_RGN,
RGN_BUTT
} RGN_TYPE_E;
【成员】
成员名称 |
描述 |
|---|---|
OVERLAY_RGN |
视频迭加区域。 |
COVER_RGN |
视频遮挡区域。 |
COVEREX_RGN |
扩展视频遮挡区域。 |
OVERLAYEX_RGN |
扩展视频迭加区域,尚未支持。 |
MOSAIC_RGN |
Mosaic视频区域。 |
【注意事项】
COVEREX_RGN和MOSAIC_RGN当前不支持DUAL OS。
【相关数据类型及接口】
无。
9.4.47. RGN_AREA_TYPE_E¶
【说明】
定义COVER、COVEREX区域类型。
【定义】
typedef enum _RGN_AREA_TYPE_E {
AREA_RECT = 0,
AREA_QUAD_RANGLE,
AREA_BUTT
} RGN_AREA_TYPE_E;
【成员】
成员名称 |
描述 |
|---|---|
AREA_RECT |
矩形区域。 |
AREA_QUAD_RANGLE |
任意四边形区域,尚未支持。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.48. OSD_COMPRESS_MODE_E¶
【说明】
定义OSD压缩模式类型。
【定义】
typedef enum _OSD_COMPRESS_MODE_E {
OSD_COMPRESS_MODE_NONE = 0,
OSD_COMPRESS_MODE_SW,
OSD_COMPRESS_MODE_HW,
OSD_COMPRESS_MODE_BUTT
} OSD_COMPRESS_MODE_E;
【成员】
成员名称 |
描述 |
|---|---|
OSD_COMPRESS_MODE_NONE |
不使用压缩模式。 |
OSD_COMPRESS_MODE_SW |
使用软件压缩模式。 |
OSD_COMPRESS_MODE_HW |
使用硬件压缩模式。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.49. OSD_COMPRESS_INFO_S¶
【说明】
定义OSD压缩模式属性。
【定义】
typedef struct _OSD_COMPRESS_INFO_S {
OSD_COMPRESS_MODE_E enOSDCompressMode;
CVI_U32 u32EstCompressedSize;
CVI_U32 u32CompressedSize;
} OSD_COMPRESS_INFO_S;
【成员】
成员名称 |
描述 |
|---|---|
enOSDCompressMode |
定义OSD压缩模式类型。 |
u32EstCompressedSize |
预估软件压缩模式下需要分配在内存大小。 |
u32CompressedSize |
硬件压缩模式下需要分配在内存大小。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.50. COVER_CHN_ATTR_S¶
【说明】
定义COVER区域的通道属性。
【定义】
typedef struct _COVER_CHN_ATTR_S {
RGN_AREA_TYPE_E enCoverType;
union {
RECT_S stRect;
RGN_QUADRANGLE_S stQuadRangle;
};
CVI_U32 u32Color;
CVI_U32 u32Layer;
RGN_COORDINATE_E enCoordinate;
} COVER_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enCoverType |
COVER区域类型。 |
stRect |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
stQuadRangle |
任意四边形区域,尚未支持。 |
u32Color |
COVER区域颜色。
格式为24bit RGB888。
|
u32Layer |
区域层次。
目前不支持。
|
enCoordinate |
区域坐标类型。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.51. COVEREX_CHN_ATTR_S¶
【说明】
定义COVEREX区域的通道属性。
【定义】
typedef struct _COVEREX_CHN_ATTR_S {
RGN_AREA_TYPE_E enCoverType;
union {
RECT_S stRect;
RGN_QUADRANGLE_S stQuadRangle;
};
CVI_U32 u32Color;
CVI_U32 u32Layer;
} COVEREX_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enCoverType |
COVEREX区域类型。 |
stRect |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
stQuadRangle |
任意四边形区域,尚未支持。 |
u32Color |
COVEREX区域颜色。
格式为24bit RGB888。
|
u32Layer |
区域层次。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.52. OVERLAY_ATTR_S¶
【说明】
定义视频迭加区域的属性。
【定义】
typedef struct _OVERLAY_ATTR_S {
PIXEL_FORMAT_E enPixelFormat;
CVI_U32 u32BgColor;
SIZE_S stSize;
CVI_U32 u32CanvasNum;
CVI_BOOL bFlip;
CVI_BOOL bMirror;
OSD_COMPRESS_INFO_S stCompressInfo;
} OVERLAY_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enPixelFormat |
像素格式。
PIXEL_FORMAT_ARGB_1555,
PIXEL_FORMAT_ARGB_4444,
PIXEL_FORMAT_ARGB_8888。
|
u32BgColor |
区域背景色。
根据enPixelFormat定义。
|
stSize |
区域宽高。 |
u32CanvasNum |
区域内存数量。 |
bFlip |
OSD内容是否翻转。
仅支持DUAL OS。
|
bMirror |
OSD内容是否镜像。
仅支持DUAL OS。
|
stCompressInfo |
OSD压缩模式属性。 |
【注意事项】
stSize会影响区域分配的内存大小,建议不要大于最终链接通道的宽高,以免浪费内存。
- u32CanvasNum根据使用情况决定。若使用 CVI_RGN_SetBitMap,为1即可。若使用 CVI_RGN_GetCanvasInfo,希望double buffer避免更新过程中的瞬时,则建议为2。
【相关数据类型及接口】
无。
9.4.53. OVERLAY_CHN_ATTR_S¶
【说明】
定义视频迭加区域的通道属性。
【定义】
typedef struct _OVERLAY_CHN_ATTR_S {
POINT_S stPoint;
CVI_U32 u32Layer;
OVERLAY_INVERT_COLOR_S stInvertColor;
} OVERLAY_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stPoint |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
u32Layer |
区域层次。
目前不支持。
|
stInvertColor |
颜色反转结构体。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.54. OVERLAYEX_ATTR_S¶
【说明】
定义扩展视频迭加区域的属性。
【定义】
typedef struct _OVERLAYEX_ATTR_S {
PIXEL_FORMAT_E enPixelFormat;
CVI_U32 u32BgColor;
SIZE_S stSize;
CVI_U32 u32CanvasNum;
CVI_BOOL bFlip;
CVI_BOOL bMirror;
OSD_COMPRESS_INFO_S stCompressInfo;
} OVERLAYEX_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enPixelFormat |
像素格式。
PIXEL_FORMAT_ARGB_1555,
PIXEL_FORMAT_ARGB_4444,
PIXEL_FORMAT_ARGB_8888。
|
u32BgColor |
区域背景色。
根据enPixelFormat定义。
|
stSize |
区域宽高。 |
u32CanvasNum |
区域内存数量。 |
bFlip |
OSD内容是否翻转。
仅支持DUAL OS。
|
bMirror |
OSD内容是否镜像。
仅支持DUAL OS。
|
stCompressInfo |
OSD压缩模式属性。 |
【注意事项】
stSize会影响区域分配的内存大小,建议不要大于最终链接通道的宽高,以免浪费内存。
- u32CanvasNum根据使用情况决定。若使用 CVI_RGN_SetBitMap,为1即可。若使用 CVI_RGN_GetCanvasInfo,希望double buffer避免更新过程中的瞬时,则建议为2。
【相关数据类型及接口】
无。
9.4.55. OVERLAYEX_CHN_ATTR_S¶
【说明】
定义扩展视频迭加区域的通道属性。
【定义】
typedef struct _OVERLAYEX_CHN_ATTR_S {
POINT_S stPoint;
CVI_U32 u32Layer;
OVERLAY_INVERT_COLOR_S stInvertColor;
} OVERLAYEX_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stPoint |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
u32Layer |
区域层次。 |
stInvertColor |
颜色反转结构体。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.56. RGN_ATTR_U¶
【说明】
定义区域属性联合体。
【定义】
typedef union _RGN_ATTR_U {
OVERLAY_ATTR_S stOverlay;
OVERLAYEX_ATTR_S stOverlayEx;
} RGN_ATTR_U;
【成员】
成员名称 |
描述 |
|---|---|
stOverlay |
视频迭加区域属性。 |
stOverlayEx |
扩展视频迭加区域属性。 |
【注意事项】
仅有RGN_TYPE_E为Overlay/OverlayEx时,需设置此属性。
【相关数据类型及接口】
无。
9.4.57. RGN_CHN_ATTR_U¶
【说明】
定义区域通道属性联合体。
【定义】
typedef union _RGN_CHN_ATTR_U {
OVERLAY_CHN_ATTR_S stOverlayChn;
COVER_CHN_ATTR_S stCoverChn;
COVEREX_CHN_ATTR_S stCoverExChn;
OVERLAYEX_CHN_ATTR_S stOverlayExChn;
MOSAIC_CHN_ATTR_S stMosaicChn;
} RGN_CHN_ATTR_U;
【成员】
成员名称 |
描述 |
|---|---|
stOverlayChn |
视频迭加区域通道属性。 |
stCoverChn |
遮挡区域通道属性。 |
stCoverExChn |
扩展遮挡区域通道属性。 |
stOverlayExChn |
扩展视频迭加区域通道属性。 |
stMosaicChn |
Mosaic区域通道属性。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.58. RGN_ATTR_S¶
【说明】
定义区域属性结构体。
【定义】
typedef struct _RGN_ATTR_S {
RGN_TYPE_E enType;
RGN_ATTR_U unAttr;
} RGN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enType |
区域类型。 |
unAttr |
区域属性联合体。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.59. RGN_CHN_ATTR_S¶
【说明】
定义区域通道属性结构体。
【定义】
typedef struct _RGN_CHN_ATTR_S {
CVI_BOOL bShow;
RGN_TYPE_E enType;
RGN_CHN_ATTR_U unChnAttr;
} RGN_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
bShow |
区域是否显示。 |
enType |
区域类型。 |
unChnAttr |
区域通道属性联合体。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.60. RGN_COORDINATE_E¶
【说明】
定义坐标类型。
【定义】
typedef enum _RGN_COORDINATE_E {
RGN_ABS_COOR = 0,
RGN_RATIO_COOR
} RGN_COORDINATE_E;
【成员】
成员名称 |
描述 |
|---|---|
RGN_ABS_COOR |
绝对坐标。 |
RGN_RATIO_COOR |
相对坐标。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.61. RGN_QUADRANGLE_S¶
【说明】
定义任意四边形结构体。
【定义】
typedef struct _RGN_QUADRANGLE_S {
CVI_BOOL bSolid;
CVI_U32 u32Thick;
POINT_S stPoint[4];
} RGN_QUADRANGLE_S;
【成员】
成员名称 |
描述 |
|---|---|
bSolid |
实心四边形或虚心四边形。 |
u32Thick |
四边形的线宽,当虚心四边形时有效。 |
stPoint[4] |
任意四边形四个点坐标。 |
【注意事项】
目前不支持。
【相关数据类型及接口】
无。
9.4.62. MOSAIC_BLK_SIZE_E¶
【说明】
定义MOSAIC区域的块大小类型。
【定义】
typedef enum _MOSAIC_BLK_SIZE_E {
MOSAIC_BLK_SIZE_8 = 0,
MOSAIC_BLK_SIZE_16,
MOSAIC_BLK_SIZE_BUTT
} MOSAIC_BLK_SIZE_E;
【成员】
成员名称 |
描述 |
|---|---|
MOSAIC_BLK_SIZE_8 |
8*8 大小。 |
MOSAIC_BLK_SIZE_16 |
16*16 大小。 |
【注意事项】
同一通道上的马赛克必须具有相同的块大小。
【相关数据类型及接口】
无。
9.4.63. MOSAIC_CHN_ATTR_S¶
【说明】
定义MOSAIC区域通道属性。
【定义】
typedef struct _MOSAIC_CHN_ATTR_S {
RECT_S stRect;
MOSAIC_BLK_SIZE_E enBlkSize;
CVI_U32 u32Layer;
} MOSAIC_CHN_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stRect |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
enBlkSize |
MOSAIC区域的块大小。 |
u32Layer |
区域层次。
目前不支持。
|
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.64. INVERT_COLOR_MODE_E¶
【说明】
定义OSD反色模式。
【定义】
typedef enum _INVERT_COLOR_MODE_E {
LESSTHAN_LUM_THRESH = 0,
MORETHAN_LUM_THRESH,
INVERT_COLOR_BUTT
} INVERT_COLOR_MODE_E;
【成员】
成员名称 |
描述 |
|---|---|
LESSTHAN_LUM_THRESH |
当视频背景亮度均值小于亮度阈值时触发反色。 |
MORETHAN_LUM_THRESH |
当视频背景亮度均值大于亮度阈值时触发反色。 |
【注意事项】
目前不支持。
【相关数据类型及接口】
无。
9.4.65. OVERLAY_INVERT_COLOR_S¶
【说明】
定义OSD反色属性。
【定义】
typedef struct _OVERLAY_INVERT_COLOR_S {
SIZE_S stInvColArea;
CVI_U32 u32LumThresh;
INVERT_COLOR_MODE_E enChgMod;
CVI_BOOL bInvColEn;
} OVERLAY_INVERT_COLOR_S;
【成员】
成员名称 |
描述 |
|---|---|
stInvColArea |
反色区域大小。 |
u32LumThresh |
亮度阈值。 |
enChgMod |
OSD反色模式。 |
bInvColEn |
反色开关。 |
【注意事项】
目前不支持。
【相关数据类型及接口】
无。
9.4.66. RGN_CMPR_TYPE_E¶
【说明】
定义区域压缩类型。
【定义】
typedef enum _RGN_CMPR_TYPE_E {
RGN_CMPR_RECT = 0,
RGN_CMPR_BIT_MAP,
RGN_CMPR_LINE,
RGN_CMPR_BUTT
} RGN_CMPR_TYPE_E;
【成员】
成员名称 |
描述 |
|---|---|
RGN_CMPR_RECT |
矩形压缩。 |
RGN_CMPR_BIT_MAP |
位图压缩。 |
RGN_CMPR_LINE |
线条压缩。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.67. RGN_LINE_ATTR_S¶
【说明】
定义线条属性。
【定义】
typedef struct _RGN_LINE_ATTR_S {
POINT_S stPointStart;
POINT_S stPointEnd;
CVI_U32 u32Thick;
CVI_U32 u32Color;
} RGN_LINE_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stPointStart |
线条起始点。 |
stPointEnd |
线条终点。 |
u32Thick |
线条宽度。 |
u32Color |
线条颜色。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.68. RGN_RECT_ATTR_S¶
【说明】
定义矩形属性。
【定义】
typedef struct _RGN_RECT_ATTR_S {
RECT_S stRect;
CVI_U32 u32Thick;
CVI_U32 u32Color;
CVI_U32 u32IsFill;
} RGN_RECT_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stRect |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
u32Thick |
矩形的线宽。 |
u32Color |
矩形的颜色。 |
u32IsFill |
是否填充矩形。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.69. RGN_BITMAP_ATTR_S¶
【说明】
定义位图属性。
【定义】
typedef struct _RGN_BITMAP_ATTR_S {
RECT_S stRect;
CVI_U32 u32BitmapPAddr;
} RGN_BITMAP_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
stRect |
区域位置和宽高。
位置可为负数,矩形在通道的范围以外的部分会看不到。
宽高不可超过通道的大小。
|
u32BitmapPAddr |
位图的物理地址。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.70. RGN_CMPR_OBJ_ATTR_S¶
【说明】
定义压缩对象属性。
【定义】
typedef struct _RGN_CMPR_OBJ_ATTR_S {
RGN_CMPR_TYPE_E enObjType;
union {
RGN_LINE_ATTR_S stLine;
RGN_RECT_ATTR_S stRgnRect;
RGN_BITMAP_ATTR_S stBitmap;
};
} RGN_CMPR_OBJ_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
enObjType |
压缩对象类型。 |
stLine |
线条属性。 |
stRgnRect |
矩形属性。 |
stBitmap |
位图属性。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.71. RGN_CANVAS_CMPR_ATTR_S¶
【说明】
定义画布压缩属性。
【定义】
typedef struct _RGN_CANVAS_CMPR_ATTR_S {
CVI_U32 u32Width;
CVI_U32 u32Height;
CVI_U32 u32BgColor;
PIXEL_FORMAT_E enPixelFormat;
CVI_U32 u32BsSize;
CVI_U32 u32ObjNum;
} RGN_CANVAS_CMPR_ATTR_S;
【成员】
成员名称 |
描述 |
|---|---|
u32Width |
画布宽度。 |
u32Height |
画布高度。 |
u32BgColor |
背景色。 |
enPixelFormat |
像素格式。 |
u32BsSize |
基本大小。 |
u32ObjNum |
对象编号。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.72. RGN_CANVAS_INFO_S¶
【说明】
定义画布信息。
【定义】
typedef struct _RGN_CANVAS_INFO_S {
CVI_U64 u64PhyAddr;
CVI_U8 *pu8VirtAddr;
#ifdef __arm__
__u32 padding; /* padding for keeping same size of this structure */
#endif
SIZE_S stSize;
CVI_U32 u32Stride;
PIXEL_FORMAT_E enPixelFormat;
CVI_BOOL bCompressed;
CVI_U32 u32CompressedSize;
OSD_COMPRESS_MODE_E enOSDCompressMode;
RGN_CANVAS_CMPR_ATTR_S *pstCanvasCmprAttr;
RGN_CMPR_OBJ_ATTR_S *pstObjAttr;
} RGN_CANVAS_INFO_S;
【成员】
成员名称 |
描述 |
|---|---|
u64PhyAddr |
物理地址。 |
pu8VirtAddr |
虚拟地址。 |
stSize |
画布大小。 |
u32Stride |
步幅。 |
enPixelFormat |
像素格式。 |
bCompressed |
画布是否被压缩。 |
u32CompressedSize |
画布压缩后的大小。 |
enOSDCompressMode |
OSD压缩模式。 |
pstCanvasCmprAttr |
画布压缩属性。 |
pstObjAttr |
压缩对象属性。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.73. RGN_RGBQUARD_S¶
【说明】
定义调色盘颜色。
【定义】
typedef struct _RGN_RGBQUAD {
CVI_U8 argbAlpha;
CVI_U8 argbRed;
CVI_U8 argbGreen;
CVI_U8 argbBlue;
} RGN_RGBQUARD_S;
【成员】
成员名称 |
描述 |
|---|---|
argbAlpha |
Alpha通道。 |
argbRed |
红色通道。 |
argbGreen |
绿色通道。 |
argbBlue |
蓝色通道。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.74. RGN_COLOR_FMT_E¶
【说明】
定义 OSD 支持的颜色格式。
【定义】
typedef enum _RGN_COLOR_FMT_E {
RGN_COLOR_FMT_RGB444 = 0,
RGN_COLOR_FMT_RGB4444 = 1,
RGN_COLOR_FMT_RGB555 = 2,
RGN_COLOR_FMT_RGB565 = 3,
RGN_COLOR_FMT_RGB1555 = 4,
RGN_COLOR_FMT_RGB888 = 6,
RGN_COLOR_FMT_RGB8888 = 7,
RGN_COLOR_FMT_ARGB4444 = 8,
RGN_COLOR_FMT_ARGB1555 = 9,
RGN_COLOR_FMT_ARGB8888 = 10,
RGN_COLOR_FMT_BUTT
} RGN_COLOR_FMT_E;
【成员】
成员名称 |
描述 |
|---|---|
RGN_COLOR_FMT_RGB444 |
RGB444格式。 |
RGN_COLOR_FMT_RGB4444 |
RGB4444格式。 |
RGN_COLOR_FMT_RGB555 |
RGB555格式。 |
RGN_COLOR_FMT_RGB565 |
RGB565格式。 |
RGN_COLOR_FMT_RGB1555 |
RGB1555格式。 |
RGN_COLOR_FMT_RGB888 |
RGB888格式。 |
RGN_COLOR_FMT_RGB8888 |
RGB8888格式。 |
RGN_COLOR_FMT_ARGB4444 |
ARGB4444格式。 |
RGN_COLOR_FMT_ARGB1555 |
ARGB1555格式。 |
RGN_COLOR_FMT_ARGB8888 |
ARGB8888格式。 |
【注意事项】
无。
【相关数据类型及接口】
无。
9.4.75. RGN_PALETTE_S¶
【说明】
定义调色盘属性。
【定义】
typedef struct _RGN_PALETTE {
RGN_RGBQUARD_S *pstPaletteTable;
CVI_U16 lut_length;
RGN_COLOR_FMT_E pixelFormat;
} RGN_PALETTE_S;
【成员】
成员名称 |
描述 |
|---|---|
pstPaletteTable |
调色盘表。 |
lut_length |
颜色查找表的长度。 |
pixelFormat |
OSD支持的颜色格式。 |
【注意事项】
无。
【相关数据类型及接口】
无。