omx_base_component_PrivateType Struct Reference

#include <omx_base_component.h>


Data Fields

OMX_COMPONENTTYPEopenmaxStandComp
omx_base_PortType ** ports
OMX_PORT_PARAM_TYPE sPortTypesParam [4]
char uniqueID
char * name
OMX_STATETYPE state
OMX_TRANS_STATETYPE transientState
OMX_CALLBACKTYPEcallbacks
OMX_PTR callbackData
queue_tmessageQueue
tsem_tmessageSem
OMX_U32 nGroupPriority
OMX_U32 nGroupID
OMX_MARKTYPEpMark
pthread_mutex_t flush_mutex
pthread_cond_t flush_all_condition
pthread_cond_t flush_condition
tsem_tbMgmtSem
tsem_tbStateSem
int messageHandlerThreadID
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)


Detailed Description

Definition at line 108 of file omx_base_component.h.


Field Documentation

OMX_COMPONENTTYPE* omx_base_component_PrivateType::openmaxStandComp

Component Destructor The OpenMAX standard data structure describing a component

Definition at line 138 of file omx_base_component.h.

Referenced by omx_base_component_Constructor().

omx_base_PortType** omx_base_component_PrivateType::ports

Definition at line 138 of file omx_base_component.h.

Referenced by omx_alsasink_component_port_SendBufferFunction(), 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(), omx_base_filter_BufferMgmtFunction(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), and omx_fbdev_sink_component_port_SendBufferFunction().

OMX_PORT_PARAM_TYPE omx_base_component_PrivateType::sPortTypesParam[4]

Parameters:
ports The ports of the component

Definition at line 138 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(), and omx_base_source_twoport_BufferMgmtFunction().

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 138 of file omx_base_component.h.

char* omx_base_component_PrivateType::name

component name

Definition at line 138 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_port_AllocateTunnelBuffer(), base_port_DisablePort(), base_port_FlushProcessingBuffers(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), base_port_UseBuffer(), omx_alsasink_component_port_SendBufferFunction(), 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_fbdev_sink_component_port_SendBufferFunction(), and videosrc_port_AllocateTunnelBuffer().

OMX_STATETYPE omx_base_component_PrivateType::state

The state of the component

Definition at line 138 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_alsasink_component_port_SendBufferFunction(), 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(), and omx_fbdev_sink_component_port_SendBufferFunction().

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 138 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_alsasink_component_port_SendBufferFunction(), omx_base_component_Constructor(), omx_base_component_DoStateSet(), omx_base_component_SendCommand(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), omx_fbdev_sink_component_port_SendBufferFunction(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_CALLBACKTYPE* omx_base_component_PrivateType::callbacks

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

Definition at line 142 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(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

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 143 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(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

queue_t* omx_base_component_PrivateType::messageQueue

the queue of all the messages recevied by the component

Definition at line 144 of file omx_base_component.h.

Referenced by 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 144 of file omx_base_component.h.

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

OMX_U32 omx_base_component_PrivateType::nGroupPriority

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

Definition at line 144 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::nGroupID

Parameters:
nGroupID ID of a group of components that share the same logical chain

Definition at line 144 of file omx_base_component.h.

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

OMX_MARKTYPE* omx_base_component_PrivateType::pMark

Parameters:
pMark This field holds the private data associated with a mark request, if any

Definition at line 144 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_MessageHandler().

pthread_mutex_t omx_base_component_PrivateType::flush_mutex

Definition at line 144 of file omx_base_component.h.

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

pthread_cond_t omx_base_component_PrivateType::flush_all_condition

Parameters:
flush_mutex mutex for the flush condition from buffers

Definition at line 144 of file omx_base_component.h.

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

pthread_cond_t omx_base_component_PrivateType::flush_condition

Parameters:
flush_all_condition condition for the flush all buffers

Definition at line 144 of file omx_base_component.h.

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

tsem_t* omx_base_component_PrivateType::bMgmtSem

Parameters:
The flush_condition condition
bMgmtSem the semaphore that control BufferMgmtFunction processing

Definition at line 144 of file omx_base_component.h.

Referenced by base_clock_port_SendBufferFunction(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_SendBufferFunction(), omx_alsasink_component_port_SendBufferFunction(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_component_MessageHandler(), and omx_fbdev_sink_component_port_SendBufferFunction().

tsem_t* omx_base_component_PrivateType::bStateSem

Parameters:
bMgmtSem the semaphore that control BufferMgmtFunction processing

Definition at line 144 of file omx_base_component.h.

Referenced by base_port_FlushProcessingBuffers(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_filter_BufferMgmtFunction(), and omx_base_source_twoport_BufferMgmtFunction().

int omx_base_component_PrivateType::messageHandlerThreadID

Definition at line 144 of file omx_base_component.h.

Referenced by omx_base_component_Constructor().

pthread_t omx_base_component_PrivateType::messageHandlerThread

Parameters:
messageHandlerThreadID The ID of the pthread that handles the messages for the components

Definition at line 144 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_Destructor().

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 144 of file omx_base_component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_DoStateSet().

pthread_t omx_base_component_PrivateType::bufferMgmtThread

Parameters:
bufferMgmtThreadID The ID of the pthread that process buffers

Definition at line 144 of file omx_base_component.h.

Referenced by omx_base_component_DoStateSet().

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 144 of file omx_base_component.h.

Referenced by BOSA_ST_CreateComponent(), and BOSA_ST_DestroyComponent().

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

Referenced by omx_base_component_DoStateSet().

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

Parameters:
BufferMgmtFunction This function processes input output buffers

Referenced by compMessageHandlerFunction(), 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

Referenced by omx_base_component_Constructor(), and omx_base_component_MessageHandler().

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

Referenced by omx_base_component_ComponentDeInit(), and omx_base_component_Constructor().


The documentation for this struct was generated from the following file:
Generated for OpenMAX Bellagio rel. 0.9.0 by  doxygen 1.5.1
SourceForge.net Logo