hi_mpi_vpc_batch_crop_resize_make_border

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	√
Atlas inference product	√
Atlas training product	☓

Function Description

Extended API of hi_mpi_vpc_crop_resize_make_border, which supports the batch processing mode. Crops one or more ROIs from each source image, resizes the cropped images, pastes the resized images to each output canvas, and creates borders around the paste ROIs. This API is asynchronous.

Prototype

hi_s32 hi_mpi_vpc_batch_crop_resize_make_border(hi_vpc_chn chn, const hi_vpc_pic_info *source_pic[], hi_u32 pic_num, hi_vpc_crop_resize_border_region crop_resize_make_border_info[], hi_u32 count[], hi_u32 *task_id, hi_s32 milli_sec)

Parameters

Parameter	Input/Output	Description
chn	Input	Channel ID for image processing. Atlas 350 Accelerator Card: The value range is [0, 256). The maximum number of channels is 256. Atlas A3 training product/Atlas A3 inference product: The value range is [0, 256). The maximum number of channels is 256. Atlas A2 training product/Atlas A2 inference product: The value range is [0, 256). The maximum number of channels is 256. Atlas 200I/500 A2 inference product: The value range is [0, 128). The maximum number of channels is 128. Atlas inference product: The value range is [0, 256). The maximum number of channels is 256.
source_pic	Input	Pointer array of the source image information.
pic_num	Input	Number of source images. Its length must be the same as that of the source_pic array and that of the count array.
crop_resize_make_border_info	Input	Defines the cropping, resizing, and padding information. You need to set the buffer address of the destination image and the cropping, resizing, and padding information. The VPC stores the cropping, resizing, and padding results in the specified buffer address. Currently, only HI_BORDER_CONSTANT and HI_BORDER_REPLICATE are supported. The maximum resolution is 4096 x 4096.
count	Input	Number of cropped, resized, and padded images. The sum of element values in the count array is equal to the length of the crop_resize_make_border_info array. The sum of element values in the count array must be in the range of [1, 256].
task_id	Output	Pointer to the task ID, which is used to identify a task.
milli_sec	Input	Timeout interval (ms). -1: blocking mode. 0: non-blocking mode. > 0: timeout interval (timeout mode). The timeout interval varies with the operating system. The deviation is generally within a time slice of an operating system. For example, if the time slice of an operating system is 4 ms and the value of milli_sec is set to 1, the actual timeout interval ranges from 1 ms to 5 ms. When the CPU load is high, the timeout interval may fluctuate.

Returns

0: success
Other values: failure. For details, see VPC Return Codes.

Restrictions

Model	Restriction
Atlas inference product	Input image resolution and format: If the input image resolution is within the range of [10 x 6, 4096 x 4096], the input image format described in Restrictions on Image Formats, Width and Height Alignment, and Buffers is supported. When the width or height of the input image is within the range of (4096, 8192], the supported formats are as follows: The following enumerated values of hi_pixel_format are supported: HI_PIXEL_FORMAT_YUV_400 = 0, // YUV400 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1, // YUV420SP NV12 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2, // YUV420SP NV21 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3, // YUV422SP 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4, // YVU422SP 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_444 = 5, // YUV444SP 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_444 = 6, // YVU444SP 8bit HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7, // YUV422Packed YUYV 8bit HI_PIXEL_FORMAT_UYVY_PACKED_422 = 8, // YUV422Packed UYVY 8bit HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9, // YUV422Packed YVYU 8bit HI_PIXEL_FORMAT_VYUY_PACKED_422 = 10, // YUV422Packed VYUY 8bit For details about the restrictions on the width and height alignment and buffer size of each image format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers. For details about the restrictions on the output image resolution, image format, width and height alignment, and buffer size, see Restrictions. When the input and output images are in ARGB8888, ABGR8888, RGBA8888, or BGRA8888 format, the A component value changes to 0 after being resized by this API. hi_vpc_crop_resize_border_region allows diversified setting combinations. However, there are some common restrictions, for example: If the desired size for cropping is the same as the source image size, cropping is not performed. If the desired size for resizing is the same as the crop ROI size, resizing is not performed. If the desired size for cropping and resizing is the same as the output image and the coordinates of the upper-left corner of the image are (0, 0), padding is not performed. For details about the description and restrictions when this API is used to implement the proportional scaling function, see Restrictions on Image Cropping and Pasting. Due to restrictions on downsampling of YUV images, pay attention to the following when the output image format is YUV420SP or YUV422SP: For the YUV420SP output format, it is recommended that the border lengths at the top, bottom, left, and right of the image be even numbers. For the output YUV422SP format, it is recommended that the border lengths at the left and right of the image be even numbers.
Atlas 350 Accelerator Card Atlas A3 training product/Atlas A3 inference product Atlas A2 training product/Atlas A2 inference product Atlas 200I/500 A2 inference product	For details about the restrictions on the image resolution, width and height alignment of each image format, and buffer size, see Restrictions. When the input and output images are in ARGB8888, ABGR8888, RGBA8888, or BGRA8888 format, the A component value changes to 0 after being resized by this API. hi_vpc_crop_resize_border_region allows diversified setting combinations. However, there are some common restrictions, for example: If the desired size for cropping is the same as the source image size, cropping is not performed. If the desired size for resizing is the same as the crop ROI size, resizing is not performed. If the desired size for cropping and resizing is the same as the output image and the coordinates of the upper-left corner of the image are (0, 0), padding is not performed. For details about the description and restrictions when this API is used to implement the proportional scaling function, see Restrictions on Image Cropping and Pasting. Due to restrictions on downsampling of YUV images, pay attention to the following when the output image format is YUV420SP or YUV422SP: For the YUV420SP output format, it is recommended that the border lengths at the top, bottom, left, and right of the image be even numbers. For the output YUV422SP format, it is recommended that the border lengths at the left and right of the image be even numbers.

