OMX_Types.h File Reference

Go to the source code of this file.

Data Structures

struct  OMX_BU32
 Unsigned bounded value type. More...
struct  OMX_BS32
 Signed bounded value type. More...
struct  OMX_MARKTYPE
union  OMX_VERSIONTYPE
 The OMX_VERSIONTYPE union is used to specify the version for a structure or component. More...

Defines

#define OMX_API   extern
 OMX_Types.h - OpenMax IL version 1.1.2 The OMX_Types header file contains the primitive type definitions used by the core, the application and the component.
#define OMX_ALL   0xFFFFFFFF
 OMX_IN is used to identify inputs to an OMX function.
#define OMX_TICKS_PER_SECOND   1000000

Typedefs

typedef unsigned char OMX_U8
 OMX_U8 is an 8 bit unsigned quantity that is byte aligned.
typedef signed char OMX_S8
 OMX_S8 is an 8 bit signed quantity that is byte aligned.
typedef unsigned short OMX_U16
 OMX_U16 is a 16 bit unsigned quantity that is 16 bit word aligned.
typedef signed short OMX_S16
 OMX_S16 is a 16 bit signed quantity that is 16 bit word aligned.
typedef unsigned long OMX_U32
 OMX_U32 is a 32 bit unsigned quantity that is 32 bit word aligned.
typedef signed long OMX_S32
 OMX_S32 is a 32 bit signed quantity that is 32 bit word aligned.
typedef unsigned long long OMX_U64
 OMX_U64 is a 64 bit unsigned quantity that is 64 bit word aligned.
typedef signed long long OMX_S64
 OMX_S64 is a 64 bit signed quantity that is 64 bit word aligned.
typedef void * OMX_PTR
 The OMX_PTR type is intended to be used to pass pointers between the OMX applications and the OMX Core and components.
typedef char * OMX_STRING
 The OMX_STRING type is intended to be used to pass "C" type strings between the application and the core and component.
typedef unsigned char * OMX_BYTE
 The OMX_BYTE type is intended to be used to pass arrays of bytes such as buffers between the application and the component and core.
typedef unsigned char OMX_UUIDTYPE [128]
 OMX_UUIDTYPE is a very long unique identifier to uniquely identify at runtime.
typedef OMX_S64 OMX_TICKS
 Structure representing some time or duration in microseconds.
typedef void * OMX_HANDLETYPE
 Define the public interface for the OMX Handle.
typedef void * OMX_NATIVE_DEVICETYPE
 OMX_NATIVE_DEVICETYPE is used to map a OMX video port to the platform & operating specific object used to reference the display or can be used by a audio port for native audio rendering.
typedef void * OMX_NATIVE_WINDOWTYPE
 OMX_NATIVE_WINDOWTYPE is used to map a OMX video port to the platform & operating specific object used to reference the window.

Enumerations

enum  OMX_BOOL { OMX_FALSE = 0, OMX_TRUE = !OMX_FALSE, OMX_BOOL_MAX = 0x7FFFFFFF }
 The OMX_BOOL type is intended to be used to represent a true or a false value when passing parameters to and from the OMX core and components. More...
enum  OMX_DIRTYPE { OMX_DirInput, OMX_DirOutput, OMX_DirMax = 0x7FFFFFFF }
 The OMX_DIRTYPE enumeration is used to indicate if a port is an input or an output port. More...
