esp_h264_dec.h File Reference

#include "esp_h264_types.h"

Include dependency graph for esp_h264_dec.h:

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

Go to the source code of this file.

Classes
struct	esp_h264_dec_cfg_t
	Decoder configure information. More...
struct	esp_h264_dec_if
	The H.264 stream decoder interface. More...

Typedefs
typedef struct esp_h264_dec_if *	esp_h264_dec_handle_t
	H.264 stream decoder handle.
typedef struct esp_h264_dec_if	esp_h264_dec_t
	The H.264 stream decoder interface.

Functions
esp_h264_err_t	esp_h264_dec_open (esp_h264_dec_handle_t dec)
	This function opens an H.264 decoder in stream.
esp_h264_err_t	esp_h264_dec_process (esp_h264_dec_handle_t dec, esp_h264_dec_in_frame_t *in_frame, esp_h264_dec_out_frame_t *out_frame)
	This function performs decoding of H.264 video frames.
esp_h264_err_t	esp_h264_dec_close (esp_h264_dec_handle_t dec)
	This function closes the H.264 decoder instance specified by dec
esp_h264_err_t	esp_h264_dec_del (esp_h264_dec_handle_t dec)
	This function is used to delete an H.264 decoder.

Typedef Documentation

esp_h264_dec_handle_t

typedef struct esp_h264_dec_if* esp_h264_dec_handle_t

H.264 stream decoder handle.

esp_h264_dec_t

typedef struct esp_h264_dec_if esp_h264_dec_t

The H.264 stream decoder interface.

Function Documentation

esp_h264_dec_close()

esp_h264_err_t esp_h264_dec_close

(

esp_h264_dec_handle_t

dec

)

This function closes the H.264 decoder instance specified by dec

Parameters

[in]

dec

A pointer to the H.264 decoder 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 decoder

esp_h264_dec_del()

esp_h264_err_t esp_h264_dec_del

(

esp_h264_dec_handle_t

dec

)

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

Parameters

[in]

dec

A pointer to the H.264 decoder 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 decoder

esp_h264_dec_open()

esp_h264_err_t esp_h264_dec_open

(

esp_h264_dec_handle_t

dec

)

This function opens an H.264 decoder in stream.

Parameters

[in]

dec

A pointer to the H.264 decoder 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 decoder

esp_h264_dec_process()

esp_h264_err_t esp_h264_dec_process	(	esp_h264_dec_handle_t	dec,
		esp_h264_dec_in_frame_t *	in_frame,
		esp_h264_dec_out_frame_t *	out_frame
	)

This function performs decoding of H.264 video frames.

Parameters

[in]	dec	A pointer to the H.264 decoder instance
[in]	in_frame	A pointer to encoded input frame
	[in/out]	out_frame A pointer to store decoded output frame. The out_frame->outbuf will store an image data address after decoding. This address will be re-used in esp_h264_dec_process. Users, ensure to retrieve the data in the address promptly. If the NALU is not related to image data like SPS, PPS, etc., out_frame->out_size will return 0.

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_UNSUPPORTED Process feature is not supported by the decoder