Model

Restriction

Atlas inference product

Input image resolution and format:

If the input image resolution is within the range of [10 x 6, 4096 x 4096], the input image format described in Restrictions on Image Formats, Width and Height Alignment, and Buffers is supported.

When the width or height of the input image is within the range of (4096, 8192], the supported formats are as follows:

The following enumerated values of hi_pixel_format are supported:

HI_PIXEL_FORMAT_YUV_400 = 0,               // YUV400 8bit
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1,    // YUV420SP NV12 8bit   
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2,    // YUV420SP NV21 8bit 
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3,    // YUV422SP 8bit
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4,    // YVU422SP 8bit
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_444 = 5,    // YUV444SP 8bit
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_444 = 6,    // YVU444SP 8bit
HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7,       // YUV422Packed YUYV 8bit
HI_PIXEL_FORMAT_UYVY_PACKED_422 = 8,       // YUV422Packed UYVY 8bit
HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9,       // YUV422Packed YVYU 8bit
HI_PIXEL_FORMAT_VYUY_PACKED_422 = 10,      // YUV422Packed VYUY 8bit

For details about the restrictions on the width and height alignment and buffer size of each image format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.

For details about the restrictions on the output image resolution, image format, width and height alignment, and buffer size, see Restrictions.
When the input and output images are in ARGB8888, ABGR8888, RGBA8888, or BGRA8888 format, the A component value changes to 0 after being resized by this API.
hi_vpc_crop_resize_border_region allows diversified setting combinations. However, there are some common restrictions, for example:
- If the desired size for cropping is the same as the source image size, cropping is not performed.
- If the desired size for resizing is the same as the crop ROI size, resizing is not performed.
- If the desired size for cropping and resizing is the same as the output image and the coordinates of the upper-left corner of the image are (0, 0), padding is not performed.
For details about the description and restrictions when this API is used to implement the proportional scaling function, see Restrictions on Image Cropping and Pasting.
Due to restrictions on downsampling of YUV images, pay attention to the following when the output image format is YUV420SP or YUV422SP:
- For the YUV420SP output format, it is recommended that the border lengths at the top, bottom, left, and right of the image be even numbers.
- For the output YUV422SP format, it is recommended that the border lengths at the left and right of the image be even numbers.

Atlas 350 Accelerator Card

Atlas A3 training product/Atlas A3 inference product

Atlas A2 training product/Atlas A2 inference product

Atlas 200I/500 A2 inference product

For details about the restrictions on the image resolution, width and height alignment of each image format, and buffer size, see Restrictions.
When the input and output images are in ARGB8888, ABGR8888, RGBA8888, or BGRA8888 format, the A component value changes to 0 after being resized by this API.
hi_vpc_crop_resize_border_region allows diversified setting combinations. However, there are some common restrictions, for example:
- If the desired size for cropping is the same as the source image size, cropping is not performed.
- If the desired size for resizing is the same as the crop ROI size, resizing is not performed.
- If the desired size for cropping and resizing is the same as the output image and the coordinates of the upper-left corner of the image are (0, 0), padding is not performed.
For details about the description and restrictions when this API is used to implement the proportional scaling function, see Restrictions on Image Cropping and Pasting.
Due to restrictions on downsampling of YUV images, pay attention to the following when the output image format is YUV420SP or YUV422SP:
- For the YUV420SP output format, it is recommended that the border lengths at the top, bottom, left, and right of the image be even numbers.
- For the output YUV422SP format, it is recommended that the border lengths at the left and right of the image be even numbers.

Parent topic: VPC