dvpp_get_image_info

Applicability

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

Function Usage

Obtains the output width, height, width stride, height stride, and buffer size as well as the source image format when the source image format is retained after decoding.

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_dvpp_get_image_info(hi_payload_type img_type, const hi_vdec_stream *stream, hi_img_info *img_info);

Python Function

        
             img_info, ret = acl.himpi.dvpp_get_image_info(img_type, stream)

Parameter Description

Parameter	Description
img_type	Int, type of the stream to parse. Currently, only the HI_PT_JPEG stream type is supported. For details, see hi_payload_type.
stream	Dict, pointer address of the input stream information. For details, see hi_vdec_stream. Atlas inference products : In standard form, when this API is called on the host, the configured addr must be a buffer address on the host. Atlas A2 training products / Atlas A2 inference products : When this API is called on the host, the configured addr must be a buffer address on the host. Atlas 200I/500 A2 inference products : In EP mode, when this API is called on the host, the configured addr must be a buffer address on the host. Atlas 200I/500 A2 inference products : In RC mode, when this API is called on the device, the configured addr must be a buffer address on the device. Atlas A3 training products / Atlas A3 inference products : When this API is called on the host, the configured addr must be a buffer address on the host.

Parameter

Description

img_type

Int, type of the stream to parse. Currently, only the HI_PT_JPEG stream type is supported. For details, see hi_payload_type.

stream

Dict, pointer address of the input stream information. For details, see hi_vdec_stream.

Atlas inference products : In standard form, when this API is called on the host, the configured addr must be a buffer address on the host.

Atlas A2 training products / Atlas A2 inference products : When this API is called on the host, the configured addr must be a buffer address on the host.

Atlas 200I/500 A2 inference products : In EP mode, when this API is called on the host, the configured addr must be a buffer address on the host.

Atlas 200I/500 A2 inference products : In RC mode, when this API is called on the device, the configured addr must be a buffer address on the device.

Atlas A3 training products / Atlas A3 inference products : When this API is called on the host, the configured addr must be a buffer address on the host.

Return Value Description

Return Value	Description
img_info	Dict, image information dictionary, including the width, height, width stride, height stride, and buffer size and source image format after decoding. The source image format is returned through the pixel_format parameter. For details, see hi_img_info.
ret	Int, error code. 0: success. Other values: failures. For details, see Common Return Codes.

Return Value

Description

img_info

Dict, image information dictionary, including the width, height, width stride, height stride, and buffer size and source image format after decoding. The source image format is returned through the pixel_format parameter. For details, see hi_img_info.

ret

Int, error code.

0: success.
Other values: failures. For details, see Common Return Codes.

Parent topic: Common APIs