OpenMAXBellagio  0.9.3
omx_base_component.h
Go to the documentation of this file.
1 
26 #ifndef _OMX_BASE_COMPONENT_H_
27 #define _OMX_BASE_COMPONENT_H_
28 
29 #include <stdlib.h>
30 #include <pthread.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include <unistd.h>
34 #include <errno.h>
35 #include <asm/unistd.h>
36 
37 #ifdef ANDROID_COMPILATION
38 #include <oscl_base_macros.h>
39 #else
40 #define OSCL_IMPORT_REF
41 #define OSCL_EXPORT_REF
42 #endif
43 #include "omxcore.h"
44 #include "OMXComponentRMExt.h"
45 #include "tsemaphore.h"
46 #include "queue.h"
47 #include "omx_classmagic.h"
48 #include "omx_base_port.h"
49 #include "extension_struct.h"
51 
52 
54 #define DEFAULT_IN_BUFFER_SIZE 4 * 1024
55 
56 #define DEFAULT_OUT_BUFFER_SIZE 32 * 1024 /*16 * 1024 */ // TODO - check this size is ok
57 
58 #define DEFAULT_MIME_STRING_LENGTH 128
59 
60 #define NUM_DOMAINS 4
61 
62 #define OMX_BUFFERFLAG_KEY_FRAME 0x11000000
63 
64 typedef struct OMX_VENDOR_EXTRADATATYPE {
66  OMX_U32 nDataSize; // Size of the supporting data to follow
67  OMX_U8 *pData; // Supporting data hint
69 
72  OMX_TUNNELSETUPTYPE nTunnelSetup; // Tunnel setup flags
74 
76 typedef enum OMX_INDEXVENDORTYPE {
80  OMX_IndexVendorCompPropTunnelFlags, /* Will use OMX_TUNNELSETUPTYPE structure*/
84 
86 typedef enum OMX_TRANS_STATETYPE {
96  OMX_TransStateMax = 0X7FFFFFFF
98 
102 typedef enum INTERNAL_MESSAGE_TYPE {
107 
118 
123 #define omx_base_component_PrivateType_FIELDS \
124  OMX_COMPONENTTYPE *openmaxStandComp; \
125  omx_base_PortType **ports; \
126  OMX_PORT_PARAM_TYPE sPortTypesParam[NUM_DOMAINS]; \
127  char uniqueID; \
128  char* name; \
129  OMX_STATETYPE state; \
130  OMX_TRANS_STATETYPE transientState; \
135  OMX_CALLBACKTYPE* callbacks; \
137  OMX_PTR callbackData; \
139  queue_t* messageQueue;\
140  tsem_t* messageSem;\
141  OMX_U32 nGroupPriority; \
142  OMX_U32 nGroupID; \
143  OMX_PARAM_BELLAGIOTHREADS_ID* bellagioThreads;\
144  OMX_BOOL bIsEOSReached; \
145  OMX_MARKTYPE pMark; \
146  pthread_mutex_t flush_mutex; \
147  tsem_t* flush_all_condition; \
148  tsem_t* flush_condition; \
149  tsem_t* bMgmtSem;\
150  tsem_t* bStateSem;\
151  pthread_t messageHandlerThread; \
152  int bufferMgmtThreadID; \
153  pthread_t bufferMgmtThread; \
154  void *loader; \
155  void* (*BufferMgmtFunction)(void* param); \
156  OMX_ERRORTYPE (*messageHandler)(OMX_COMPONENTTYPE*,internalRequestMessageType*); \
157  OMX_ERRORTYPE (*DoStateSet)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32); \
158  OMX_ERRORTYPE (*destructor)(OMX_COMPONENTTYPE *openmaxStandComp); \
159  OMX_ERRORTYPE (*getQualityLevel)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32* pQualityLevel); \
160  OMX_ERRORTYPE (*setQualityLevel)(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 nQualityLevel); \
161  OMX_U32 nqualitylevels; \
162  multiResourceDescriptor** multiResourceLevel; \
163  int currentQualityLevel;
164 ENDCLASS(omx_base_component_PrivateType)
165 
167 
185 
194 
197 
209  OMX_COMPONENTTYPE *openmaxStandComp,
210  OMX_U32 destinationState);
211 
224 
232 void setHeader(OMX_PTR header, OMX_U32 size);
233 
239  OMX_HANDLETYPE hComponent,
240  OMX_STRING pComponentName,
241  OMX_VERSIONTYPE* pComponentVersion,
242  OMX_VERSIONTYPE* pSpecVersion,
243  OMX_UUIDTYPE* pComponentUUID);
244 
258  OMX_HANDLETYPE hComponent,
259  OMX_U8 *cRole,
260  OMX_U32 nIndex);
261 
268  OMX_HANDLETYPE hComponent,
269  OMX_CALLBACKTYPE* pCallbacks,
270  OMX_PTR pAppData);
271 
279  OMX_HANDLETYPE hComponent,
280  OMX_INDEXTYPE nParamIndex,
281  OMX_PTR ComponentParameterStructure);
282 
292  OMX_HANDLETYPE hComponent,
293  OMX_INDEXTYPE nParamIndex,
294  OMX_PTR ComponentParameterStructure);
295 
304  OMX_HANDLETYPE hComponent,
305  OMX_INDEXTYPE nIndex,
306  OMX_PTR pComponentConfigStructure);
307 
316  OMX_HANDLETYPE hComponent,
317  OMX_INDEXTYPE nIndex,
318  OMX_PTR pComponentConfigStructure);
319 
326  OMX_HANDLETYPE hComponent,
327  OMX_STRING cParameterName,
328  OMX_INDEXTYPE* pIndexType);
329 
335  OMX_HANDLETYPE hComponent,
336  OMX_STATETYPE* pState);
337 
344  OMX_HANDLETYPE hComponent,
345  OMX_COMMANDTYPE Cmd,
346  OMX_U32 nParam,
347  OMX_PTR pCmdData);
348 
358  OMX_HANDLETYPE hComponent);
359 
366 void* compMessageHandlerFunction(void*);
367 
380 
385  OMX_HANDLETYPE hComponent,
386  OMX_U32 nPortIndex,
387  OMX_PTR pStructure,
388  size_t size);
389 
391  OMX_HANDLETYPE hComponent,
392  OMX_BUFFERHEADERTYPE** ppBuffer,
393  OMX_U32 nPortIndex,
394  OMX_PTR pAppPrivate,
395  OMX_U32 nSizeBytes);
396 
398  OMX_HANDLETYPE hComponent,
399  OMX_BUFFERHEADERTYPE** ppBufferHdr,
400  OMX_U32 nPortIndex,
401  OMX_PTR pAppPrivate,
402  OMX_U32 nSizeBytes,
403  OMX_U8* pBuffer);
404 
406  OMX_HANDLETYPE hComponent,
407  OMX_BUFFERHEADERTYPE** ppBufferHdr,
408  OMX_U32 nPortIndex,
409  OMX_PTR pAppPrivate,
410  void* eglImage);
411 
413  OMX_HANDLETYPE hComponent,
414  OMX_U32 nPortIndex,
415  OMX_BUFFERHEADERTYPE* pBuffer);
416 
418  OMX_HANDLETYPE hComponent,
419  OMX_BUFFERHEADERTYPE* pBuffer);
420 
422  OMX_HANDLETYPE hComponent,
423  OMX_BUFFERHEADERTYPE* pBuffer);
424 
426  OMX_HANDLETYPE hComp,
427  OMX_U32 nPort,
428  OMX_HANDLETYPE hTunneledComp,
429  OMX_U32 nTunneledPort,
430  OMX_TUNNELSETUPTYPE* pTunnelSetup);
431 
432 #endif
OMX_VENDOR_PROP_TUNNELSETUPTYPE::nPortIndex
OMX_U32 nPortIndex
Definition: omx_base_component.h:71
omx_reference_resource_manager.h
CLASS
#define CLASS(a)
Definition: omx_classmagic.h:48
OMX_TransStateIdleToLoaded
@ OMX_TransStateIdleToLoaded
Definition: omx_base_component.h:95
OMX_VENDOR_EXTRADATATYPE::pData
OMX_U8 * pData
Definition: omx_base_component.h:67
OMX_IndexParameterThreadsID
@ OMX_IndexParameterThreadsID
Definition: omx_base_component.h:81
omx_base_component_UseEGLImage
OMX_ERRORTYPE omx_base_component_UseEGLImage(OMX_HANDLETYPE hComponent, OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, void *eglImage)
Definition: omx_base_component.c:1833
OSCL_IMPORT_REF
#define OSCL_IMPORT_REF
Definition: omx_base_component.h:40
omx_base_component_PrivateType
Definition: omx_base_component.h:122
OMX_ERRORTYPE
OMX_ERRORTYPE
Definition: OMX_Core.h:127
omx_base_component_FreeBuffer
OMX_ERRORTYPE omx_base_component_FreeBuffer(OMX_HANDLETYPE hComponent, OMX_U32 nPortIndex, OMX_BUFFERHEADERTYPE *pBuffer)
Definition: omx_base_component.c:1842
WARNING_MSG_TYPE
@ WARNING_MSG_TYPE
Definition: omx_base_component.h:105
OMX_TransStateMax
@ OMX_TransStateMax
Definition: omx_base_component.h:96
OMX_TransStatePauseToIdle
@ OMX_TransStatePauseToIdle
Definition: omx_base_component.h:94
OMX_U32
unsigned long OMX_U32
Definition: OMX_Types.h:145
checkHeader
OMX_ERRORTYPE checkHeader(OMX_PTR header, OMX_U32 size)
Checks the header of a structure for consistency with size and spec version.
Definition: omx_base_component.c:720
omx_base_component_SetConfig
OMX_ERRORTYPE omx_base_component_SetConfig(OMX_HANDLETYPE hComponent, OMX_INDEXTYPE nIndex, OMX_PTR pComponentConfigStructure)
base SetConfig function
Definition: omx_base_component.c:1246
OMX_TRANS_STATETYPE
OMX_TRANS_STATETYPE
Definition: omx_base_component.h:86
OMX_TransStatePauseToExecuting
@ OMX_TransStatePauseToExecuting
Definition: omx_base_component.h:90
base_constructor_remove_garbage_collected
void base_constructor_remove_garbage_collected(omx_base_component_PrivateType *omx_base_component_Private)
Definition: omx_base_component.c:44
OMX_TransStateLoadedToIdle
@ OMX_TransStateLoadedToIdle
Definition: omx_base_component.h:88
OMXComponentRMExt.h
Extended OMXIL component interface for quality-of-service.
internalRequestMessageType
struct internalRequestMessageType internalRequestMessageType
The container of an internal message.
OMX_CALLBACKTYPE
Definition: OMX_Core.h:498
omx_base_component_EmptyThisBuffer
OMX_ERRORTYPE omx_base_component_EmptyThisBuffer(OMX_HANDLETYPE hComponent, OMX_BUFFERHEADERTYPE *pBuffer)
Definition: omx_base_component.c:1869
OMX_HANDLETYPE
void * OMX_HANDLETYPE
Definition: OMX_Types.h:295
OMX_IndexVendorCompPropTunnelFlags
@ OMX_IndexVendorCompPropTunnelFlags
Definition: omx_base_component.h:80
omx_base_component_GetState
OMX_ERRORTYPE omx_base_component_GetState(OMX_HANDLETYPE hComponent, OMX_STATETYPE *pState)
Definition: omx_base_component.c:1277
omxcore.h
omx_base_component_GetParameter
OMX_ERRORTYPE omx_base_component_GetParameter(OMX_HANDLETYPE hComponent, OMX_INDEXTYPE nParamIndex, OMX_PTR ComponentParameterStructure)
Part of the standard OpenMAX function.
Definition: omx_base_component.c:896
OMX_VENDOR_PROP_TUNNELSETUPTYPE
Definition: omx_base_component.h:70
OMX_IndexVendorOutputFilename
@ OMX_IndexVendorOutputFilename
Definition: omx_base_component.h:79
extension_struct.h
OMX_VENDOR_PROP_TUNNELSETUPTYPE
struct OMX_VENDOR_PROP_TUNNELSETUPTYPE OMX_VENDOR_PROP_TUNNELSETUPTYPE
OMX_INDEXVENDORTYPE
OMX_INDEXVENDORTYPE
Definition: omx_base_component.h:76
setHeader
void setHeader(OMX_PTR header, OMX_U32 size)
Simply fills the first two fields in any OMX structure with the size and the version.
Definition: omx_base_component.c:746
internalRequestMessageType::messageParam
int messageParam
Definition: omx_base_component.h:115
omx_base_component_ComponentDeInit
OMX_ERRORTYPE omx_base_component_ComponentDeInit(OMX_HANDLETYPE hComponent)
This standard functionality is called when the component is destroyed in the FreeHandle standard call...
Definition: omx_base_component.c:346
tsemaphore.h
omx_classmagic.h
OMX_VENDOR_EXTRADATATYPE::nPortIndex
OMX_U32 nPortIndex
Definition: omx_base_component.h:65
ERROR_MSG_TYPE
@ ERROR_MSG_TYPE
Definition: omx_base_component.h:104
OMX_TransStateExecutingToPause
@ OMX_TransStateExecutingToPause
Definition: omx_base_component.h:93
OMX_VERSIONTYPE
Definition: OMX_Types.h:341
omx_base_port.h
internalRequestMessageType
The container of an internal message.
Definition: omx_base_component.h:113
SENDCOMMAND_MSG_TYPE
@ SENDCOMMAND_MSG_TYPE
Definition: omx_base_component.h:103
OMX_PTR
void * OMX_PTR
Definition: OMX_Types.h:199
internalRequestMessageType::pCmdData
OMX_PTR pCmdData
Definition: omx_base_component.h:116
OMX_TUNNELSETUPTYPE
Definition: OMX_Core.h:636
omx_base_component_SetCallbacks
OMX_ERRORTYPE omx_base_component_SetCallbacks(OMX_HANDLETYPE hComponent, OMX_CALLBACKTYPE *pCallbacks, OMX_PTR pAppData)
standard OpenMAX function
Definition: omx_base_component.c:857
OMX_TransStateInvalid
@ OMX_TransStateInvalid
Definition: omx_base_component.h:87
omx_base_component_ParameterSanityCheck
OMX_ERRORTYPE omx_base_component_ParameterSanityCheck(OMX_HANDLETYPE hComponent, OMX_U32 nPortIndex, OMX_PTR pStructure, size_t size)
Definition: omx_base_component.c:759
internalRequestMessageType::messageType
int messageType
Definition: omx_base_component.h:114
omx_base_component_MessageHandler
OMX_ERRORTYPE omx_base_component_MessageHandler(OMX_COMPONENTTYPE *openmaxStandComp, internalRequestMessageType *message)
Definition: omx_base_component.c:1492
OMX_COMPONENTTYPE
Definition: OMX_Component.h:308
queue.h
OMX_IndexVendorInputFilename
@ OMX_IndexVendorInputFilename
Definition: omx_base_component.h:78
omx_base_component_UseBuffer
OMX_ERRORTYPE omx_base_component_UseBuffer(OMX_HANDLETYPE hComponent, OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, OMX_U32 nSizeBytes, OMX_U8 *pBuffer)
Definition: omx_base_component.c:1804
compMessageHandlerFunction
void * compMessageHandlerFunction(void *)
Component's message handler thread function.
Definition: omx_base_component.c:1442
OMX_TransStateIdleToExecuting
@ OMX_TransStateIdleToExecuting
Definition: omx_base_component.h:91
OMX_VENDOR_EXTRADATATYPE
struct OMX_VENDOR_EXTRADATATYPE OMX_VENDOR_EXTRADATATYPE
OMX_TransStateIdleToPause
@ OMX_TransStateIdleToPause
Definition: omx_base_component.h:89
omx_base_component_ComponentRoleEnum
OMX_ERRORTYPE omx_base_component_ComponentRoleEnum(OMX_HANDLETYPE hComponent, OMX_U8 *cRole, OMX_U32 nIndex)
Enumerates all the role of the component.
Definition: omx_base_component.c:844
OMX_VENDOR_PROP_TUNNELSETUPTYPE::nTunnelSetup
OMX_TUNNELSETUPTYPE nTunnelSetup
Definition: omx_base_component.h:72
omx_base_component_FillThisBuffer
OMX_ERRORTYPE omx_base_component_FillThisBuffer(OMX_HANDLETYPE hComponent, OMX_BUFFERHEADERTYPE *pBuffer)
Definition: omx_base_component.c:1899
OMX_INDEXTYPE
OMX_INDEXTYPE
Definition: OMX_Index.h:60
omx_base_component_Destructor
OMX_ERRORTYPE omx_base_component_Destructor(OMX_COMPONENTTYPE *openmaxStandComp)
the base destructor for ST OpenMAX components
Definition: omx_base_component.c:271
OMX_STATETYPE
OMX_STATETYPE
Definition: OMX_Core.h:93
omx_base_component_ComponentTunnelRequest
OMX_ERRORTYPE omx_base_component_ComponentTunnelRequest(OMX_HANDLETYPE hComp, OMX_U32 nPort, OMX_HANDLETYPE hTunneledComp, OMX_U32 nTunneledPort, OMX_TUNNELSETUPTYPE *pTunnelSetup)
Definition: omx_base_component.c:1930
omx_base_component_SendCommand
OMX_ERRORTYPE omx_base_component_SendCommand(OMX_HANDLETYPE hComponent, OMX_COMMANDTYPE Cmd, OMX_U32 nParam, OMX_PTR pCmdData)
standard SendCommand function
Definition: omx_base_component.c:1293
OMX_STRING
char * OMX_STRING
Definition: OMX_Types.h:206
omx_base_component_AllocateBuffer
OMX_ERRORTYPE omx_base_component_AllocateBuffer(OMX_HANDLETYPE hComponent, OMX_BUFFERHEADERTYPE **ppBuffer, OMX_U32 nPortIndex, OMX_PTR pAppPrivate, OMX_U32 nSizeBytes)
Definition: omx_base_component.c:1775
OMX_UUIDTYPE
unsigned char OMX_UUIDTYPE[128]
Definition: OMX_Types.h:219
omx_base_component_GetComponentVersion
OMX_ERRORTYPE omx_base_component_GetComponentVersion(OMX_HANDLETYPE hComponent, OMX_STRING pComponentName, OMX_VERSIONTYPE *pComponentVersion, OMX_VERSIONTYPE *pSpecVersion, OMX_UUIDTYPE *pComponentUUID)
standard openmax function
Definition: omx_base_component.c:801
omx_base_component_GetConfig
OMX_ERRORTYPE omx_base_component_GetConfig(OMX_HANDLETYPE hComponent, OMX_INDEXTYPE nIndex, OMX_PTR pComponentConfigStructure)
base GetConfig function
Definition: omx_base_component.c:1232
INTERNAL_MESSAGE_TYPE
INTERNAL_MESSAGE_TYPE
Enumerates all the possible types of messages handled internally by the component.
Definition: omx_base_component.h:102
omx_base_component_DoStateSet
OMX_ERRORTYPE omx_base_component_DoStateSet(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 destinationState)
Definition: omx_base_component.c:370
OMX_BUFFERHEADERTYPE
Definition: OMX_Core.h:399
omx_base_getQualityLevel
OMX_ERRORTYPE omx_base_getQualityLevel(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 *pQualityLevel)
Definition: omx_base_component.c:1959
OMX_U8
unsigned char OMX_U8
Definition: OMX_Types.h:133
omx_base_component_Constructor
OMX_ERRORTYPE omx_base_component_Constructor(OMX_COMPONENTTYPE *openmaxStandComp, OMX_STRING cComponentName)
The base constructor for the OpenMAX ST components.
Definition: omx_base_component.c:95
OMX_COMMANDTYPE
OMX_COMMANDTYPE
Definition: OMX_Core.h:50
OMX_VENDOR_EXTRADATATYPE
Definition: omx_base_component.h:64
OMX_IndexVendorStartUnused
@ OMX_IndexVendorStartUnused
Definition: OMX_Index.h:243
OMX_TransStateExecutingToIdle
@ OMX_TransStateExecutingToIdle
Definition: omx_base_component.h:92
OMX_VIDEO_CodingTheora
@ OMX_VIDEO_CodingTheora
Definition: omx_base_component.h:82
omx_base_component_SetParameter
OMX_ERRORTYPE omx_base_component_SetParameter(OMX_HANDLETYPE hComponent, OMX_INDEXTYPE nParamIndex, OMX_PTR ComponentParameterStructure)
part of the standard openmax function
Definition: omx_base_component.c:1030
omx_base_setQualityLevel
OMX_ERRORTYPE omx_base_setQualityLevel(OMX_COMPONENTTYPE *openmaxStandComp, OMX_U32 nQualityLevel)
Definition: omx_base_component.c:1966
OMX_VENDOR_EXTRADATATYPE::nDataSize
OMX_U32 nDataSize
Definition: omx_base_component.h:66
omx_base_component_GetExtensionIndex
OMX_ERRORTYPE omx_base_component_GetExtensionIndex(OMX_HANDLETYPE hComponent, OMX_STRING cParameterName, OMX_INDEXTYPE *pIndexType)
base function not implemented
Definition: omx_base_component.c:1258

Generated for OpenMAX Bellagio rel. 0.9.3 by  doxygen 1.5.1
SourceForge.net Logo