OpenMAX IL core


Modules

 Tunneling
 Content Pipes

Data Structures

struct  OMX_COMPONENTREGISTERTYPE

Typedefs

typedef OMX_ERRORTYPE(*) OMX_COMPONENTINITTYPE (OMX_IN OMX_HANDLETYPE hComponent)

Enumerations

enum  OMX_COMMANDTYPE {
  OMX_CommandStateSet, OMX_CommandFlush, OMX_CommandPortDisable, OMX_CommandPortEnable,
  OMX_CommandMarkBuffer, OMX_CommandMax = 0X7FFFFFFF
}

Functions

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Init (void)
 The OMX_Init standard function.
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Deinit (void)
 The OMX_Deinit standard function.
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_ComponentNameEnum (OMX_OUT OMX_STRING cComponentName, OMX_IN OMX_U32 nNameLength, OMX_IN OMX_U32 nIndex)
 the OMX_ComponentNameEnum standard function
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_GetHandle (OMX_OUT OMX_HANDLETYPE *pHandle, OMX_IN OMX_STRING cComponentName, OMX_IN OMX_PTR pAppData, OMX_IN OMX_CALLBACKTYPE *pCallBacks)
 the OMX_GetHandle standard function
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_FreeHandle (OMX_IN OMX_HANDLETYPE hComponent)
 the OMX_FreeHandle standard function
OMX_API OMX_ERRORTYPE OMX_GetComponentsOfRole (OMX_IN OMX_STRING role, OMX_INOUT OMX_U32 *pNumComps, OMX_INOUT OMX_U8 **compNames)
 the OMX_GetComponentsOfRole standard function
OMX_API OMX_ERRORTYPE OMX_GetRolesOfComponent (OMX_IN OMX_STRING compName, OMX_INOUT OMX_U32 *pNumRoles, OMX_OUT OMX_U8 **roles)
 the OMX_GetRolesOfComponent standard function

Variables

OMX_COMPONENTREGISTERTYPE OMX_ComponentRegistered []

Detailed Description

Functions and structure related to the OMX IL core

Typedef Documentation

typedef OMX_ERRORTYPE(* ) OMX_COMPONENTINITTYPE(OMX_IN OMX_HANDLETYPE hComponent)

Definition at line 254 of file OMX_Core.h.


Enumeration Type Documentation

enum OMX_COMMANDTYPE

The OMX_COMMANDTYPE enumeration is used to specify the action in the OMX_SendCommand macro.

Enumerator:
OMX_CommandStateSet  Change the component state
OMX_CommandFlush  Flush the data queue(s) of a component
OMX_CommandPortDisable  Disable a port on a component.
OMX_CommandPortEnable  Enable a port on a component.
OMX_CommandMarkBuffer  Mark a component/buffer for observation
OMX_CommandMax 

Definition at line 49 of file OMX_Core.h.


Function Documentation

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_ComponentNameEnum ( OMX_OUT OMX_STRING  cComponentName,
OMX_IN OMX_U32  nNameLength,
OMX_IN OMX_U32  nIndex 
)

the OMX_ComponentNameEnum standard function

This function build a complete list of names from all the loaders. For each loader the index is from 0 to max, but this function must provide a single list, with a common index. This implementation orders the loaders and the related list of components.

Definition at line 211 of file omxcore.c.

References DEB_LEV_FUNCTION_NAME, DEBUG, err, loadersList, OMX_ErrorNoMore, and OMX_ErrorNone.

Referenced by main(), and test_OMX_ComponentNameEnum().

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Deinit ( void   ) 

The OMX_Deinit standard function.

In this function the Deinit function for each component loader is performed

Definition at line 124 of file omxcore.c.

References DEB_LEV_FUNCTION_NAME, DEBUG, loadersList, and OMX_ErrorNone.

Referenced by main().

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_FreeHandle ( OMX_IN OMX_HANDLETYPE  hComponent  ) 

the OMX_FreeHandle standard function

The OMX_FreeHandle method will free a handle allocated by the OMX_GetHandle method. If the component reference count goes to zero, the component will be unloaded from memory.

The core should return from this call within 20 msec when the component is in the OMX_StateLoaded state.

