#define OMX_GetComponentVersion | ( | hComponent, | |||
pComponentName, | |||||
pComponentVersion, | |||||
pSpecVersion, | |||||
pComponentUUID | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->GetComponentVersion( \ hComponent, \ pComponentName, \ pComponentVersion, \ pSpecVersion, \ pComponentUUID)
[in] | hComponent | handle of component to execute the command |
[out] | pComponentName | pointer to an empty string of length 128 bytes. The component will write its name into this string. The name will be terminated by a single zero byte. The name of a component will be 127 bytes or less to leave room for the trailing zero byte. An example of a valid component name is "OMX.ABC.ChannelMixer\0". |
[out] | pComponentVersion | pointer to an OMX Version structure that the component will fill in. The component will fill in a value that indicates the component version. NOTE: the component version is NOT the same as the OMX Specification version (found in all structures). The component version is defined by the vendor of the component and its value is entirely up to the component vendor. |
[out] | pSpecVersion | pointer to an OMX Version structure that the component will fill in. The SpecVersion is the version of the specification that the component was built against. Please note that this value may or may not match the structure's version. For example, if the component was built against the 2.0 specification, but the application (which creates the structure is built against the 1.0 specification the versions would be different. |
[out] | pComponentUUID | pointer to the UUID of the component which will be filled in by the component. The UUID is a unique identifier that is set at RUN time for the component and is unique to each instantion of the component. |
Definition at line 648 of file OMX_Core.h.
#define OMX_GetConfig | ( | hComponent, | |||
nConfigIndex, | |||||
pComponentConfigStructure | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->GetConfig( \ hComponent, \ nConfigIndex, \ pComponentConfigStructure)
The component should return from this call within 5 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the OMX_GetHandle function. |
[in] | nIndex | Index of the structure to be filled. This value is from the OMX_INDEXTYPE enumeration. |
[in,out] | pComponentConfigStructure | pointer to application allocated structure to be filled by the component. |
Definition at line 823 of file OMX_Core.h.
Referenced by filereaderEventHandler(), main(), parser3gpEventHandler(), and setFbsinkParameters().
#define OMX_GetExtensionIndex | ( | hComponent, | |||
cParameterName, | |||||
pIndexType | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->GetExtensionIndex( \ hComponent, \ cParameterName, \ pIndexType)
The component should return from this call within 5 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the GetHandle function. |
[in] | cParameterName | OMX_STRING that shall be less than 128 characters long including the trailing null byte. This is the string that will get translated by the component into a configuration index. |
[out] | pIndexType | a pointer to a OMX_INDEXTYPE to receive the index value. |
Definition at line 893 of file OMX_Core.h.
Referenced by filereaderEventHandler(), main(), and parser3gpEventHandler().
#define OMX_GetParameter | ( | hComponent, | |||
nParamIndex, | |||||
pComponentParameterStructure | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->GetParameter( \ hComponent, \ nParamIndex, \ pComponentParameterStructure)
The component should return from this call within 20 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the OMX_GetHandle function. |
[in] | nParamIndex | Index of the structure to be filled. This value is from the OMX_INDEXTYPE enumeration. |
[in,out] | pComponentParameterStructure | Pointer to application allocated structure to be filled by the component. |
Definition at line 748 of file OMX_Core.h.
Referenced by audiodecEventHandler(), base_port_ComponentTunnelRequest(), main(), setCameraParameters(), setColorConvParameters(), setFbsinkParameters(), setPortParameters(), SetPortParametersAudio(), SetPortParametersVideo(), and videodecEventHandler().
#define OMX_GetState | ( | hComponent, | |||
pState | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->GetState( \ hComponent, \ pState)
The component should return from this call within 5 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the OMX_GetHandle function. |
[out] | pState | pointer to the location to receive the state. The value returned is one of the OMX_STATETYPE members |
Definition at line 919 of file OMX_Core.h.
Referenced by audiosrcFillBufferDone(), main(), videodecFillBufferDone(), and videosrcFillBufferDone().
#define OMX_SendCommand | ( | hComponent, | |||
Cmd, | |||||
nParam, | |||||
pCmdData | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->SendCommand( \ hComponent, \ Cmd, \ nParam, \ pCmdData)
When the command is "OMX_CommandStateSet" the component will queue a state transition to the new state idenfied in nParam.
When the command is "OMX_CommandFlush", to flush a port's buffer queues, the command will force the component to return all buffers NOT CURRENTLY BEING PROCESSED to the application, in the order in which the buffers were received.
When the command is "OMX_CommandPortDisable" or "OMX_CommandPortEnable", the component's port (given by the value of nParam) will be stopped or restarted.
When the command "OMX_CommandMarkBuffer" is used to mark a buffer, the pCmdData will point to a OMX_MARKTYPE structure containing the component handle of the component to examine the buffer chain for the mark. nParam1 contains the index of the port on which the buffer mark is applied.
Specification text for more details.
[in] | hComponent | handle of component to execute the command |
[in] | Cmd | Command for the component to execute |
[in] | nParam | Parameter for the command to be executed. When Cmd has the value OMX_SetStateCmd, value is a member of OMX_StateType. When Cmd has the value OMX_FlushCmd, value of nParam indicates which port(s) to flush. -1 is used to flush all ports a single port index will only flush that port. When Cmd has the value "OMX_CommandPortDisable" or "OMX_CommandPortEnable", the component's port is given by the value of nParam. When Cmd has the value "OMX_CommandMarkBuffer" the components pot is given by the value of nParam. |
[in] | pCmdData | Parameter pointing to the OMX_MARKTYPE structure when Cmd has the value "OMX_CommandMarkBuffer". |
Definition at line 708 of file OMX_Core.h.
Referenced by audiodecEventHandler(), main(), parser3gpEventHandler(), and videodecEventHandler().
#define OMX_SetConfig | ( | hComponent, | |||
nConfigIndex, | |||||
pComponentConfigStructure | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->SetConfig( \ hComponent, \ nConfigIndex, \ pComponentConfigStructure)
The component should return from this call within 5 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the OMX_GetHandle function. |
[in] | nConfigIndex | Index of the structure to be sent. This value is from the OMX_INDEXTYPE enumeration above. |
[in] | pComponentConfigStructure | pointer to application allocated structure to be used for initialization by the component. |
Definition at line 859 of file OMX_Core.h.
Referenced by filereaderEventHandler(), main(), parser3gpEventHandler(), and setFbsinkParameters().
#define OMX_SetParameter | ( | hComponent, | |||
nParamIndex, | |||||
pComponentParameterStructure | ) |
Value:
((OMX_COMPONENTTYPE*)hComponent)->SetParameter( \ hComponent, \ nParamIndex, \ pComponentParameterStructure)
The component should return from this call within 20 msec.
[in] | hComponent | Handle of the component to be accessed. This is the component handle returned by the call to the OMX_GetHandle function. |
[in] | nIndex | Index of the structure to be sent. This value is from the OMX_INDEXTYPE enumeration. |
[in] | pComponentParameterStructure | pointer to application allocated structure to be used for initialization by the component. |
Definition at line 787 of file OMX_Core.h.
Referenced by audiodecEventHandler(), base_port_ComponentTunnelRequest(), main(), omx_base_component_SetParameter(), setCameraParameters(), setColorConvParameters(), setFbsinkParameters(), setPortParameters(), SetPortParametersAudio(), and SetPortParametersVideo().
enum OMX_EVENTTYPE |
OMX_EventCmdComplete | component has sucessfully completed a command |
OMX_EventError | component has detected an error condition |
OMX_EventMark | component has detected a buffer mark |
OMX_EventPortSettingsChanged | component is reported a port settings change |
OMX_EventBufferFlag | component has detected an EOS |
OMX_EventResourcesAcquired | component has been granted resources and is automatically starting the state change from OMX_StateWaitForResources to OMX_StateIdle. |
OMX_EventComponentResumed | Component resumed due to reacquisition of resources |
OMX_EventDynamicResourcesAvailable | Component has acquired previously unavailable dynamic resources |
OMX_EventPortFormatDetected | Component has detected a supported format. |
OMX_EventMax |
Definition at line 442 of file OMX_Core.h.
enum OMX_PORTDOMAINTYPE |
OMX_Component.h - OpenMax IL version 1.1.1 The OMX_Component header file contains the definitions used to define the public interface of a component. This header file is intended to be used by both the application and the component.
OMX_PortDomainAudio | |
OMX_PortDomainVideo | |
OMX_PortDomainImage | |
OMX_PortDomainOther | |
OMX_PortDomainMax |
Definition at line 50 of file OMX_Component.h.
enum OMX_STATETYPE |
The OMX_STATETYPE enumeration is used to indicate or change the component state. This enumeration reflects the current state of the component when used with the OMX_GetState macro or becomes the parameter in a state change command when used with the OMX_SendCommand macro.
The component will be in the Loaded state after the component is initially loaded into memory. In the Loaded state, the component is not allowed to allocate or hold resources other than to build it's internal parameter and configuration tables. The application will send one or more SetParameters/GetParameters and SetConfig/GetConfig commands to the component and the component will record each of these parameter and configuration changes for use later. When the application sends the Idle command, the component will acquire the resources needed for the specified configuration and will transition to the idle state if the allocation is successful. If the component cannot successfully transition to the idle state for any reason, the state of the component shall be fully rolled back to the Loaded state (e.g. all allocated resources shall be released). When the component receives the command to go to the Executing state, it shall begin processing buffers by sending all input buffers it holds to the application. While the component is in the Idle state, the application may also send the Pause command. If the component receives the pause command while in the Idle state, the component shall send all input buffers it holds to the application, but shall not begin processing buffers. This will allow the application to prefill buffers.
Definition at line 90 of file OMX_Core.h.