esp_h264_enc_single.c File Reference

#include "esp_h264_enc_single.h"
#include "esp_h264_check.h"

Include dependency graph for esp_h264_enc_single.c:

Functions
esp_h264_err_t	esp_h264_enc_open (esp_h264_enc_handle_t enc)
	This function opens an H.264 encoder in single stream.
esp_h264_err_t	esp_h264_enc_process (esp_h264_enc_handle_t enc, esp_h264_enc_in_frame_t *in_frame, esp_h264_enc_out_frame_t *out_frame)
	This function performs single encoding of H.264 video frames. To encode one image using an image encoder, the IDR frame will automatically add SPS and PPS NALU.
esp_h264_err_t	esp_h264_enc_close (esp_h264_enc_handle_t enc)
	This function closes the H.264 encoder instance specified by enc
esp_h264_err_t	esp_h264_enc_del (esp_h264_enc_handle_t enc)
	This function is used to delete an H.264 encoder.

Function Documentation

esp_h264_enc_close()

esp_h264_err_t esp_h264_enc_close

(

esp_h264_enc_handle_t

enc

)

This function closes the H.264 encoder instance specified by enc

Parameters

[in]

enc

A pointer to the H.264 encoder instance

Returns

• ESP_H264_ERR_OK Succeeded
• ESP_H264_ERR_ARG Invalid arguments passed
• ESP_H264_ERR_UNSUPPORTED Close feature is not supported by the encoder

esp_h264_enc_del()

esp_h264_err_t esp_h264_enc_del

(

esp_h264_enc_handle_t

enc

)

This function is used to delete an H.264 encoder.

Parameters

[in]

enc

A pointer to the H.264 encoder instance

Returns

• ESP_H264_ERR_OK Succeeded
• ESP_H264_ERR_ARG Invalid arguments passed
• ESP_H264_ERR_UNSUPPORTED Delete feature is not supported by the encoder

esp_h264_enc_open()

esp_h264_err_t esp_h264_enc_open

(

esp_h264_enc_handle_t

enc

)

This function opens an H.264 encoder in single stream.

Parameters

[in]

enc

A pointer to the H.264 encoder instance

Returns

• ESP_H264_ERR_OK Succeeded
• ESP_H264_ERR_FAIL Failed
• ESP_H264_ERR_ARG Invalid arguments passed
• ESP_H264_ERR_UNSUPPORTED Open feature is not supported by the encoder

esp_h264_enc_process()

esp_h264_err_t esp_h264_enc_process	(	esp_h264_enc_handle_t	enc,
		esp_h264_enc_in_frame_t *	in_frame,
		esp_h264_enc_out_frame_t *	out_frame
	)

This function performs single encoding of H.264 video frames. To encode one image using an image encoder, the IDR frame will automatically add SPS and PPS NALU.

Note

The function will return ESP_H264_ERR_TIMEOUT if out_frame.raw_data.len is less than actual encoded data length using hardware encoder. If the width or height of image is not multi of 16, please do the follow operation. width = ((width +15) >> 4 << 4); height = ((height+15) >> 4 << 4); in_frame.raw_data.len = ( width * height + (width * height >> 1)); in_frame.raw_data.buffer = esp_h264_aligned_calloc(16, 1, in_frame.raw_data.len, &in_frame.raw_data.len, MALLOC_CAP_DEFAULT); The out_frame.raw_data.buffer should be allocated by the user for in_frame.raw_data.len bytes to avoid the encoded image size exceeding the out_frame.raw_data.buffer size. If the encoder image size is larger than out_frame.raw_data.buffer, it will result in ESP_H264_ERR_MEM.

Parameters

[in]	enc	A pointer to the H.264 encoder instance
[in]	in_frame	A pointer to unencoded input frame
	[in/out]	out_frame A pointer to encoded output frame

Returns

• ESP_H264_ERR_OK Succeeded
• ESP_H264_ERR_ARG Invalid arguments passed
• ESP_H264_ERR_MEM Insufficient memory
• ESP_H264_ERR_FAIL Failed
• ESP_H264_ERR_TIMEOUT Timeout
• ESP_H264_ERR_OVERFLOW The size of encoder image is greater than in_frame.raw_data.len
• ESP_H264_ERR_UNSUPPORTED Process feature is not supported by the encoder