vdec_get_jpegd_output_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

For image decoding, this API is used to obtain the output width, height, width stride, height stride of the source or specified image format, and buffer size and image format after decoding, based on input streams.

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)

Parameter Description

Parameter	Description
stream	Dict, input stream information dictionary. For details, see hi_vdec_stream. For the 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. For the Atlas A2 training products / Atlas A2 inference products , when this API is called on the host, the configured addr address must be a buffer address on the host. For the 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. For 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.
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 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.

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

For the 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.

For 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.

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 Description

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: failures. For details, see VDEC/JPEGD Return Codes.

Parent topic: VDEC/JPEGD APIs