omx_base_PortType Struct Reference

#include <omx_base_port.h>

Data Fields
OMX_HANDLETYPE	hTunneledComponent
OMX_U32	nTunnelFlags
OMX_U32	nTunneledPort
OMX_BUFFERSUPPLIERTYPE	eBufferSupplier
OMX_U32	nNumTunnelBuffer
tsem_t *	pAllocSem
OMX_U32	nNumBufferFlushed
OMX_BOOL	bIsPortFlushed
queue_t *	pBufferQueue
tsem_t *	pBufferSem
OMX_U32	nNumAssignedBuffers
OMX_PARAM_PORTDEFINITIONTYPE	sPortParam
OMX_BUFFERHEADERTYPE **	pInternalBufferStorage
BUFFER_STATUS_FLAG *	bBufferStateAllocated
OMX_COMPONENTTYPE *	standCompContainer
OMX_BOOL	bIsTransientToEnabled
OMX_BOOL	bIsTransientToDisabled
OMX_BOOL	bIsFullOfBuffers
OMX_BOOL	bIsEmptyOfBuffers
OMX_ERRORTYPE(*	PortConstructor )(OMX_COMPONENTTYPE *openmaxStandComp, omx_base_PortType **openmaxStandPort, OMX_U32 nPortIndex, OMX_BOOL isInput)
OMX_ERRORTYPE(*	PortDestructor )(omx_base_PortType *openmaxStandPort)
OMX_ERRORTYPE(*	Port_DisablePort )(omx_base_PortType *openmaxStandPort)
OMX_ERRORTYPE(*	Port_EnablePort )(omx_base_PortType *openmaxStandPort)
OMX_ERRORTYPE(*	Port_SendBufferFunction )(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	Port_AllocateBuffer )(omx_base_PortType *openmaxStandPort, OMX_INOUT OMX_BUFFERHEADERTYPE **pBuffer, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_PTR pAppPrivate, OMX_IN OMX_U32 nSizeBytes)
OMX_ERRORTYPE(*	Port_UseBuffer )(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, OMX_U32 nSizeBytes, OMX_U8 *pBuffer)
OMX_ERRORTYPE(*	Port_FreeBuffer )(omx_base_PortType *openmaxStandPort, OMX_U32 nPortIndex, OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	Port_AllocateTunnelBuffer )(omx_base_PortType *openmaxStandPort, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_U32 nSizeBytes)
OMX_ERRORTYPE(*	Port_FreeTunnelBuffer )(omx_base_PortType *openmaxStandPort, OMX_U32 nPortIndex)
OMX_ERRORTYPE(*	BufferProcessedCallback )(OMX_HANDLETYPE hComponent, OMX_PTR pAppData, OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	FlushProcessingBuffers )(omx_base_PortType *openmaxStandPort)
OMX_ERRORTYPE(*	ReturnBufferFunction )(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	ComponentTunnelRequest )(omx_base_PortType *openmaxStandPort, OMX_IN OMX_HANDLETYPE hTunneledComp, OMX_IN OMX_U32 nTunneledPort, OMX_INOUT OMX_TUNNELSETUPTYPE *pTunnelSetup)

---

Detailed Description

Definition at line 109 of file omx_base_port.h.

---

Field Documentation

OMX_HANDLETYPE omx_base_PortType::hTunneledComponent

Parameters:

hTunneledComponent

Handle to the tunnelled component

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateTunnelBuffer(), base_port_ComponentTunnelRequest(), base_port_FlushProcessingBuffers(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), videosrc_port_AllocateTunnelBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_U32 omx_base_PortType::nTunnelFlags

This field contains one or more tags that describe the tunnel status of the port

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateTunnelBuffer(), base_port_ComponentTunnelRequest(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), and videosrc_port_AllocateTunnelBuffer().

OMX_U32 omx_base_PortType::nTunneledPort

Parameters:

nTunneledPort

Tunneled port number

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateTunnelBuffer(), base_port_ComponentTunnelRequest(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), videosrc_port_AllocateTunnelBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_BUFFERSUPPLIERTYPE omx_base_PortType::eBufferSupplier

Parameters:

eBufferSupplier

the type of supplier in case of tunneling

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_ComponentTunnelRequest(), and omx_base_component_GetParameter().

