omx_base_component_PrivateType Struct Reference

#include <omx_base_component.h>

Data Fields
OMX_COMPONENTTYPE *	openmaxStandComp
omx_base_PortType **	ports
OMX_PORT_PARAM_TYPE	sPortTypesParam [4]
char	uniqueID
char *	name
OMX_STATETYPE	state
OMX_TRANS_STATETYPE	transientState
OMX_CALLBACKTYPE *	callbacks
OMX_PTR	callbackData
queue_t *	messageQueue
tsem_t *	messageSem
OMX_U32	nGroupPriority
OMX_U32	nGroupID
OMX_PARAM_BELLAGIOTHREADS_ID *	bellagioThreads
OMX_BOOL	bIsEOSReached
OMX_MARKTYPE	pMark
pthread_mutex_t	flush_mutex
tsem_t *	flush_all_condition
tsem_t *	flush_condition
tsem_t *	bMgmtSem
tsem_t *	bStateSem
pthread_t	messageHandlerThread
int	bufferMgmtThreadID
pthread_t	bufferMgmtThread
void *	loader
void *(*	BufferMgmtFunction )(void *param)
OMX_ERRORTYPE(*	messageHandler )(OMX_COMPONENTTYPE *, internalRequestMessageType *)
OMX_ERRORTYPE(*	DoStateSet )(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32)
OMX_ERRORTYPE(*	destructor )(OMX_COMPONENTTYPE *openmaxStandComp)
OMX_ERRORTYPE(*	getQualityLevel )(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 *pQualityLevel)
OMX_ERRORTYPE(*	setQualityLevel )(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 nQualityLevel)
OMX_U32	nqualitylevels
multiResourceDescriptor **	multiResourceLevel
int	currentQualityLevel

---

Detailed Description

Definition at line 122 of file omx_base_component.h.

---

Field Documentation

OMX_PARAM_BELLAGIOTHREADS_ID* omx_base_component_PrivateType::bellagioThreads

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), compMessageHandlerFunction(), omx_base_component_Constructor(), and omx_base_component_GetParameter().

OMX_BOOL omx_base_component_PrivateType::bIsEOSReached

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_DoStateSet().

tsem_t* omx_base_component_PrivateType::bMgmtSem

Parameters:

The	flush_condition condition
bMgmtSem	the semaphore that control BufferMgmtFunction processing

Definition at line 158 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_constructor_remove_garbage_collected(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_SendBufferFunction(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_component_MessageHandler(), omx_video_scheduler_component_port_FlushProcessingBuffers(), and omx_video_scheduler_component_port_SendBufferFunction().

tsem_t* omx_base_component_PrivateType::bStateSem

Parameters:

bMgmtSem

the semaphore that control BufferMgmtFunction processing

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), base_port_FlushProcessingBuffers(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_sink_twoport_BufferMgmtFunction(), omx_base_source_twoport_BufferMgmtFunction(), and omx_video_scheduler_component_port_FlushProcessingBuffers().

void*(* omx_base_component_PrivateType::BufferMgmtFunction)(void *param)

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_DoStateSet().

pthread_t omx_base_component_PrivateType::bufferMgmtThread

Parameters:

bufferMgmtThreadID

The ID of the pthread that process buffers

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_DoStateSet().

int omx_base_component_PrivateType::bufferMgmtThreadID

Parameters:

messageHandlerThread

This field contains the reference to the thread that receives messages for the components

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_DoStateSet().

OMX_PTR omx_base_component_PrivateType::callbackData

Private data that can be send with \ the client callbacks. Not specified by the standard

Definition at line 158 of file omx_base_component.h.

Referenced by base_port_FlushProcessingBuffers(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), omx_base_component_Constructor(), omx_base_component_MessageHandler(), omx_base_component_SetCallbacks(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), omx_video_scheduler_component_port_FlushProcessingBuffers(), and preemptComponent().

OMX_CALLBACKTYPE* omx_base_component_PrivateType::callbacks

pointer to every client callback function, \ as specified by the standard

Definition at line 158 of file omx_base_component.h.

Referenced by base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_MessageHandler(), omx_base_component_SetCallbacks(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), and preemptComponent().

int omx_base_component_PrivateType::currentQualityLevel

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), omx_base_getQualityLevel(), and omx_base_setQualityLevel().

OMX_ERRORTYPE(* omx_base_component_PrivateType::destructor)(OMX_COMPONENTTYPE *openmaxStandComp)

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_ComponentDeInit(), and omx_base_component_Constructor().

OMX_ERRORTYPE(* omx_base_component_PrivateType::DoStateSet)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32)

