hi_mpi_vdec_get_jpegd_output_info

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

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, this API returns the error code HI_ERR_VDEC_NOT_SUPPORT. For details, see Common Return Codes.

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)

Parameters

Parameter	Input/Output	Description
stream	Input	Pointer to the information of the input 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 A3 training products/Atlas A3 inference products Atlas A2 training products/Atlas A2 inference products Atlas 200I/500 A2 inference products in Ascend EP form Atlas inference products in Ascend EP form For the following products, when this API is called on the device, the configured addr must be a buffer address on the device: Atlas 200I/500 A2 inference products in Ascend RC form
output_format	Input	Output image format. To obtain related information based on the source image format, set this parameter to HI_PIXEL_FORMAT_UNKNOWN. To obtain related information based on 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.
img_info	Output	Information about the output image, including the width, height, width stride, height stride, buffer size, and image format after decoding. The output image format is returned by img_pixel_format.

Parameter

Input/Output

Description

stream

Input

Pointer to the information of the input 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 A3 training products/Atlas A3 inference products
Atlas A2 training products/Atlas A2 inference products
Atlas 200I/500 A2 inference products in Ascend EP form
Atlas inference products in Ascend EP form

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

Atlas 200I/500 A2 inference products in Ascend RC form

output_format

Input

Output image format.

To obtain related information based on the source image format, set this parameter to HI_PIXEL_FORMAT_UNKNOWN. To obtain related information based on 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.

img_info

Output

Information about the output image, including the width, height, width stride, height stride, buffer size, and image format after decoding.

The output image format is returned by img_pixel_format.

Returns

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

Parent topic: Video Decoder (VDEC) and JPEG Decoder (JPEGD)