OMX_U32 omx_base_PortType::nNumTunnelBuffer

Parameters:

nNumTunnelBuffer

Number of buffer to be tunnelled

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_ComponentTunnelRequest(), omx_base_component_DoStateSet(), and omx_base_component_MessageHandler().

tsem_t* omx_base_PortType::pAllocSem

Parameters:

pFlushSem

Semaphore that locks the execution until the buffers have been flushed, if needed

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_Destructor(), base_port_DisablePort(), base_port_EnablePort(), base_port_FreeBuffer(), base_port_UseBuffer(), videosrc_port_AllocateBuffer(), and videosrc_port_FreeBuffer().

OMX_U32 omx_base_PortType::nNumBufferFlushed

Parameters:

nNumBufferFlushed

Number of buffer Flushed

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_ReturnBufferFunction().

OMX_BOOL omx_base_PortType::bIsPortFlushed

Parameters:

bIsPortFlushed

Boolean variables indicate port is being flushed at the moment

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_FlushProcessingBuffers(), and omx_base_component_MessageHandler().

queue_t* omx_base_PortType::pBufferQueue

Parameters:

pBufferQueue

queue for buffer to be processed by the port

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateTunnelBuffer(), base_port_Destructor(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), omx_base_filter_BufferMgmtFunction(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), omx_base_source_twoport_BufferMgmtFunction(), videosrc_port_AllocateTunnelBuffer(), and videosrc_port_FreeTunnelBuffer().

tsem_t* omx_base_PortType::pBufferSem

Parameters:

pBufferSem

Semaphore for buffer queue access synchronization

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_Destructor(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), omx_base_component_DoStateSet(), omx_base_component_MessageHandler(), omx_base_filter_BufferMgmtFunction(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), omx_base_source_twoport_BufferMgmtFunction(), and videosrc_port_FreeTunnelBuffer().

OMX_U32 omx_base_PortType::nNumAssignedBuffers

Parameters:

nNumAssignedBuffers