enum  OMX_ENDIANTYPE { OMX_EndianBig, OMX_EndianLittle, OMX_EndianMax = 0x7FFFFFFF }
 The OMX_ENDIANTYPE enumeration is used to indicate the bit ordering for numerical data (i.e. More...
enum  OMX_NUMERICALDATATYPE { OMX_NumericalDataSigned, OMX_NumericalDataUnsigned, OMX_NumercialDataMax = 0x7FFFFFFF }
 The OMX_NUMERICALDATATYPE enumeration is used to indicate if data is signed or unsigned. More...


Define Documentation

#define OMX_ALL   0xFFFFFFFF

OMX_IN is used to identify inputs to an OMX function.

This designation will also be used in the case of a pointer that points to a parameter that is used as an output. OMX_OUT is used to identify outputs from an OMX function. This designation will also be used in the case of a pointer that points to a parameter that is used as an input. OMX_INOUT is used to identify parameters that may be either inputs or outputs from an OMX function at the same time. This designation will also be used in the case of a pointer that points to a parameter that is used both as an input and an output. OMX_ALL is used to as a wildcard to select all entities of the same type when specifying the index, or referring to a object by an index. (i.e. use OMX_ALL to indicate all N channels). When used as a port index for a config or parameter this OMX_ALL denotes that the config or parameter applies to the entire component not just one port.

Referenced by InitialiseComponent(), and PrintOmx().

#define OMX_API   extern

OMX_Types.h - OpenMax IL version 1.1.2 The OMX_Types header file contains the primitive type definitions used by the core, the application and the component.

This file may need to be modified to be used on systems that do not have "char" set to 8 bits, "short" set to 16 bits and "long" set to 32 bits. The OMX_API and OMX_APIENTRY are platform specific definitions used to declare OMX function prototypes. They are modified to meet the requirements for a particular platform

#define OMX_TICKS_PER_SECOND   1000000


Typedef Documentation

typedef unsigned char* OMX_BYTE

The OMX_BYTE type is intended to be used to pass arrays of bytes such as buffers between the application and the component and core.

The OMX_BYTE type is a 32 bit pointer to a zero terminated string. The pointer is word aligned and the string is byte aligned.

typedef void* OMX_HANDLETYPE

Define the public interface for the OMX Handle.

The core will not use this value internally, but the application should only use this value.

typedef void* OMX_NATIVE_DEVICETYPE

OMX_NATIVE_DEVICETYPE is used to map a OMX video port to the platform & operating specific object used to reference the display or can be used by a audio port for native audio rendering.

typedef void* OMX_NATIVE_WINDOWTYPE

OMX_NATIVE_WINDOWTYPE is used to map a OMX video port to the platform & operating specific object used to reference the window.

typedef void* OMX_PTR

The OMX_PTR type is intended to be used to pass pointers between the OMX applications and the OMX Core and components.

This is a 32 bit pointer and is aligned on a 32 bit boundary.

typedef signed short OMX_S16

OMX_S16 is a 16 bit signed quantity that is 16 bit word aligned.

typedef signed long OMX_S32

OMX_S32 is a 32 bit signed quantity that is 32 bit word aligned.

typedef signed long long OMX_S64

OMX_S64 is a 64 bit signed quantity that is 64 bit word aligned.

typedef signed char OMX_S8

OMX_S8 is an 8 bit signed quantity that is byte aligned.

typedef char* OMX_STRING

The OMX_STRING type is intended to be used to pass "C" type strings between the application and the core and component.

The OMX_STRING type is a 32 bit pointer to a zero terminated string. The pointer is word aligned and the string is byte aligned.

typedef OMX_S64 OMX_TICKS

Structure representing some time or duration in microseconds.

This structure must be interpreted as a signed 64 bit value. The quantity is signed to accommodate negative deltas and preroll scenarios. The quantity is represented in microseconds to accomodate high resolution timestamps (e.g. DVD presentation timestamps based on a 90kHz clock) and to allow more accurate and synchronized delivery (e.g. individual audio samples delivered at 192 kHz). The quantity is 64 bit to accommodate a large dynamic range (signed 32 bit values would allow only for plus or minus 35 minutes).

Implementations with limited precision may convert the signed 64 bit value to a signed 32 bit value internally but risk loss of precision.

typedef unsigned short OMX_U16

OMX_U16 is a 16 bit unsigned quantity that is 16 bit word aligned.

typedef unsigned long OMX_U32

OMX_U32 is a 32 bit unsigned quantity that is 32 bit word aligned.

typedef unsigned long long OMX_U64

OMX_U64 is a 64 bit unsigned quantity that is 64 bit word aligned.

typedef unsigned char OMX_U8

OMX_U8 is an 8 bit unsigned quantity that is byte aligned.

typedef unsigned char OMX_UUIDTYPE[128]

OMX_UUIDTYPE is a very long unique identifier to uniquely identify at runtime.

This identifier should be generated by a component in a way that guarantees that every instance of the identifier running on the system is unique.


Enumeration Type Documentation

enum OMX_BOOL

The OMX_BOOL type is intended to be used to represent a true or a false value when passing parameters to and from the OMX core and components.

The OMX_BOOL is a 32 bit quantity and is aligned on a 32 bit word boundary.

Enumerator:
OMX_FALSE 
OMX_TRUE 
OMX_BOOL_MAX 

The OMX_DIRTYPE enumeration is used to indicate if a port is an input or an output port.

This enumeration is common across all component types.

Enumerator:
OMX_DirInput  Port is an input port.
OMX_DirOutput  Port is an output port.
OMX_DirMax 

The OMX_ENDIANTYPE enumeration is used to indicate the bit ordering for numerical data (i.e.

big endian, or little endian).

Enumerator:
OMX_EndianBig  big endian
OMX_EndianLittle  little endian
OMX_EndianMax 

The OMX_NUMERICALDATATYPE enumeration is used to indicate if data is signed or unsigned.

Enumerator:
OMX_NumericalDataSigned  signed data
OMX_NumericalDataUnsigned  unsigned data
OMX_NumercialDataMax 


Generated on Tue May 25 08:05:13 2010 for VLC by  doxygen 1.5.6