omx_base_port.h

Go to the documentation of this file.

#include "tsemaphore.h"
#include "queue.h"
#include "omx_classmagic.h"

#ifndef __OMX_BASE_PORT_H__
#define __OMX_BASE_PORT_H__

#define TUNNEL_USE_BUFFER_RETRY 20
#define TUNNEL_USE_BUFFER_RETRY_USLEEP_TIME 50000

#define PORT_IS_BEING_FLUSHED(pPort)                             (pPort->bIsPortFlushed == OMX_TRUE)
#define PORT_IS_BEING_DISABLED(pPort)                            (pPort->bIsTransientToDisabled == OMX_TRUE)
#define PORT_IS_ENABLED(pPort)                                   (pPort->sPortParam.bEnabled == OMX_TRUE)
#define PORT_IS_POPULATED(pPort)                                 (pPort->sPortParam.bPopulated == OMX_TRUE)
#define PORT_IS_TUNNELED(pPort)                                  (pPort->nTunnelFlags & TUNNEL_ESTABLISHED)
#define PORT_IS_DEEP_TUNNELED(pPort)                             (pPort->nTunnelFlags & PROPRIETARY_COMMUNICATION_ESTABLISHED)
#define PORT_IS_BUFFER_SUPPLIER(pPort)                           (pPort->nTunnelFlags & TUNNEL_IS_SUPPLIER)
#define PORT_IS_TUNNELED_N_BUFFER_SUPPLIER(pPort)                ((pPort->nTunnelFlags & TUNNEL_ESTABLISHED) && (pPort->nTunnelFlags & TUNNEL_IS_SUPPLIER))

typedef enum BUFFER_STATUS_FLAG {
  BUFFER_FREE = 0,
  BUFFER_ALLOCATED = 0x0001,  
  BUFFER_ASSIGNED = 0x0002, 
  HEADER_ALLOCATED = 0x0004 
  } BUFFER_STATUS_FLAG;

typedef enum TUNNEL_STATUS_FLAG {
  NO_TUNNEL = 0, 
  TUNNEL_ESTABLISHED = 0x0001, 
  TUNNEL_IS_SUPPLIER = 0x0002, 
  PROPRIETARY_COMMUNICATION_ESTABLISHED = 0x0004 
} TUNNEL_STATUS_FLAG;


CLASS(omx_base_PortType)
#define omx_base_PortType_FIELDS \
  OMX_HANDLETYPE hTunneledComponent; \
  OMX_U32 nTunnelFlags; \
  OMX_U32 nTunneledPort;  \
  OMX_BUFFERSUPPLIERTYPE eBufferSupplier; \
  OMX_U32 nNumTunnelBuffer; \
  tsem_t* pAllocSem;  \
  pthread_mutex_t exitMutex;  \
  OMX_BOOL bIsDestroying;  \
  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_BUFFERHEADERTYPE** pBuffer, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, 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_U32 nPortIndex);   \
  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_HANDLETYPE hTunneledComp, OMX_U32 nTunneledPort, OMX_TUNNELSETUPTYPE* pTunnelSetup); 
ENDCLASS(omx_base_PortType)

OMX_ERRORTYPE base_port_Constructor(OMX_COMPONENTTYPE *openmaxStandComp,omx_base_PortType **openmaxStandPort,OMX_U32 nPortIndex, OMX_BOOL isInput);

OMX_ERRORTYPE base_port_Destructor(omx_base_PortType *openmaxStandPort);

OMX_ERRORTYPE base_port_DisablePort(omx_base_PortType *openmaxStandPort);

OMX_ERRORTYPE base_port_EnablePort(omx_base_PortType *openmaxStandPort);

OMX_ERRORTYPE base_port_SendBufferFunction(
  omx_base_PortType *openmaxStandPort,
  OMX_BUFFERHEADERTYPE* pBuffer);

OMX_ERRORTYPE base_port_AllocateBuffer(
  omx_base_PortType *openmaxStandPort,
  OMX_BUFFERHEADERTYPE** pBuffer,
  OMX_U32 nPortIndex,
  OMX_PTR pAppPrivate,
  OMX_U32 nSizeBytes);

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

OMX_ERRORTYPE base_port_FreeBuffer(
  omx_base_PortType *openmaxStandPort,
  OMX_U32 nPortIndex,
  OMX_BUFFERHEADERTYPE* pBuffer);

OMX_ERRORTYPE base_port_FlushProcessingBuffers(omx_base_PortType *openmaxStandPort);

OMX_ERRORTYPE base_port_ReturnBufferFunction(
  omx_base_PortType* openmaxStandPort,
  OMX_BUFFERHEADERTYPE* pBuffer);

OMX_ERRORTYPE base_port_ComponentTunnelRequest(
  omx_base_PortType* openmaxStandPort,
  OMX_HANDLETYPE hTunneledComp,
  OMX_U32 nTunneledPort,
  OMX_TUNNELSETUPTYPE* pTunnelSetup);

OMX_ERRORTYPE base_port_AllocateTunnelBuffer(
  omx_base_PortType *openmaxStandPort,
  OMX_U32 nPortIndex);

OMX_ERRORTYPE base_port_FreeTunnelBuffer(
  omx_base_PortType *openmaxStandPort,
  OMX_U32 nPortIndex);


#endif