Number of buffer assigned on each port

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_FlushProcessingBuffers(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_UseBuffer(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_PARAM_PORTDEFINITIONTYPE omx_base_PortType::sPortParam

Parameters:

sPortParam

General OpenMAX port parameter

Definition at line 144 of file omx_base_port.h.

Referenced by base_audio_port_Destructor(), base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_ComponentTunnelRequest(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), base_port_UseBuffer(), base_video_port_Destructor(), omx_base_component_DoStateSet(), omx_base_component_EmptyThisBuffer(), omx_base_component_FillThisBuffer(), omx_base_component_GetParameter(), omx_base_component_MessageHandler(), omx_base_component_SetParameter(), omx_video_colorconv_UseEGLImage(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_BUFFERHEADERTYPE** omx_base_PortType::pInternalBufferStorage

This array contains the reference to all the buffers hadled by this port and already registered

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_SendBufferFunction(), base_port_UseBuffer(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

BUFFER_STATUS_FLAG* omx_base_PortType::bBufferStateAllocated

Parameters:

bBufferStateAllocated

The State of the Buffer whether assigned or allocated

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_UseBuffer(), omx_base_component_SendCommand(), omx_base_component_SetParameter(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_COMPONENTTYPE* omx_base_PortType::standCompContainer

The OpenMAX component reference that contains this port

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), base_port_UseBuffer(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_BOOL omx_base_PortType::bIsTransientToEnabled

It indicates that the port is going from disabled to enabled

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_EnablePort(), base_port_UseBuffer(), omx_base_component_SendCommand(), videosrc_port_AllocateBuffer(), and videosrc_port_AllocateTunnelBuffer().

OMX_BOOL omx_base_PortType::bIsTransientToDisabled

It indicates that the port is going from enabled to disabled

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_DisablePort(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), omx_base_component_SendCommand(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_BOOL omx_base_PortType::bIsFullOfBuffers

It indicates if the port has all the buffers needed

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_UseBuffer(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_BOOL omx_base_PortType::bIsEmptyOfBuffers

It indicates if the port has no buffers

Definition at line 144 of file omx_base_port.h.

Referenced by base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_UseBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_ERRORTYPE(* omx_base_PortType::PortConstructor)(OMX_COMPONENTTYPE *openmaxStandComp, omx_base_PortType **openmaxStandPort, OMX_U32 nPortIndex, OMX_BOOL isInput)

The contructor of the port. It fills all the other function pointers

OMX_ERRORTYPE(* omx_base_PortType::PortDestructor)(omx_base_PortType *openmaxStandPort)

The destructor of the port

OMX_ERRORTYPE(* omx_base_PortType::Port_DisablePort)(omx_base_PortType *openmaxStandPort)

Disables the port

Referenced by omx_base_component_MessageHandler().

OMX_ERRORTYPE(* omx_base_PortType::Port_EnablePort)(omx_base_PortType *openmaxStandPort)

Enables the port

Referenced by omx_base_component_MessageHandler().

OMX_ERRORTYPE(* omx_base_PortType::Port_SendBufferFunction)(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE *pBuffer)

Holds the EmptyThisBuffer of FillThisBuffer function, if the port is input or output

Referenced by omx_base_component_EmptyThisBuffer(), and omx_base_component_FillThisBuffer().

OMX_ERRORTYPE(* omx_base_PortType::Port_AllocateBuffer)(omx_base_PortType *openmaxStandPort, OMX_INOUT OMX_BUFFERHEADERTYPE **pBuffer, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_PTR pAppPrivate, OMX_IN OMX_U32 nSizeBytes)

Replaces the AllocateBuffer call for the base port.

Referenced by omx_base_component_AllocateBuffer().

OMX_ERRORTYPE(* omx_base_PortType::Port_UseBuffer)(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, OMX_U32 nSizeBytes, OMX_U8 *pBuffer)

The standard use buffer function applied to the port class

Referenced by omx_base_component_UseBuffer(), and omx_video_colorconv_UseEGLImage().

OMX_ERRORTYPE(* omx_base_PortType::Port_FreeBuffer)(omx_base_PortType *openmaxStandPort, OMX_U32 nPortIndex, OMX_BUFFERHEADERTYPE *pBuffer)

The standard free buffer function applied to the port class

Referenced by omx_base_component_FreeBuffer().

OMX_ERRORTYPE(* omx_base_PortType::Port_AllocateTunnelBuffer)(omx_base_PortType *openmaxStandPort, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_U32 nSizeBytes)

AllocateTunnelBuffer call for the base port.

Referenced by base_port_EnablePort().

OMX_ERRORTYPE(* omx_base_PortType::Port_FreeTunnelBuffer)(omx_base_PortType *openmaxStandPort, OMX_U32 nPortIndex)

The free buffer function used to free tunnelled buffers

Referenced by base_port_DisablePort().

OMX_ERRORTYPE(* omx_base_PortType::BufferProcessedCallback)(OMX_HANDLETYPE hComponent, OMX_PTR pAppData, OMX_BUFFERHEADERTYPE *pBuffer)

Holds the EmptyBufferDone or FillBufferDone callback, if the port is input or output port

Referenced by base_port_FlushProcessingBuffers(), base_port_ReturnBufferFunction(), and omx_base_component_SetCallbacks().

OMX_ERRORTYPE(* omx_base_PortType::FlushProcessingBuffers)(omx_base_PortType *openmaxStandPort)

release all the buffers currently under processing

Referenced by omx_base_component_DoStateSet(), and omx_base_component_MessageHandler().

OMX_ERRORTYPE(* omx_base_PortType::ReturnBufferFunction)(omx_base_PortType *openmaxStandPort, OMX_BUFFERHEADERTYPE *pBuffer)

Call appropriate function to return buffers to peer or IL Client

Referenced by omx_base_filter_BufferMgmtFunction(), omx_base_sink_BufferMgmtFunction(), omx_base_source_BufferMgmtFunction(), and omx_base_source_twoport_BufferMgmtFunction().

OMX_ERRORTYPE(* omx_base_PortType::ComponentTunnelRequest)(omx_base_PortType *openmaxStandPort, OMX_IN OMX_HANDLETYPE hTunneledComp, OMX_IN OMX_U32 nTunneledPort, OMX_INOUT OMX_TUNNELSETUPTYPE *pTunnelSetup)

Setup tunnel with the port

Referenced by omx_base_component_ComponentTunnelRequest().

---

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

• omx_base_port.h