Parameters:
[in] hComponent Handle of the component to be accessed. This is the component handle returned by the call to the GetHandle function.
Returns:
OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_NoError. Otherwise the appropriate OMX error will be returned.

Definition at line 182 of file omxcore.c.

References err, loadersList, OMX_ErrorComponentNotFound, and OMX_ErrorNone.

Referenced by main(), and test_OpenClose().

OMX_API OMX_ERRORTYPE OMX_GetComponentsOfRole ( OMX_IN OMX_STRING  role,
OMX_INOUT OMX_U32 pNumComps,
OMX_INOUT OMX_U8 **  compNames 
)

the OMX_GetComponentsOfRole standard function

This function searches in all the component loaders any component supporting the requested role

Definition at line 338 of file omxcore.c.

References BOSA_COMPONENTLOADER::BOSA_GetComponentsOfRole, DEB_LEV_FUNCTION_NAME, DEBUG, err, loadersList, OMX_ErrorComponentNotFound, OMX_ErrorNone, and OMX_MAX_STRINGNAME_SIZE.

Referenced by test_OMX_ComponentEnumByRole().

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_GetHandle ( OMX_OUT OMX_HANDLETYPE pHandle,
OMX_IN OMX_STRING  cComponentName,
OMX_IN OMX_PTR  pAppData,
OMX_IN OMX_CALLBACKTYPE pCallBacks 
)

the OMX_GetHandle standard function

This function will scan inside any component loader to search for the requested component. If there are more components with the same name the first component is returned. The existence of multiple components with the same name is not contemplated in OpenMAX specification. The assumption is that this behavior is NOT allowed.

Returns:
OMX_ErrorNone if a component has been found OMX_ErrorComponentNotFound if the requested component has not been found in any loader

Definition at line 154 of file omxcore.c.

References DEB_LEV_FUNCTION_NAME, DEBUG, err, loadersList, OMX_ErrorComponentNotFound, and OMX_ErrorNone.

Referenced by main(), and test_OpenClose().

OMX_API OMX_ERRORTYPE OMX_GetRolesOfComponent ( OMX_IN OMX_STRING  compName,
OMX_INOUT OMX_U32 pNumRoles,
OMX_OUT OMX_U8 **  roles 
)

the OMX_GetRolesOfComponent standard function

The OMX_GetRolesOfComponent method will return the number of roles supported by the given component and (if the roles field is non-NULL) the names of those roles. The call will fail if an insufficiently sized array of names is supplied. To ensure the array is sufficiently sized the client should: first call this function with the roles field NULL to determine the number of role names second call this function with the roles field pointing to an array of names allocated according to the number returned by the first call.

The core should return from this call within 5 msec.

Parameters:
[in] compName This is the name of the component being queried about.
[inout] pNumRoles This is used both as input and output.
If roles is NULL, the input is ignored and the output specifies how many roles the component supports.

If compNames is not NULL, on input it bounds the size of the input structure and on output, it specifies the number of roles string names listed within the roles parameter.

Parameters:
[out] roles If NULL this field is ignored. If non-NULL this points to an array of 128-byte strings which accepts a list of the names of all standard components roles implemented on the specified component name. numComps indicates the number of names.

Definition at line 311 of file omxcore.c.

References DEB_LEV_FUNCTION_NAME, DEBUG, err, loadersList, OMX_ErrorComponentNotFound, and OMX_ErrorNone.

Referenced by test_OMX_RoleEnum().

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Init ( void   ) 

The OMX_Init standard function.

This function calls the init function of each componente loader added. If there is no component loaders present, the ST default component loader (static libraries) is loaded as default component loader.

Returns:
OMX_ErrorNone

Definition at line 95 of file omxcore.c.

References createComponentLoaders(), DEB_LEV_ERR, DEB_LEV_FUNCTION_NAME, DEBUG, err, loadersList, OMX_ErrorInsufficientResources, and OMX_ErrorNone.

Referenced by main().


Variable Documentation

OMX_COMPONENTREGISTERTYPE OMX_ComponentRegistered[]


Generated for OpenMAX Bellagio rel. 0.3.5-svn by  doxygen 1.5.1
SourceForge.net Logo