acldvppGetPicDesc Series

Applicability

Product	Supported
Atlas A3 training products / Atlas A3 inference products	√
Atlas A2 training products / Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	√
Atlas inference products	√
Atlas training products	√

Description

Obtains 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 acldvppCreatePicDesc to create data of the acldvppPicDesc type and call the acldvppSetPicDesc series to set the image description in advance.

Parameter

Input/Output

Description

picDesc

Input

Pointer to the image description.

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

Returns

Parameter	Description
data	Memory address of the image data.
size	Memory size of the image data.
format	Image format.
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 Codes. 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 Codes.

Parent topic: acldvppPicDesc