mpf_engine.h File Reference

Media Processing Framework Engine. More...

#include "apt_task.h"
#include "mpf_message.h"

Include dependency graph for mpf_engine.h:

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

Go to the source code of this file.

Functions
mpf_engine_t *	mpf_engine_create (const char *id, apr_pool_t *pool)
mpf_codec_manager_t *	mpf_engine_codec_manager_create (apr_pool_t *pool)
apt_bool_t	mpf_engine_codec_manager_register (mpf_engine_t *engine, const mpf_codec_manager_t *codec_manager)
mpf_context_t *	mpf_engine_context_create (mpf_engine_t *engine, const char *name, void *obj, apr_size_t max_termination_count, apr_pool_t *pool)
apt_bool_t	mpf_engine_context_destroy (mpf_context_t *context)
void *	mpf_engine_context_object_get (const mpf_context_t *context)
apt_task_t *	mpf_task_get (const mpf_engine_t *engine)
void	mpf_engine_task_msg_type_set (mpf_engine_t *engine, apt_task_msg_type_e type)
apt_bool_t	mpf_engine_termination_message_add (mpf_engine_t *engine, mpf_command_type_e command_id, mpf_context_t *context, mpf_termination_t *termination, void *descriptor, mpf_task_msg_t **task_msg)
apt_bool_t	mpf_engine_assoc_message_add (mpf_engine_t *engine, mpf_command_type_e command_id, mpf_context_t *context, mpf_termination_t *termination, mpf_termination_t *assoc_termination, mpf_task_msg_t **task_msg)
apt_bool_t	mpf_engine_topology_message_add (mpf_engine_t *engine, mpf_command_type_e command_id, mpf_context_t *context, mpf_task_msg_t **task_msg)
apt_bool_t	mpf_engine_message_send (mpf_engine_t *engine, mpf_task_msg_t **task_msg)
apt_bool_t	mpf_engine_scheduler_rate_set (mpf_engine_t *engine, unsigned long rate)
const char *	mpf_engine_id_get (const mpf_engine_t *engine)

Variables
APT_BEGIN_EXTERN_C typedef apt_task_msg_t	mpf_task_msg_t

Detailed Description

Media Processing Framework Engine.

Factory of Media Processing Engines.

Function Documentation

mpf_engine_assoc_message_add()

apt_bool_t mpf_engine_assoc_message_add	(	mpf_engine_t *	engine,
		mpf_command_type_e	command_id,
		mpf_context_t *	context,
		mpf_termination_t *	termination,
		mpf_termination_t *	assoc_termination,
		mpf_task_msg_t **	task_msg
	)

Create task message(if not created) and add MPF association message to it.

Parameters

engine	the engine task message belongs to
command_id	the MPF command identifier
context	the context to add association of terminations for
termination	the termination to associate
assoc_termination	the termination to associate
task_msg	the task message to create and add constructed MPF message to

mpf_engine_codec_manager_create()

mpf_codec_manager_t* mpf_engine_codec_manager_create

(

apr_pool_t *

pool

)

Create MPF codec manager.

Parameters

pool	the pool to allocate memory from

mpf_engine_codec_manager_register()

apt_bool_t mpf_engine_codec_manager_register	(	mpf_engine_t *	engine,
		const mpf_codec_manager_t *	codec_manager
	)

Register MPF codec manager.

Parameters

engine	the engine to register codec manager for
codec_manager	the codec manager to register

mpf_engine_context_create()

mpf_context_t* mpf_engine_context_create	(	mpf_engine_t *	engine,
		const char *	name,
		void *	obj,
		apr_size_t	max_termination_count,
		apr_pool_t *	pool
	)

Create MPF context.

Parameters

engine	the engine to create context for
name	the informative name of the context
obj	the external object associated with context
max_termination_count	the max number of terminations in context
pool	the pool to allocate memory from

mpf_engine_context_destroy()

apt_bool_t mpf_engine_context_destroy

(

mpf_context_t *

context

)

Destroy MPF context.

Parameters

context

the context to destroy

mpf_engine_context_object_get()

void* mpf_engine_context_object_get

(

const mpf_context_t *

context

)

Get external object associated with MPF context.

Parameters

context

the context to get object from

mpf_engine_create()

mpf_engine_t* mpf_engine_create	(	const char *	id,
		apr_pool_t *	pool
	)

Create MPF engine.

Parameters

id	the identifier of the engine
pool	the pool to allocate memory from

mpf_engine_id_get()

const char* mpf_engine_id_get

(

const mpf_engine_t *

engine

)

Get the identifier of the engine .

Parameters

engine

the engine to get name of

mpf_engine_message_send()

apt_bool_t mpf_engine_message_send	(	mpf_engine_t *	engine,
		mpf_task_msg_t **	task_msg
	)

Send MPF task message.

Parameters

engine	the engine to send task message to
task_msg	the task message to send

mpf_engine_scheduler_rate_set()

apt_bool_t mpf_engine_scheduler_rate_set	(	mpf_engine_t *	engine,
		unsigned long	rate
	)

Set scheduler rate.

Parameters

engine	the engine to set rate for
rate	the rate (n times faster than real-time)

mpf_engine_task_msg_type_set()

void mpf_engine_task_msg_type_set	(	mpf_engine_t *	engine,
		apt_task_msg_type_e	type
	)

Set task msg type to send responses and events with.

Parameters

engine	the engine to set task msg type for
type	the type to set

mpf_engine_termination_message_add()

apt_bool_t mpf_engine_termination_message_add	(	mpf_engine_t *	engine,
		mpf_command_type_e	command_id,
		mpf_context_t *	context,
		mpf_termination_t *	termination,
		void *	descriptor,
		mpf_task_msg_t **	task_msg
	)

Create task message(if not created) and add MPF termination message to it.

Parameters

engine	the engine task message belongs to
command_id	the MPF command identifier
context	the context to add termination to
termination	the termination to add
descriptor	the termination dependent descriptor
task_msg	the task message to create and add constructed MPF message to

mpf_engine_topology_message_add()

apt_bool_t mpf_engine_topology_message_add	(	mpf_engine_t *	engine,
		mpf_command_type_e	command_id,
		mpf_context_t *	context,
		mpf_task_msg_t **	task_msg
	)

Create task message(if not created) and add MPF topology message to it.

Parameters

engine	the engine task message belongs to
command_id	the MPF command identifier
context	the context to modify topology for
task_msg	the task message to create and add constructed MPF message to

mpf_task_get()

apt_task_t* mpf_task_get

(

const mpf_engine_t *

engine

)

Get task.

Parameters

engine

the engine to get task from

Variable Documentation

mpf_task_msg_t

APT_BEGIN_EXTERN_C typedef apt_task_msg_t mpf_task_msg_t

MPF task message definition