hi_mpi_dvpp_get_image_info

Applicable Products

Product	Supported
Ascend 950PR/Ascend 950DT	√
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	☓

Function

Obtains information such as the output width, height, width stride, height stride, and buffer size, as well as the source image format based on the input code when the source image format is retained after decoding. This API checks whether the image format supports decoding. For an unsupported stream, this API returns the error code HI_ERR_VDEC_NOT_SUPPORT. For details, see VDEC/JPEGD Return Codes.

Prototype

hi_s32 hi_mpi_dvpp_get_image_info(hi_payload_type img_type, const hi_vdec_stream *stream, hi_img_info *img_info)

Parameters

Parameter	Input/Output	Description
img_type	Input	Type of the stream to parse. Currently, the stream type can only be HI_PT_JPEG.
stream	Input	Pointer to the input stream information. In Ascend EP form, when this API is called on the host, the address configured by the addr parameter in the structure must be the memory address on the host. In Ascend RC form, when this API is called on the device, the address configured by the addr parameter in the structure must be the memory address on the device. In Open Ctrl CPU form, when this API is called on the device, the configured addr must be a buffer address on the device.
img_info	Output	Pointer to the image information, such as the image width, height, width stride, height stride, buffer size occupied after decoding, and source image format. The source image format is returned through the pixel_format parameter.

Parameter

Input/Output

Description

img_type

Input

Type of the stream to parse.

Currently, the stream type can only be HI_PT_JPEG.

stream

Input

Pointer to the input stream information.

In Ascend EP form, when this API is called on the host, the address configured by the addr parameter in the structure must be the memory address on the host.

In Ascend RC form, when this API is called on the device, the address configured by the addr parameter in the structure must be the memory address on the device.

In Open Ctrl CPU form, when this API is called on the device, the configured addr must be a buffer address on the device.

img_info

Output

Pointer to the image information, such as the image width, height, width stride, height stride, buffer size occupied after decoding, and source image format.

The source image format is returned through the pixel_format parameter.

Returns

0: success
Other values: failure. For details, see VDEC/JPEGD Return Codes.

Parent topic: Common APIs