Function: dvpp_vpc_crop_resize_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 the input image based on the specified area, and then pastes the cropped image to the specified area in the canvas as the output image. This API is asynchronous.

A cropped image will be resized again if crop_area and paste_area have different sizes. The resizing algorithm specified in resize_config is used.

Prototype

C Prototype

        
             aclError acldvppVpcCropResizePasteAsync(acldvppChannelDesc *channelDesc, acldvppPicDesc *inputDesc, acldvppPicDesc *outputDesc, acldvppRoiConfig *cropArea, acldvppRoiConfig *pasteArea, acldvppResizeConfig *resizeConfig, aclrtStream stream)

Python Function

        
             ret = acl.media.dvpp_vpc_crop_resize_paste_async(dvpp_channel_desc, input_dvpp_pic_desc, output_dvpp_pic_desc, crop_area, paste_area, resize_config, 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 a channel is created by calling acl.media.dvpp_create_channel.
input_dvpp_pic_desc	Int, pointer address of the input image information. Call the acl.media.dvpp_create_pic_desc API to create the image description. 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).
output_dvpp_pic_desc	Int, pointer address of the output image information. Call the acl.media.dvpp_create_pic_desc API to create the image description. 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	Int, pointer address of the position of the cropping area. Call acl.media.dvpp_create_roi_config to create an ROI configuration.
paste_area	Int, pointer address 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.
resize_config	Int, pointer address of the image resizing configuration data. Call acl.media.dvpp_create_resize_config to create an image resizing configuration in advance.
stream	Int, stream object.

Return Value

Return Value	Description
ret	Int, error code. 0 on success; else, failure.

Reference

For the API call example, see Sample Code for Image Cropping and Resizing (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.
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 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.
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. 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. 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.

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.

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 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.

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.
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.
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.

Parent topic: VPC