muxers_settings.h File Reference

Multiplexers and de-multiplexers generic settings. More...

#include <libmediaprocsutils/mem_utils.h>

Include dependency graph for muxers_settings.h:

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

Go to the source code of this file.

Classes
struct	muxers_settings_mux_ctx_s
struct	muxers_settings_dmux_ctx_s

Typedefs
typedef struct log_ctx_s	log_ctx_t
typedef struct cJSON	cJSON
typedef struct muxers_settings_mux_ctx_s	muxers_settings_mux_ctx_t
typedef struct muxers_settings_dmux_ctx_s	muxers_settings_dmux_ctx_t

Functions
muxers_settings_mux_ctx_t *	muxers_settings_mux_ctx_allocate ()
void	muxers_settings_mux_ctx_release (muxers_settings_mux_ctx_t **ref_muxers_settings_mux_ctx)
int	muxers_settings_mux_ctx_init (volatile muxers_settings_mux_ctx_t *muxers_settings_mux_ctx)
void	muxers_settings_mux_ctx_deinit (volatile muxers_settings_mux_ctx_t *muxers_settings_mux_ctx)
int	muxers_settings_mux_ctx_cpy (const muxers_settings_mux_ctx_t *muxers_settings_mux_ctx_src, muxers_settings_mux_ctx_t *muxers_settings_mux_ctx_dst)
int	muxers_settings_mux_ctx_restful_put (volatile muxers_settings_mux_ctx_t *muxers_settings_mux_ctx, const char *str, log_ctx_t *log_ctx)
int	muxers_settings_mux_ctx_restful_get (volatile muxers_settings_mux_ctx_t *muxers_settings_mux_ctx, cJSON **ref_cjson_rest, log_ctx_t *log_ctx)
muxers_settings_dmux_ctx_t *	muxers_settings_dmux_ctx_allocate ()
void	muxers_settings_dmux_ctx_release (muxers_settings_dmux_ctx_t **ref_muxers_settings_dmux_ctx)
int	muxers_settings_dmux_ctx_init (volatile muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx)
void	muxers_settings_dmux_ctx_deinit (volatile muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx)
int	muxers_settings_dmux_ctx_cpy (const muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx_src, muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx_dst)
int	muxers_settings_dmux_ctx_restful_put (volatile muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx, const char *str, log_ctx_t *log_ctx)
int	muxers_settings_dmux_ctx_restful_get (volatile muxers_settings_dmux_ctx_t *muxers_settings_dmux_ctx, cJSON **ref_cjson_rest, log_ctx_t *log_ctx)

Detailed Description

Multiplexers and de-multiplexers generic settings.

Author

Rafael Antoniello

Definition in file muxers_settings.h.

Typedef Documentation

typedef struct muxers_settings_dmux_ctx_s muxers_settings_dmux_ctx_t

Generic de-multiplexer settings context structure. This structure may be extended by any specific implementation of a de-multiplexer.

typedef struct muxers_settings_mux_ctx_s muxers_settings_mux_ctx_t

Generic multiplexer settings context structure. This structure may be extended by any specific implementation of a multiplexer.

Function Documentation

muxers_settings_dmux_ctx_t* muxers_settings_dmux_ctx_allocate

(

)

Allocate generic de-multiplexer settings context structure.

Returns

Pointer to the generic de-multiplexer settings context structure.

Definition at line 273 of file muxers_settings.c.

int muxers_settings_dmux_ctx_cpy	(	const muxers_settings_dmux_ctx_t *	muxers_settings_dmux_ctx_src,
		muxers_settings_dmux_ctx_t *	muxers_settings_dmux_ctx_dst
	)

Copy de-multiplexer generic settings members, duplicating any existent heap allocation.

Parameters

muxers_settings_dmux_ctx_src	Pointer to the generic de-multiplexer settings context structure to be copied (namely, the source structure).
muxers_settings_dmux_ctx_dst	Pointer to the generic de-multiplexer settings context structure that holds the copy (namely, the destination structure).

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 327 of file muxers_settings.c.

void muxers_settings_dmux_ctx_deinit

(

volatile muxers_settings_dmux_ctx_t *

muxers_settings_dmux_ctx

)

De-initialize de-multiplexer generic settings. This function release any heap-allocated field or structure member.

Parameters

muxers_settings_dmux_ctx

Pointer to the generic de-multiplexer settings context structure to be de-initialized.

Definition at line 312 of file muxers_settings.c.

int muxers_settings_dmux_ctx_init

(

volatile muxers_settings_dmux_ctx_t *

muxers_settings_dmux_ctx

)

Initialize de-multiplexer generic settings to defaults.

Parameters

muxers_settings_dmux_ctx

