Documentation

Function: dvpp_vpc_crop_async

C Prototype

aclError acldvppVpcCropAsync(acldvppChannelDesc *channelDesc, acldvppPicDesc *inputDesc, acldvppPicDesc *outputDesc, acldvppRoiConfig *cropArea, aclrtStream stream)

Python Function

ret = acl.media.dvpp_vpc_crop_async(dvpp_channel_desc, input_dvpp_pic_desc, output_dvpp_pic_desc, crop_area, stream)

Function Usage

Crops the input image based on a specified area and stores the cropped image to the output buffer as the output image. This API is asynchronous.

Input Description

dvpp_channel_desc: int, pointer address of the channel description. It must be the same as the dvpp_channel_desc argument passed to the acl.media.dvpp_create_channel call.

input_dvpp_pic_desc: int, pointer address of the input image information.
  • Call acl.media.dvpp_create_pic_desc to create an image description.
  • Call the acl.media.dvpp_set_pic_desc APIs to set image description parameters (such as the image format, width, and height).

output_dvpp_pic_desc: int, pointer address of the output image information.

When outputDesc is used as an input, the user needs to:

  • Call acl.media.dvpp_create_pic_desc to create an 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.

stream: int, stream object.

Return Value

ret: int, error code.

  • 0 indicates the success of task delivery.
  • Other values indicate the failure of task delivery.

Restrictions

Version

Restrictions

Atlas 200/300/500 Inference Product

Atlas Training Series Product
  • Input image size and format:
    • When the input image resolution 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 size and format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.
  • For details about the restrictions on the width and height alignment, buffer size, and image format, see Restrictions on Image Formats, Width and Height Alignment, and Buffers.
  • If the area of the output image is inconsistent with that of the crop_area, the image is resized again. The default scaling algorithm is the high-order filtering algorithm developed by Huawei.
  • Because the crop ROI obtained by calling this API is directly used as the output image, its size must not be greater than 4096 x 4096.
Parent topic: VPC