This function receives messages from the message queue. It is needed for each Linux ST OpenMAX component

Parameters:

DoStateSet

internal function called when a generic state transition is requested

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_MessageHandler().

tsem_t* omx_base_component_PrivateType::flush_all_condition

Parameters:

flush_mutex

mutex for the flush condition from buffers

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), base_port_FlushProcessingBuffers(), omx_base_component_Constructor(), omx_base_component_Destructor(), and omx_video_scheduler_component_port_FlushProcessingBuffers().

tsem_t* omx_base_component_PrivateType::flush_condition

Parameters:

flush_all_condition

condition for the flush all buffers

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), base_port_FlushProcessingBuffers(), omx_base_component_Constructor(), omx_base_component_Destructor(), and omx_video_scheduler_component_port_FlushProcessingBuffers().

pthread_mutex_t omx_base_component_PrivateType::flush_mutex

Definition at line 158 of file omx_base_component.h.

Referenced by base_port_FlushProcessingBuffers(), omx_base_component_Constructor(), omx_base_component_Destructor(), and omx_video_scheduler_component_port_FlushProcessingBuffers().

OMX_ERRORTYPE(* omx_base_component_PrivateType::getQualityLevel)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 *pQualityLevel)

Component Destructor

Definition at line 158 of file omx_base_component.h.

Referenced by getQualityLevel(), and omx_base_component_Constructor().

void* omx_base_component_PrivateType::loader

Parameters:

bufferMgmtThread

This field contains the reference to the thread that process buffers pointer to the loader that created this component, used for destruction

Definition at line 158 of file omx_base_component.h.

Referenced by BOSA_ST_CreateComponent(), BOSA_ST_DestroyComponent(), BOSA_STE_CreateComponent(), and BOSA_STE_DestroyComponent().

OMX_ERRORTYPE(* omx_base_component_PrivateType::messageHandler)(OMX_COMPONENTTYPE *, internalRequestMessageType *)

Parameters:

BufferMgmtFunction

This function processes input output buffers

Definition at line 158 of file omx_base_component.h.

Referenced by compMessageHandlerFunction(), and omx_base_component_Constructor().

pthread_t omx_base_component_PrivateType::messageHandlerThread

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_Destructor().

queue_t* omx_base_component_PrivateType::messageQueue

the queue of all the messages recevied by the component

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), compMessageHandlerFunction(), omx_base_component_Constructor(), omx_base_component_Destructor(), and omx_base_component_SendCommand().

tsem_t* omx_base_component_PrivateType::messageSem

the semaphore that coordinates the access to the message queue

Definition at line 158 of file omx_base_component.h.

Referenced by base_constructor_remove_garbage_collected(), compMessageHandlerFunction(), omx_base_component_Constructor(), omx_base_component_Destructor(), and omx_base_component_SendCommand().

multiResourceDescriptor** omx_base_component_PrivateType::multiResourceLevel

Definition at line 158 of file omx_base_component.h.

char* omx_base_component_PrivateType::name

component name

Definition at line 158 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_constructor_remove_garbage_collected(), base_port_AllocateTunnelBuffer(), base_port_DisablePort(), base_port_FlushProcessingBuffers(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), base_port_UseBuffer(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_component_EmptyThisBuffer(), omx_base_component_FillThisBuffer(), omx_base_component_GetComponentVersion(), omx_base_component_MessageHandler(), omx_video_scheduler_component_port_FlushProcessingBuffers(), omx_video_scheduler_component_port_SendBufferFunction(), RM_getResource(), RM_printList(), RM_releaseResource(), RM_removeFromWaitForResource(), and RM_waitForResource().

OMX_U32 omx_base_component_PrivateType::nGroupID

Parameters:

nGroupID

ID of a group of components that share the same logical chain

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), omx_base_component_GetParameter(), and omx_base_component_SetParameter().

