diff options
Diffstat (limited to 'include/media/openmax/OMX_Types.h')
| -rw-r--r-- | include/media/openmax/OMX_Types.h | 100 |
1 files changed, 50 insertions, 50 deletions
diff --git a/include/media/openmax/OMX_Types.h b/include/media/openmax/OMX_Types.h index 71e346a..5afaba0 100644 --- a/include/media/openmax/OMX_Types.h +++ b/include/media/openmax/OMX_Types.h @@ -16,32 +16,32 @@ * ------------------------------------------------------------------- */ /* - * Copyright (c) 2008 The Khronos Group Inc. - * + * Copyright (c) 2008 The Khronos Group Inc. + * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject - * to the following conditions: + * to the following conditions: * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * + * in all copies or substantial portions of the Software. + * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * */ /** OMX_Types.h - OpenMax IL version 1.1.2 - * The OMX_Types header file contains the primitive type definitions used by + * 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, + * 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. */ @@ -57,12 +57,12 @@ extern "C" { /** 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 */ -#ifdef __SYMBIAN32__ +#ifdef __SYMBIAN32__ # ifdef __OMX_EXPORTS # define OMX_API __declspec(dllexport) # else # ifdef _WIN32 -# define OMX_API __declspec(dllexport) +# define OMX_API __declspec(dllexport) # else # define OMX_API __declspec(dllimport) # endif @@ -85,18 +85,18 @@ extern "C" { #endif #ifndef OMX_APIENTRY -#define OMX_APIENTRY -#endif +#define OMX_APIENTRY +#endif -/** 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 +/** 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. */ #ifndef OMX_IN #define OMX_IN #endif -/** 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 +/** 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. */ #ifndef OMX_OUT #define OMX_OUT @@ -104,8 +104,8 @@ extern "C" { /** 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 + 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. */ #ifndef OMX_INOUT #define OMX_INOUT @@ -123,31 +123,31 @@ extern "C" { /** @defgroup core OpenMAX IL core * Functions and structure related to the OMX IL core */ - + /** @defgroup comp OpenMAX IL component * Functions and structure related to the OMX IL component */ - -/** @defgroup rpm Resource and Policy Management + +/** @defgroup rpm Resource and Policy Management * Structures for resource and policy management of components */ /** @defgroup buf Buffer Management * Buffer handling functions and structures */ - + /** @defgroup tun Tunneling * @ingroup core comp * Structures and functions to manage tunnels among component ports */ - + /** @defgroup cp Content Pipes * @ingroup core */ - + /** @defgroup metadata Metadata handling - * - */ + * + */ /** OMX_U8 is an 8 bit unsigned quantity that is byte aligned */ typedef unsigned char OMX_U8; @@ -169,7 +169,7 @@ typedef int32_t OMX_S32; /* Users with compilers that cannot accept the "long long" designation should - define the OMX_SKIP64BIT macro. It should be noted that this may cause + define the OMX_SKIP64BIT macro. It should be noted that this may cause some components to fail to compile if the component was written to require 64 bit integral types. However, these components would NOT compile anyway since the compiler does not support the way the component was written. @@ -184,7 +184,7 @@ typedef signed long long OMX_S64; #elif defined(WIN32) -/** OMX_U64 is a 64 bit unsigned quantity that is 64 bit word aligned */ +/** OMX_U64 is a 64 bit unsigned quantity that is 64 bit word aligned */ typedef unsigned __int64 OMX_U64; /** OMX_S64 is a 64 bit signed quantity that is 64 bit word aligned */ @@ -202,7 +202,7 @@ typedef signed long long OMX_S64; #endif -/** The OMX_BOOL type is intended to be used to represent a true or a false +/** 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. */ @@ -210,7 +210,7 @@ typedef enum OMX_BOOL { OMX_FALSE = 0, OMX_TRUE = !OMX_FALSE, OMX_BOOL_MAX = 0x7FFFFFFF -} OMX_BOOL; +} OMX_BOOL; /* * Temporary Android 64 bit modification @@ -237,14 +237,14 @@ typedef OMX_PTR OMX_BYTE; typedef void* OMX_PTR; /** 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. + 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 char* OMX_STRING; /** 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 + 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. */ @@ -259,7 +259,7 @@ typedef unsigned char* OMX_BYTE; typedef unsigned char OMX_UUIDTYPE[128]; /** 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. + an output port. This enumeration is common across all component types. */ typedef enum OMX_DIRTYPE { @@ -268,8 +268,8 @@ typedef enum OMX_DIRTYPE OMX_DirMax = 0x7FFFFFFF } OMX_DIRTYPE; -/** The OMX_ENDIANTYPE enumeration is used to indicate the bit ordering - for numerical data (i.e. big endian, or little endian). +/** The OMX_ENDIANTYPE enumeration is used to indicate the bit ordering + for numerical data (i.e. big endian, or little endian). */ typedef enum OMX_ENDIANTYPE { @@ -279,7 +279,7 @@ typedef enum OMX_ENDIANTYPE } OMX_ENDIANTYPE; -/** The OMX_NUMERICALDATATYPE enumeration is used to indicate if data +/** The OMX_NUMERICALDATATYPE enumeration is used to indicate if data is signed or unsigned */ typedef enum OMX_NUMERICALDATATYPE @@ -307,16 +307,16 @@ typedef struct OMX_BS32 { /** 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 + * 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 + * 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. + * Implementations with limited precision may convert the signed 64 bit value to + * a signed 32 bit value internally but risk loss of precision. */ #ifndef OMX_SKIP64BIT typedef OMX_S64 OMX_TICKS; @@ -336,17 +336,17 @@ typedef OMX_PTR OMX_HANDLETYPE; typedef struct OMX_MARKTYPE { - OMX_HANDLETYPE hMarkTargetComponent; /**< The component that will - generate a mark event upon + OMX_HANDLETYPE hMarkTargetComponent; /**< The component that will + generate a mark event upon processing the mark. */ - OMX_PTR pMarkData; /**< Application specific data associated with - the mark sent on a mark event to disambiguate + OMX_PTR pMarkData; /**< Application specific data associated with + the mark sent on a mark event to disambiguate this mark from others. */ } OMX_MARKTYPE; /** OMX_NATIVE_DEVICETYPE is used to map a OMX video port to the - * platform & operating specific object used to reference the display + * platform & operating specific object used to reference the display * or can be used by a audio port for native audio rendering */ typedef OMX_PTR OMX_NATIVE_DEVICETYPE; @@ -357,7 +357,7 @@ typedef OMX_PTR OMX_NATIVE_WINDOWTYPE; /** 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 + 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 |