Pointer to the generic de-multiplexer settings context structure to be initialized.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 299 of file muxers_settings.c.

void muxers_settings_dmux_ctx_release

(

muxers_settings_dmux_ctx_t **

ref_muxers_settings_dmux_ctx

)

Release generic de-multiplexer settings context structure previously allocated by 'muxers_settings_dmux_ctx_allocate()'.

Parameters

ref_muxers_settings_dmux_ctx

Definition at line 279 of file muxers_settings.c.

int muxers_settings_dmux_ctx_restful_get	(	volatile muxers_settings_dmux_ctx_t *	muxers_settings_dmux_ctx,
		cJSON **	ref_cjson_rest,
		log_ctx_t *	log_ctx
	)

Translate and get the de-multiplexer generic settings in a cJSON structure.

Parameters

muxers_settings_dmux_ctx	Pointer to the generic de-multiplexer settings context structure to be translated.
ref_cjson_rest	Reference to a pointer to a cJSON structure in which the translated settings are returned (by argument).
log_ctx	Externally defined LOG module context structure.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 421 of file muxers_settings.c.

int muxers_settings_dmux_ctx_restful_put	(	volatile muxers_settings_dmux_ctx_t *	muxers_settings_dmux_ctx,
		const char *	str,
		log_ctx_t *	log_ctx
	)

Put new settings passed by argument in query-string or JSON format.

Parameters

muxers_settings_dmux_ctx	Pointer to the generic de-multiplexer settings context structure to be modified.
str	New parameters passed in query-string or JSON format.
log_ctx	Externally defined LOG module context structure.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 349 of file muxers_settings.c.

muxers_settings_mux_ctx_t* muxers_settings_mux_ctx_allocate

(

)

Allocate generic multiplexer settings context structure.

Returns

Pointer to the generic multiplexer settings context structure.

Definition at line 38 of file muxers_settings.c.

int muxers_settings_mux_ctx_cpy	(	const muxers_settings_mux_ctx_t *	muxers_settings_mux_ctx_src,
		muxers_settings_mux_ctx_t *	muxers_settings_mux_ctx_dst
	)

Copy multiplexer generic settings members, duplicating any existent heap allocation.

Parameters

muxers_settings_mux_ctx_src	Pointer to the generic multiplexer settings context structure to be copied (namely, the source structure).
muxers_settings_mux_ctx_dst	Pointer to the generic multiplexer settings context structure that holds the copy (namely, the destination structure).

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 91 of file muxers_settings.c.

void muxers_settings_mux_ctx_deinit

(

volatile muxers_settings_mux_ctx_t *

muxers_settings_mux_ctx

)

De-initialize multiplexer generic settings. This function release any heap-allocated field or structure member.

Parameters

muxers_settings_mux_ctx

Pointer to the generic multiplexer settings context structure to be de-initialized.

Definition at line 76 of file muxers_settings.c.

int muxers_settings_mux_ctx_init

(

volatile muxers_settings_mux_ctx_t *

muxers_settings_mux_ctx

)

Initialize multiplexer generic settings to defaults.

Parameters

muxers_settings_mux_ctx

Pointer to the generic multiplexer settings context structure to be initialized.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 59 of file muxers_settings.c.

void muxers_settings_mux_ctx_release

(

muxers_settings_mux_ctx_t **

ref_muxers_settings_mux_ctx

)

Release generic multiplexer settings context structure previously allocated by 'muxers_settings_mux_ctx_allocate()'.

Parameters

ref_muxers_settings_mux_ctx

Definition at line 44 of file muxers_settings.c.

int muxers_settings_mux_ctx_restful_get	(	volatile muxers_settings_mux_ctx_t *	muxers_settings_mux_ctx,
		cJSON **	ref_cjson_rest,
		log_ctx_t *	log_ctx
	)

Translate and get the multiplexer generic settings in a cJSON structure.

Parameters

muxers_settings_mux_ctx	Pointer to the generic multiplexer settings context structure to be translated.
ref_cjson_rest	Reference to a pointer to a cJSON structure in which the translated settings are returned (by argument).
log_ctx	Externally defined LOG module context structure.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 221 of file muxers_settings.c.

int muxers_settings_mux_ctx_restful_put	(	volatile muxers_settings_mux_ctx_t *	muxers_settings_mux_ctx,
		const char *	str,
		log_ctx_t *	log_ctx
	)

Put new settings passed by argument in query-string or JSON format.

Parameters

muxers_settings_mux_ctx	Pointer to the generic multiplexer settings context structure to be modified.
str	New parameters passed in query-string or JSON format.
log_ctx	Externally defined LOG module context structure.

Returns

Status code (STAT_SUCCESS code in case of success, for other code values please refer to .stat_codes.h).

Definition at line 114 of file muxers_settings.c.