acldvppGetPicDesc Series

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

Obtains the image description.

Prototype

      
           void *acldvppGetPicDescData(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescSize(const acldvppPicDesc *picDesc)
acldvppPixelFormat acldvppGetPicDescFormat(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescWidth(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescHeight(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescWidthStride(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescHeightStride(const acldvppPicDesc *picDesc)
uint32_t acldvppGetPicDescRetCode(const acldvppPicDesc *picDesc)

Parameters

Parameter	Input/Output	Description
picDesc	Input	Pointer to the image description. Call the acldvppCreatePicDesc API to create data of the acldvppPicDesc type and call acldvppSetPicDesc series APIs to set the image description parameter in advance.

Parameter

Input/Output

Description

picDesc

Input

Pointer to the image description.

Call the acldvppCreatePicDesc API to create data of the acldvppPicDesc type and call acldvppSetPicDesc series APIs to set the image description parameter in advance.

Returns

Parameter	Description
data	Memory address of the image data.
size	Memory size of the image data.
format	Image format. For details about the type definition, see acldvppPixelFormat.
width	Width of the source image.
height	Height of the source image.
widthStride	Width stride.
heightStride	Height stride.
retCode	Return code (0 on success; else, failure). During VDEC decoding, call acldvppGetPicDescRetCode to obtain the retCode return code to check the decoding result. If the decoding fails, locate the fault based on the return code in the log. For details about the return codes, see Return Code. Some of the retCode return codes are defined in hexadecimal format. If you want to print the result code values in decimal format (for example, 65540) during encoding, convert the return code values into the hexadecimal format (for example, 0x10004) in advance and then query the result codes in Return Code.

Parent topic: acldvppPicDesc