OpenMAXBellagio  0.9.3
OMX_Types.h File Reference

Go to the source code of this file.

Data Structures

struct  OMX_BU32
 
struct  OMX_BS32
 
struct  OMX_MARKTYPE
 
union  OMX_VERSIONTYPE
 

Macros

#define OMX_API   extern
 
#define OMX_APIENTRY
 
#define OMX_IN
 
#define OMX_OUT
 
#define OMX_INOUT
 
#define OMX_ALL   0xFFFFFFFF
 
#define OMX_TICKS_PER_SECOND   1000000
 

Typedefs

typedef unsigned char OMX_U8
 
typedef signed char OMX_S8
 
typedef unsigned short OMX_U16
 
typedef signed short OMX_S16
 
typedef unsigned long OMX_U32
 
typedef signed long OMX_S32
 
typedef unsigned long long OMX_U64
 
typedef signed long long OMX_S64
 
typedef enum OMX_BOOL OMX_BOOL
 
typedef void * OMX_PTR
 
typedef char * OMX_STRING
 
typedef unsigned char * OMX_BYTE
 
typedef unsigned char OMX_UUIDTYPE [128]
 
typedef enum OMX_DIRTYPE OMX_DIRTYPE
 
typedef enum OMX_ENDIANTYPE OMX_ENDIANTYPE
 
typedef enum OMX_NUMERICALDATATYPE OMX_NUMERICALDATATYPE
 
typedef struct OMX_BU32 OMX_BU32
 
typedef struct OMX_BS32 OMX_BS32
 
typedef OMX_S64 OMX_TICKS
 
typedef void * OMX_HANDLETYPE
 
typedef struct OMX_MARKTYPE OMX_MARKTYPE
 
typedef void * OMX_NATIVE_DEVICETYPE
 
typedef void * OMX_NATIVE_WINDOWTYPE
 
typedef union OMX_VERSIONTYPE OMX_VERSIONTYPE
 

Enumerations

enum  OMX_BOOL { OMX_FALSE = 0, OMX_TRUE = !OMX_FALSE, OMX_BOOL_MAX = 0x7FFFFFFF }
 
enum  OMX_DIRTYPE { OMX_DirInput, OMX_DirOutput, OMX_DirMax = 0x7FFFFFFF }
 
enum  OMX_ENDIANTYPE { OMX_EndianBig, OMX_EndianLittle, OMX_EndianMax = 0x7FFFFFFF }
 
enum  OMX_NUMERICALDATATYPE { OMX_NumericalDataSigned, OMX_NumericalDataUnsigned, OMX_NumercialDataMax = 0x7FFFFFFF }
 

Macro Definition Documentation

#define OMX_ALL   0xFFFFFFFF

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.

Definition at line 99 of file OMX_Types.h.

Referenced by omx_base_component_MessageHandler(), omx_base_component_SendCommand(), and omx_clocksrc_component_SendCommand().

#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

Definition at line 62 of file OMX_Types.h.

#define OMX_APIENTRY

Definition at line 68 of file OMX_Types.h.

#define OMX_IN

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.

Definition at line 75 of file OMX_Types.h.

#define OMX_INOUT

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.

Definition at line 91 of file OMX_Types.h.

#define OMX_OUT

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.

Definition at line 82 of file OMX_Types.h.

#define OMX_TICKS_PER_SECOND   1000000

Definition at line 290 of file OMX_Types.h.

Typedef Documentation

typedef enum OMX_BOOL 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.

typedef struct OMX_BS32 OMX_BS32

Signed bounded value type

typedef struct OMX_BU32 OMX_BU32

Unsigned bounded value type

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.

Definition at line 213 of file OMX_Types.h.

typedef enum OMX_DIRTYPE OMX_DIRTYPE

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.

The OMX_ENDIANTYPE enumeration is used to indicate the bit ordering for numerical data (i.e. big endian, or little endian).

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.

Definition at line 295 of file OMX_Types.h.

typedef struct OMX_MARKTYPE OMX_MARKTYPE
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

Definition at line 311 of file OMX_Types.h.

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

Definition at line 315 of file OMX_Types.h.

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

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.

Definition at line 199 of file OMX_Types.h.

typedef signed short OMX_S16

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

Definition at line 142 of file OMX_Types.h.

typedef signed long OMX_S32

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

Definition at line 148 of file OMX_Types.h.

typedef signed long long OMX_S64

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

Definition at line 179 of file OMX_Types.h.

typedef signed char OMX_S8

OMX_S8 is an 8 bit signed quantity that is byte aligned

Definition at line 136 of file OMX_Types.h.

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.

Definition at line 206 of file OMX_Types.h.

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.

Definition at line 282 of file OMX_Types.h.

typedef unsigned short OMX_U16

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

Definition at line 139 of file OMX_Types.h.

typedef unsigned long OMX_U32

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

Definition at line 145 of file OMX_Types.h.

typedef unsigned long long OMX_U64

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

Definition at line 176 of file OMX_Types.h.

typedef unsigned char OMX_U8

OMX_U8 is an 8 bit unsigned quantity that is byte aligned

Definition at line 133 of file OMX_Types.h.

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.

Definition at line 219 of file OMX_Types.h.

The OMX_VERSIONTYPE union is used to specify the version for a structure or component. For a component, the version is entirely specified by the component vendor. Components doing the same function from different vendors may or may not have the same version. For structures, the version shall be set by the entity that allocates the structure. For structures specified in the OMX 1.1 specification, the value of the version shall be set to 1.1.0.0 in all cases. Access to the OMX_VERSIONTYPE can be by a single 32 bit access (e.g. by nVersion) or by accessing one of the structure elements to, for example, check only the Major revision.

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 

Definition at line 189 of file OMX_Types.h.

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 

Definition at line 224 of file OMX_Types.h.

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 

Definition at line 234 of file OMX_Types.h.

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 

Definition at line 245 of file OMX_Types.h.


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