Classes | Modules | Typedefs | Enumerations | Functions | Variables

OpenMAX IL core

Classes

struct  OMX_COMPONENTREGISTERTYPE

Modules

 Tunneling
 Content Pipes

Typedefs

typedef enum OMX_COMMANDTYPE OMX_COMMANDTYPE
typedef OMX_ERRORTYPE(* OMX_COMPONENTINITTYPE )(OMX_IN OMX_HANDLETYPE hComponent)
typedef struct
OMX_COMPONENTREGISTERTYPE 
OMX_COMPONENTREGISTERTYPE

Enumerations

enum  OMX_COMMANDTYPE {
  OMX_CommandStateSet, OMX_CommandFlush, OMX_CommandPortDisable, OMX_CommandPortEnable,
  OMX_CommandMarkBuffer, OMX_CommandKhronosExtensions = 0x6F000000, OMX_CommandVendorStartUnused = 0x7F000000, OMX_CommandMax = 0X7FFFFFFF
}

Functions

OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Init (void)
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Deinit (void)
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_ComponentNameEnum (OMX_OUT OMX_STRING cComponentName, OMX_IN OMX_U32 nNameLength, OMX_IN OMX_U32 nIndex)
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)
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_FreeHandle (OMX_IN OMX_HANDLETYPE hComponent)
OMX_API OMX_ERRORTYPE OMX_GetComponentsOfRole (OMX_IN OMX_STRING role, OMX_INOUT OMX_U32 *pNumComps, OMX_INOUT OMX_U8 **compNames)
OMX_API OMX_ERRORTYPE OMX_GetRolesOfComponent (OMX_IN OMX_STRING compName, OMX_INOUT OMX_U32 *pNumRoles, OMX_OUT OMX_U8 **roles)

Variables

OMX_COMPONENTREGISTERTYPE OMX_ComponentRegistered []

Detailed Description

In the following we define groups that help building doxygen documentation Functions and structure related to the OMX IL core


Typedef Documentation

OMX_Core.h - OpenMax IL version 1.1.2 The OMX_Core header file contains the definitions used by both the application and the component to access common items. The OMX_COMMANDTYPE enumeration is used to specify the action in the OMX_SendCommand macro.

typedef OMX_ERRORTYPE(* OMX_COMPONENTINITTYPE)(OMX_IN OMX_HANDLETYPE hComponent)

Enumeration Type Documentation

OMX_Core.h - OpenMax IL version 1.1.2 The OMX_Core header file contains the definitions used by both the application and the component to access common items. 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_CommandKhronosExtensions 

Reserved region for introducing Khronos Standard Extensions

OMX_CommandVendorStartUnused 

Reserved region for introducing Vendor Extensions

OMX_CommandMax 

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 method will enumerate through all the names of recognised valid components in the system. This function is provided as a means to detect all the components in the system run-time. There is no strict ordering to the enumeration order of component names, although each name will only be enumerated once. If the OMX core supports run-time installation of new components, it is only requried to detect newly installed components when the first call to enumerate component names is made (i.e. when nIndex is 0x0).

The core should return from this call in 20 msec.

Parameters:
[out] cComponentName pointer to a null terminated string with the component name. The names of the components are strings less than 127 bytes in length plus the trailing null for a maximum size of 128 bytes. An example of a valid component name is "OMX.TI.AUDIO.DSP.MIXER\0". Names are assigned by the vendor, but shall start with "OMX." and then have the Vendor designation next.
[in] nNameLength number of characters in the cComponentName string. With all component name strings restricted to less than 128 characters (including the trailing null) it is recomended that the caller provide a input string for the cComponentName of 128 characters.
[in] nIndex number containing the enumeration index for the component. Multiple calls to OMX_ComponentNameEnum with increasing values of nIndex will enumerate through the component names in the system until OMX_ErrorNoMore is returned. The value of nIndex is 0 to (N-1), where N is the number of valid installed components in the system.
Returns:
OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. When the value of nIndex exceeds the number of components in the system minus 1, OMX_ErrorNoMore will be returned. Otherwise the appropriate OMX error will be returned.
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Deinit ( void   ) 

The OMX_Deinit method is used to deinitialize the OMX core. It shall be the last call made into OMX. In the event that the core determines that thare are components loaded when this call is made, the core may return with an error rather than try to unload the components.

The core should return from this call within 20 msec.

Returns:
OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned.
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_FreeHandle ( OMX_IN OMX_HANDLETYPE  hComponent  ) 

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_ErrorNone. Otherwise the appropriate OMX error will be returned.
OMX_API OMX_ERRORTYPE OMX_GetComponentsOfRole ( OMX_IN OMX_STRING  role,
OMX_INOUT OMX_U32 *  pNumComps,
OMX_INOUT OMX_U8 **  compNames 
)

The OMX_GetComponentsOfRole method will return the number of components that support the given role and (if the compNames field is non-NULL) the names of those components. 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 compNames field NULL to determine the number of component names second call this function with the compNames 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] role This is generic standard component name consisting only of component class name and the type within that class (e.g. 'audio_decoder.aac').
[inout] pNumComps This is used both as input and output.

If compNames is NULL, the input is ignored and the output specifies how many components support the given role.

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

Parameters:
[inout] compNames 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 physical components that implement the specified standard component name. Each name is NULL terminated. numComps indicates the number of names.
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 method will locate the component specified by the component name given, load that component into memory and then invoke the component's methods to create an instance of the component.

The core should return from this call within 20 msec.

Parameters:
[out] pHandle pointer to an OMX_HANDLETYPE pointer to be filled in by this method.
[in] cComponentName pointer to a null terminated string with the component name. The names of the components are strings less than 127 bytes in length plus the trailing null for a maximum size of 128 bytes. An example of a valid component name is "OMX.TI.AUDIO.DSP.MIXER\0". Names are assigned by the vendor, but shall start with "OMX." and then have the Vendor designation next.
[in] pAppData pointer to an application defined value that will be returned during callbacks so that the application can identify the source of the callback.
[in] pCallBacks pointer to a OMX_CALLBACKTYPE structure that will be passed to the component to initialize it with.
Returns:
OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned.
OMX_API OMX_ERRORTYPE OMX_GetRolesOfComponent ( OMX_IN OMX_STRING  compName,
OMX_INOUT OMX_U32 *  pNumRoles,
OMX_OUT OMX_U8 **  roles 
)

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.
OMX_API OMX_ERRORTYPE OMX_APIENTRY OMX_Init ( void   ) 

The OMX_Init method is used to initialize the OMX core. It shall be the first call made into OMX and it should only be executed one time without an interviening OMX_Deinit call.

The core should return from this call within 20 msec.

Returns:
OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned.

Variable Documentation

LIMOpenMAX Implementation API Reference - Generated by doxygen