Function: dvpp_vpc_batch_crop_and_paste_async

Applicability

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

Description

Crops one or more ROIs from one or more images and pastes each cropped image to the canvas for output. This API is asynchronous.

Prototype

C Prototype

        
             aclError acldvppVpcBatchCropAndPasteAsync(acldvppChannelDesc *channelDesc, acldvppBatchPicDesc *srcBatchPicDesc, uint32_t *roiNums, uint32_t size, acldvppBatchPicDesc *dstBatchPicDesc, acldvppRoiConfig *cropAreas[], acldvppRoiConfig *pasteAreas[], aclrtStream stream)

Python Function

        
             dst_batch_pic_descs, ret = acl.media.dvpp_vpc_batch_crop_and_paste_async(dvpp_channel_desc, src_batch_pic_descs, roi_nums_list, dst_batch_pic_descs, crop_area_list, paste_area_list, stream)

Parameters

Parameter	Description
dvpp_channel_desc	Int, pointer address of the channel description. The value must be the same as that of dvpp_channel_desc specified when the acl.media.dvpp_create_channel API is called to create a channel.
src_batch_pic_descs	Int, pointer address of the description of batch input images. Call the acl.media.dvpp_create_batch_pic_desc API to create the description of batch images. Call the acl.media.dvpp_get_pic_desc API to obtain the description of a specified image. Call the acl.media.dvpp_set_pic_desc APIs to set the image description (including the buffer address, buffer size, image format, and image resolution).
roi_nums_list	List, list of number of cropped images, up to 256. The value of roi_nums_list is less than or equal to 256, which is the same as the value of batch_size in dst_batch_pic_descs. (roi_nums_list[0] + ... + roi_nums_list[size - 1] <= 256)
dst_batch_pic_descs	Int, pointer address of the description of batch output images. Call the acl.media.dvpp_create_batch_pic_desc API to create the description of batch images. Call the acl.media.dvpp_get_pic_desc API to obtain the description of a specified image. Call the acl.media.dvpp_set_pic_desc APIs to set the image description (including the buffer address, buffer size, image format, and image resolution).
crop_area_list	List, list of the position of the cropping area. Call acl.media.dvpp_create_roi_config to create an ROI configuration. The number of elements in crop_area and paste_area is the same as that of batch_size in dst_batch_pic_descs.
paste_area_list	List, list of the position of the paste ROI. Call acl.media.dvpp_create_roi_config to create an ROI configuration. Round up the left offset of the paste ROI to the nearest multiple of 16. The number of elements in crop_area and paste_area is the same as that of batch_size in dst_batch_pic_descs.
stream	Int, stream object.

Return Value

Return Value	Description
dst_batch_pic_descs	Int, pointer address of the description of batch output images.
ret	Int, error code. 0 on success; else, failure.

Reference

For the API call example, see Sample Code for Image Cropping and Pasting (Single-Image, Single-ROI).

Restrictions

Version	Restrictions
Atlas training product	Input image size and format: When the input image size is in the range of [10 x 6, 4096 x 4096], the input image formats described in Restrictions on Image Formats, Width and Height Alignment, and Buffers are supported. When the width or height of the input image is in the range of (4096, 8192], the supported formats are as follows: The following enum values of acldvppPixelFormat are supported: PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1, // YUV420SP NV12 8bit PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2, // YUV420SP NV21 8bit For details about the output image resolution and format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers. 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. When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the high-order filtering algorithm developed by Huawei.
Atlas inference product	Input image size and format: When the input image size is in the range of [10 x 6, 4096 x 4096], the input image formats described in Restrictions on Image Formats, Width and Height Alignment, and Buffers are supported. When the width or height of the input image is in the range of (4096, 8192], the supported formats are as follows: The following enum values of acldvppPixelFormat are supported: PIXEL_FORMAT_YUV_400 = 0, // YUV400 8bit PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1, // YUV420SP NV12 8bit PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2, // YUV420SP NV21 8bit PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3, // YUV422SP 8bit PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4, // YVU422SP 8bit PIXEL_FORMAT_YUV_SEMIPLANAR_444 = 5, // YUV444SP 8bit PIXEL_FORMAT_YVU_SEMIPLANAR_444 = 6, // YVU444SP 8bit PIXEL_FORMAT_YUYV_PACKED_422 = 7, // YUV422Packed YUYV 8bit PIXEL_FORMAT_UYVY_PACKED_422 = 8, // YUV422Packed UYVY 8bit PIXEL_FORMAT_YVYU_PACKED_422 = 9, // YUV422Packed YVYU 8bit PIXEL_FORMAT_VYUY_PACKED_422 = 10, // YUV422Packed VYUY 8bit For details about the output image resolution and format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers. 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. When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the widely used Bilinear algorithm.
Atlas A2 training product / Atlas A2 inference product Atlas 200I/500 A2 inference product Atlas A3 training product / Atlas A3 inference product	For details about the restrictions on the image resolution, image format, width and height alignment, and memory, see Restrictions on Image Formats, Width and Height Alignment, and Buffers. When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the widely used Bilinear algorithm. Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, it is recommended that the top and left offset of the paste ROI be even numbers.

Version

Restrictions

Atlas training product

Input image size and format:
- When the input image size is in the range of [10 x 6, 4096 x 4096], the input image formats described in Restrictions on Image Formats, Width and Height Alignment, and Buffers are supported.
- When the width or height of the input image is in the range of (4096, 8192], the supported formats are as follows:
  The following enum values of acldvppPixelFormat are supported:
```
PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1,       // YUV420SP NV12 8bit   
PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2,       // YUV420SP NV21 8bit 
```
For details about the output image resolution and format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.
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.
When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the high-order filtering algorithm developed by Huawei.

Atlas inference product

Input image size and format:

When the input image size is in the range of [10 x 6, 4096 x 4096], the input image formats described in Restrictions on Image Formats, Width and Height Alignment, and Buffers are supported.

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

The following enum values of acldvppPixelFormat are supported:

PIXEL_FORMAT_YUV_400 = 0,               // YUV400 8bit
PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1,    // YUV420SP NV12 8bit   
PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2,    // YUV420SP NV21 8bit 
PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3,    // YUV422SP 8bit
PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4,    // YVU422SP 8bit
PIXEL_FORMAT_YUV_SEMIPLANAR_444 = 5,    // YUV444SP 8bit
PIXEL_FORMAT_YVU_SEMIPLANAR_444 = 6,    // YVU444SP 8bit
PIXEL_FORMAT_YUYV_PACKED_422 = 7,       // YUV422Packed YUYV 8bit
PIXEL_FORMAT_UYVY_PACKED_422 = 8,       // YUV422Packed UYVY 8bit
PIXEL_FORMAT_YVYU_PACKED_422 = 9,       // YUV422Packed YVYU 8bit
PIXEL_FORMAT_VYUY_PACKED_422 = 10,      // YUV422Packed VYUY 8bit

For details about the output image resolution and format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.
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.
When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the widely used Bilinear algorithm.

Atlas A2 training product / Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas A3 training product / Atlas A3 inference product

For details about the restrictions on the image resolution, image format, width and height alignment, and memory, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.
When the width and height of the paste_area are different from those of the crop_area, the image is resized. The default resizing algorithm is the widely used Bilinear algorithm.
Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, it is recommended that the top and left offset of the paste ROI be even numbers.

Parent topic: VPC