venc_send_jpeg_frame

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

Sends source images for encoding and configures the output buffer address of the encoding result.

Prototype

C Prototype

        
             hi_s32 hi_mpi_venc_send_jpeg_frame(hi_venc_chn chn, const hi_video_frame_info *frame, const hi_img_stream *jpege_stream, hi_s32 milli_sec)

Python Function

        
             ret = acl.himpi.venc_send_jpege_frame(chn,  frame,  jpege_stream,  milli_sec)

Parameter Description

Parameter	Description
chn	Int, decoding channel ID. Atlas inference products : The value range of this parameter is [0, 256). The JPEGD and VDEC functions share the same channels, and the maximum number of channels is 256. Atlas A2 training products / Atlas A2 inference products : The value range of this parameter is [0, 256). The JPEGD and VDEC functions share the same channels, and the maximum number of channels is 256. Among them, a maximum of 256 JPEGD decoding channels and 32 VDEC decoding channels are supported. Atlas 200I/500 A2 inference products : The value range of this parameter is [0, 128). The JPEGD and VDEC functions share the same channels, and the maximum number of channels is 128. Atlas A3 training products / Atlas A3 inference products : The value range of this parameter is [0, 256). The JPEGD and VDEC functions share the same channels, and the maximum number of channels is 256. Among them, a maximum of 256 JPEGD decoding channels and 32 VDEC decoding channels are supported.
frame	Dict, dictionary of original image information. For details, see hi_video_frame_info.
jpege_stream	Dict, which specifies the output memory address and length of the encoding result. For details, see hi_img_stream. The start address of the output buffer must be 16-byte aligned. You can call acl.himpi.venc_get_jpege_predicted_size to obtain the buffer size, and then call acl.himpi.dvpp_malloc to allocate the output buffer.
milli_sec	Int, timeout interval, in milliseconds. -1: blocking mode. 0: non-blocking mode. > 0: timeout interval (timeout mode). The timeout interval varies with the operating system. The deviation is generally within a time slice of an operating system. For example, if the time slice of an operating system is 4 ms and the value of milli_sec is set to 1, the actual timeout interval ranges from 1 ms to 5 ms. When the CPU load is high, the timeout interval may fluctuate.

Return Value Description

Return Value	Description
ret	Int, error code. 0: success. Other values: failures. For details, see VENC/JPEGE Return Codes.

Restrictions

This API is valid only when hi_venc_chn_attr.get("venc_attr")["buf_size"] is set to 0 during the call to venc_create_chn to create a channel. Otherwise, the error code HI_ERR_VENC_NOT_SUPPORT is returned.
The JPEGE input image size must be less than or equal to the size of an encoding channel.
Ensure that an encoding channel has been created and started receiving images.
During encoding, the input and output buffers can be freed only after acl.himpi.venc_get_stream is called to obtain the result.
For details about the input and output restrictions on image encoding, see JPEGE Functions and Restrictions.

Reference

For details about the API call sequence and example, see JPEGE and VENC.

Parent topic: VENC/JPEGE APIs