vdec_get_jpegd_output_info

Applicability

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

Description

Obtains the width, height, width stride, height stride, buffer size, and image format of the image output based on the source image format or specified image format based on the input stream in the image decoding scenario.

This API checks whether the image format supports decoding. For an unsupported stream, the API returns the error code HI_ERR_VDEC_NOT_SUPPORT. For details, see Common Return Codes.

Prototype

C Prototype

hi_s32 hi_mpi_vdec_get_jpegd_output_info(const hi_vdec_stream *stream, const hi_pixel_format output_format, hi_img_info *img_info)

Python Function

img_info, ret = acl.himpi.vdec_get_jpegd_output_info(stream, output_format)

Parameters

Parameter	Description
stream	Dict, input stream information dictionary. For details, see hi_vdec_stream. For the following products, when this API is called on the host, the configured addr must be a buffer address on the host: Atlas 350 Accelerator Card Atlas A3 training product/Atlas A3 inference product Atlas A2 training product/Atlas A2 inference product Ascend EP form of the Atlas 200I/500 A2 inference product Ascend EP form of Atlas inference product For the following products, when this API is called on the device, the configured addr must be a buffer address on the device: Ascend RC form of the Atlas 200I/500 A2 inference product
output_format	Int, output image format. To obtain related information based on the source image format, set this parameter to HI_PIXEL_FORMAT_UNKNOWN = 0. To obtain related information in a specified format, set this parameter to the corresponding image format. For details about the supported image formats, see Restrictions on image formats, width and height alignment, and buffers.

Parameter

Description

stream

Dict, input stream information dictionary. For details, see hi_vdec_stream.

For the following products, when this API is called on the host, the configured addr must be a buffer address on the host:

Atlas 350 Accelerator Card
Atlas A3 training product/Atlas A3 inference product
Atlas A2 training product/Atlas A2 inference product
Ascend EP form of the Atlas 200I/500 A2 inference product
Ascend EP form of Atlas inference product

For the following products, when this API is called on the device, the configured addr must be a buffer address on the device:

Ascend RC form of the Atlas 200I/500 A2 inference product

output_format

Int, output image format.

To obtain related information based on the source image format, set this parameter to HI_PIXEL_FORMAT_UNKNOWN = 0. To obtain related information in a specified format, set this parameter to the corresponding image format. For details about the supported image formats, see Restrictions on image formats, width and height alignment, and buffers.

Return Value

Return Value	Description
img_info	Dict, output image information dictionary, including the width, height, width stride, height stride, and buffer size and image format after decoding. The output image format is returned by pixel_format. For details, see hi_img_info.
ret	Int, error code. 0: success Other values: failure. For details, see VDEC/JPEGD Return Codes.

Parent topic: VDEC/JPEGD APIs