OMX_U32 omx_base_component_PrivateType::nGroupPriority

Parameters:

nGroupPriority

Resource management field: component priority (common to a group of components)

Definition at line 158 of file omx_base_component.h.

Referenced by addElemToList(), omx_base_component_Constructor(), omx_base_component_GetParameter(), omx_base_component_SetParameter(), and RM_getResource().

OMX_U32 omx_base_component_PrivateType::nqualitylevels

RM entry point. By default is not implemented number of available quality levels

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_setQualityLevel().

OMX_COMPONENTTYPE* omx_base_component_PrivateType::openmaxStandComp

if supported the current quality level set for this component The OpenMAX standard data structure describing a component

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor().

OMX_MARKTYPE omx_base_component_PrivateType::pMark

Parameters:

bIsEOSReached	boolean flag is true when EOS has been reached
pMark	This field holds the private data associated with a mark request, if any

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_MessageHandler().

omx_base_PortType** omx_base_component_PrivateType::ports

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_AllocateBuffer(), omx_base_component_ComponentTunnelRequest(), omx_base_component_DoStateSet(), omx_base_component_EmptyThisBuffer(), omx_base_component_FillThisBuffer(), omx_base_component_FreeBuffer(), omx_base_component_GetParameter(), omx_base_component_MessageHandler(), omx_base_component_ParameterSanityCheck(), omx_base_component_SendCommand(), omx_base_component_SetCallbacks(), omx_base_component_SetParameter(), omx_base_component_UseBuffer(), and omx_video_scheduler_component_port_SendBufferFunction().

OMX_ERRORTYPE(* omx_base_component_PrivateType::setQualityLevel)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 nQualityLevel)

RM entry point. By default is not implemented

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and setQualityLevel().

OMX_PORT_PARAM_TYPE omx_base_component_PrivateType::sPortTypesParam[4]

Parameters:

ports

The ports of the component

Definition at line 158 of file omx_base_component.h.

Referenced by omx_base_component_AllocateBuffer(), omx_base_component_ComponentTunnelRequest(), omx_base_component_Constructor(), omx_base_component_DoStateSet(), omx_base_component_EmptyThisBuffer(), omx_base_component_FillThisBuffer(), omx_base_component_FreeBuffer(), omx_base_component_GetParameter(), omx_base_component_MessageHandler(), omx_base_component_ParameterSanityCheck(), omx_base_component_SendCommand(), omx_base_component_SetCallbacks(), omx_base_component_SetParameter(), omx_base_component_UseBuffer(), omx_base_sink_twoport_BufferMgmtFunction(), and omx_base_source_twoport_BufferMgmtFunction().

OMX_STATETYPE omx_base_component_PrivateType::state

The state of the component

Definition at line 158 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_SendBufferFunction(), compMessageHandlerFunction(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_component_GetState(), omx_base_component_MessageHandler(), omx_base_component_ParameterSanityCheck(), omx_base_component_SendCommand(), omx_base_component_SetParameter(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), omx_video_scheduler_component_port_FlushProcessingBuffers(), omx_video_scheduler_component_port_SendBufferFunction(), and preemptComponent().

OMX_TRANS_STATETYPE omx_base_component_PrivateType::transientState

The transient state in case of transition between \ Loaded/waitForResources - Idle. It is equal to \ Invalid if the state or transition are not corect \ Loaded when the transition is from Idle to Loaded \ Idle when the transition is from Loaded to Idle

Definition at line 158 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_SendBufferFunction(), base_port_UseBuffer(), omx_base_component_Constructor(), omx_base_component_DoStateSet(), omx_base_component_SendCommand(), omx_base_sink_BufferMgmtFunction(), omx_base_sink_twoport_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), and omx_video_scheduler_component_port_SendBufferFunction().

char omx_base_component_PrivateType::uniqueID

Parameters:

sPortTypesParam

OpenMAX standard parameter that contains a short description of the available ports ID code that identifies an ST static component

Definition at line 158 of file omx_base_component.h.

---

The documentation for this struct was generated from the following file:

• omx_base_component.h