#include "esp_h264_enc_single.h"
#include "esp_h264_enc_param.h"

Include dependency graph for esp_h264_enc_single_sw.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef esp_h264_enc_param_handle_t	esp_h264_enc_param_sw_handle_t
	Handle type for software-based H.264 encoder parameters.

typedef esp_h264_enc_cfg_t	esp_h264_enc_cfg_sw_t
	Configuration type for software-based H.264 encoder.

Functions
esp_h264_err_t	esp_h264_enc_sw_new (const esp_h264_enc_cfg_sw_t cfg, esp_h264_enc_handle_t out_enc)
	This function is used to create a new instance of the `esp_h264_enc_t` data structure, which represents a single-streams H.264 encoder in software. The encoder is from openh264.

esp_h264_err_t	esp_h264_enc_sw_get_param_hd (esp_h264_enc_handle_t enc, esp_h264_enc_param_sw_handle_t *out_param)
	This function returns a pointer to the software-encoded parameter structure associated with the given `esp_h264_enc_t` encoder.

Typedef Documentation

◆ esp_h264_enc_cfg_sw_t

typedef esp_h264_enc_cfg_t esp_h264_enc_cfg_sw_t

Configuration type for software-based H.264 encoder.

◆ esp_h264_enc_param_sw_handle_t

typedef esp_h264_enc_param_handle_t esp_h264_enc_param_sw_handle_t

Handle type for software-based H.264 encoder parameters.

Function Documentation

◆ esp_h264_enc_sw_get_param_hd()

esp_h264_err_t esp_h264_enc_sw_get_param_hd	(	esp_h264_enc_handle_t	enc,
		esp_h264_enc_param_sw_handle_t *	out_param
	)

This function returns a pointer to the software-encoded parameter structure associated with the given esp_h264_enc_t encoder.

Parameters

[in]	enc	The encoder instance that is from `esp_h264_enc_hw_new`
[out]	out_param	The parameter set handle

Returns

ESP_H264_ERR_OK Succeeded
ESP_H264_ERR_ARG Invalid arguments passed

◆ esp_h264_enc_sw_new()

esp_h264_err_t esp_h264_enc_sw_new	(	const esp_h264_enc_cfg_sw_t *	cfg,
		esp_h264_enc_handle_t *	out_enc
	)

This function is used to create a new instance of the esp_h264_enc_t data structure, which represents a single-streams H.264 encoder in software. The encoder is from openh264.

Note: The group of picture(GOP) will be updated in intra frame

Parameters

[in]	cfg	It is a pointer to the `esp_h264_enc_cfg_sw_t` structure, which contains the configuration settings for the encoder
[out]	out_enc	It is a double pointer to the `esp_h264_enc_t` structure, which will store the created encoder instance

Returns

ESP_H264_ERR_OK Succeeded
ESP_H264_ERR_ARG Invalid arguments passed
ESP_H264_ERR_MEM Insufficient memory, the *enc will be set NULL

Create encoder handle

Create a new parameter handle

Encoder handle configure

Delete the encoder handle