rst.h File Reference

Application interface for the RST decoder and the RST generator. More...

Go to the source code of this file.

Data Structures
struct	dvbpsi_rst_event_s
	RST service description structure. More...
struct	dvbpsi_rst_s
	RST structure. More...
Typedefs
typedef struct dvbpsi_rst_event_s	dvbpsi_rst_event_t
	dvbpsi_rst_event_t type definition.
typedef struct dvbpsi_rst_s	dvbpsi_rst_t
	dvbpsi_rst_t type definition.
typedef void(*	dvbpsi_rst_callback )(void *p_cb_data, dvbpsi_rst_t *p_new_rst)
	Callback type definition.
Functions
bool	dvbpsi_rst_attach (dvbpsi_t *p_dvbpsi, dvbpsi_rst_callback pf_callback, void *p_cb_data)
	Creation and initialization of a RST decoder. It will be attached to p_dvbpsi.
void	dvbpsi_rst_detach (dvbpsi_t *p_dvbpsi)
	Destroy a RST decoder.
void	dvbpsi_rst_init (dvbpsi_rst_t *p_rst)
	Initialize a user-allocated dvbpsi_cat_t structure.
dvbpsi_rst_t *	dvbpsi_rst_new (void)
	Allocate and initialize a new dvbpsi_rst_t structure.
void	dvbpsi_rst_empty (dvbpsi_rst_t *p_rst)
	Clean a dvbpsi_rst_t structure.
void	dvbpsi_rst_delete (dvbpsi_rst_t *p_rst)
	Clean and free a dvbpsi_rst_t structure.
dvbpsi_rst_event_t *	dvbpsi_rst_event_add (dvbpsi_rst_t *p_rst, uint16_t i_ts_id, uint16_t i_orig_network_id, uint16_t i_service_id, uint16_t i_event_id, uint8_t i_running_status)
	Add an event in the RST.
dvbpsi_psi_section_t *	dvbpsi_rst_sections_generate (dvbpsi_t *p_dvbpsi, dvbpsi_rst_t *p_rst)
	RST generator.

---

Detailed Description

Application interface for the RST decoder and the RST generator.

>

Author:

Corno Roberto <corno.roberto@gmail.com> Application interface for the RST decoder and the RST generator. New decoded RST tables are sent by callback to the application.

---

Function Documentation

bool dvbpsi_rst_attach	(	dvbpsi_t *	p_dvbpsi,
		dvbpsi_rst_callback	pf_callback,
		void *	p_cb_data
	)

Creation and initialization of a RST decoder. It will be attached to p_dvbpsi.

Parameters:

p_dvbpsi	is a pointer to dvbpsi_t which holds a pointer to the decoder
pf_callback	function to call back on new RST
p_cb_data	private data given in argument to the callback

Returns:

true on success, false on failure

void dvbpsi_rst_delete

(

dvbpsi_rst_t *

p_rst

)

Clean and free a dvbpsi_rst_t structure.

Parameters:

p_rst

pointer to the RST structure

Returns:

nothing.

void dvbpsi_rst_detach

(

dvbpsi_t *

p_dvbpsi

)

Destroy a RST decoder.

Parameters:

p_dvbpsi	handle to dvbpsi with attached decoder
p_dvbpsi	handle holds the decoder pointer

Returns:

nothing.

The handle isn't valid any more.

void dvbpsi_rst_empty

(

dvbpsi_rst_t *

p_rst

)

Clean a dvbpsi_rst_t structure.

Parameters:

p_rst

pointer to the RST structure

Returns:

nothing.

dvbpsi_rst_event_t * dvbpsi_rst_event_add	(	dvbpsi_rst_t *	p_rst,
		uint16_t	i_ts_id,
		uint16_t	i_orig_network_id,
		uint16_t	i_service_id,
		uint16_t	i_event_id,
		uint8_t	i_running_status
	)

Add an event in the RST.

Parameters:

p_rst	pointer to the RST structure
i_ts_id	event's transport stream id
i_orig_network_id	event's original network id
i_service_id	event's service id
i_event_id	event's id
i_running_status	event's running status

Returns:

a pointer to the added event.

void dvbpsi_rst_init

(

dvbpsi_rst_t *

p_rst

)

Initialize a user-allocated dvbpsi_cat_t structure.

Parameters:

p_rst

pointer to the RST structure

Returns:

nothing.

dvbpsi_rst_t * dvbpsi_rst_new

(

void

)

Allocate and initialize a new dvbpsi_rst_t structure.

Returns:

p_rst pointer to the RST structure

dvbpsi_psi_section_t * dvbpsi_rst_sections_generate	(	dvbpsi_t *	p_dvbpsi,
		dvbpsi_rst_t *	p_rst
	)

RST generator.

Parameters:

p_dvbpsi	handle to dvbpsi with attached decoder
p_rst	RST structure

Returns:

a pointer to the list of generated PSI sections.

Generate RST sections based on the dvbpsi_rst_t structure.