1 /*
2  * Copyright (c) 2010 The Khronos Group Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject
10  * to the following conditions:
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23 
24 /** @file OMX_IndexExt.h - OpenMax IL version 1.1.2
25  * The OMX_IndexExt header file contains extensions to the definitions
26  * for both applications and components .
27  */
28 
29 #ifndef OMX_IndexExt_h
30 #define OMX_IndexExt_h
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif /* __cplusplus */
35 
36 /* Each OMX header shall include all required header files to allow the
37  * header to compile without errors.  The includes below are required
38  * for this header file to compile successfully
39  */
40 #include <OMX_Index.h>
41 
42 
43 /** Khronos standard extension indices.
44 
45 This enum lists the current Khronos extension indices to OpenMAX IL.
46 */
47 typedef enum OMX_INDEXEXTTYPE {
48 
49     /* Component parameters and configurations */
50     OMX_IndexExtComponentStartUnused = OMX_IndexKhronosExtensions + 0x00100000,
51     OMX_IndexConfigCallbackRequest,  /**< reference: OMX_CONFIG_CALLBACKREQUESTTYPE */
52     OMX_IndexConfigCommitMode,                      /**< reference: OMX_CONFIG_COMMITMODETYPE */
53     OMX_IndexConfigCommit,                          /**< reference: OMX_CONFIG_COMMITTYPE */
54     OMX_IndexConfigAndroidVendorExtension,          /**< reference: OMX_CONFIG_VENDOR_EXTENSIONTYPE */
55 
56     /* Port parameters and configurations */
57     OMX_IndexExtPortStartUnused = OMX_IndexKhronosExtensions + 0x00200000,
58 
59     /* Audio parameters and configurations */
60     OMX_IndexExtAudioStartUnused = OMX_IndexKhronosExtensions + 0x00400000,
61     OMX_IndexParamAudioAndroidAc3,                  /**< reference: OMX_AUDIO_PARAM_ANDROID_AC3TYPE */
62     OMX_IndexParamAudioAndroidOpus,                 /**< reference: OMX_AUDIO_PARAM_ANDROID_OPUSTYPE */
63     OMX_IndexParamAudioAndroidAacPresentation,      /**< reference: OMX_AUDIO_PARAM_ANDROID_AACPRESENTATIONTYPE */
64     OMX_IndexParamAudioAndroidEac3,                 /**< reference: OMX_AUDIO_PARAM_ANDROID_EAC3TYPE */
65     OMX_IndexParamAudioProfileQuerySupported,       /**< reference: OMX_AUDIO_PARAM_ANDROID_PROFILETYPE */
66     OMX_IndexExtAudioEndUnused,
67 
68     /* Image parameters and configurations */
69     OMX_IndexExtImageStartUnused = OMX_IndexKhronosExtensions + 0x00500000,
70 
71     /* Video parameters and configurations */
72     OMX_IndexExtVideoStartUnused = OMX_IndexKhronosExtensions + 0x00600000,
73     OMX_IndexParamNalStreamFormatSupported,         /**< reference: OMX_NALSTREAMFORMATTYPE */
74     OMX_IndexParamNalStreamFormat,                  /**< reference: OMX_NALSTREAMFORMATTYPE */
75     OMX_IndexParamNalStreamFormatSelect,            /**< reference: OMX_NALSTREAMFORMATTYPE */
76     OMX_IndexParamVideoVp8,                         /**< reference: OMX_VIDEO_PARAM_VP8TYPE */
77     OMX_IndexConfigVideoVp8ReferenceFrame,          /**< reference: OMX_VIDEO_VP8REFERENCEFRAMETYPE */
78     OMX_IndexConfigVideoVp8ReferenceFrameType,      /**< reference: OMX_VIDEO_VP8REFERENCEFRAMEINFOTYPE */
79     OMX_IndexParamVideoReserved,                    /**< Reserved for future index */
80     OMX_IndexParamVideoHevc,                        /**< reference: OMX_VIDEO_PARAM_HEVCTYPE */
81     OMX_IndexParamSliceSegments,                    /**< reference: OMX_VIDEO_SLICESEGMENTSTYPE */
82     OMX_IndexConfigAndroidIntraRefresh,             /**< reference: OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE */
83     OMX_IndexParamAndroidVideoTemporalLayering,     /**< reference: OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE */
84     OMX_IndexConfigAndroidVideoTemporalLayering,    /**< reference: OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE */
85     OMX_IndexParamVideoAndroidImageGrid = OMX_IndexExtVideoStartUnused + 16,   /**< reference: OMX_VIDEO_PARAM_ANDROID_IMAGEGRIDTYPE */
86 
87     /* Image & Video common configurations */
88     OMX_IndexExtCommonStartUnused = OMX_IndexKhronosExtensions + 0x00700000,
89 
90     /* Other configurations */
91     OMX_IndexExtOtherStartUnused = OMX_IndexKhronosExtensions + 0x00800000,
92     OMX_IndexConfigAutoFramerateConversion,         /**< reference: OMX_CONFIG_BOOLEANTYPE */
93     OMX_IndexConfigPriority,                        /**< reference: OMX_PARAM_U32TYPE */
94     OMX_IndexConfigOperatingRate,                   /**< reference: OMX_PARAM_U32TYPE in Q16 format for video and in Hz for audio */
95     OMX_IndexParamConsumerUsageBits,
96 
97     /* Time configurations */
98     OMX_IndexExtTimeStartUnused = OMX_IndexKhronosExtensions + 0x00900000,
99 
100     OMX_IndexExtMax = 0x7FFFFFFF
101 } OMX_INDEXEXTTYPE;
102 #define OMX_MAX_STRINGVALUE_SIZE OMX_MAX_STRINGNAME_SIZE
103 #define OMX_MAX_ANDROID_VENDOR_PARAMCOUNT 32
104 
105 typedef enum OMX_ANDROID_VENDOR_VALUETYPE {
106     OMX_AndroidVendorValueInt32 = 0,   /*<< int32_t value */
107     OMX_AndroidVendorValueInt64,       /*<< int64_t value */
108     OMX_AndroidVendorValueString,      /*<< string value */
109     OMX_AndroidVendorValueEndUnused,
110 } OMX_ANDROID_VENDOR_VALUETYPE;
111 
112 /**
113  *
114  *  cKey        : parameter value name.
115  *  eValueType  : parameter value type
116  *  bSet        : if false, the parameter is not set (for OMX_GetConfig) or is unset (OMX_SetConfig)
117  *                if true, the parameter is set to the corresponding value below
118  *  nInt32      : int32 value
119  *  nInt64      : int64 value
120  *  cString     : string value
121  */
122 typedef struct OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE {
123     OMX_U8 cKey[OMX_MAX_STRINGNAME_SIZE];
124     OMX_ANDROID_VENDOR_VALUETYPE eValueType;
125     OMX_BOOL bSet;
126     union {
127         OMX_S32 nInt32;
128         OMX_S64 nInt64;
129         OMX_U8 cString[OMX_MAX_STRINGVALUE_SIZE];
130     };
131 } OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE;
132 
133 /**
134  *  nSize       : size of the structure in bytes
135  *  nVersion    : OMX specification version information
136  *  cName       : name of vendor extension
137  *  nParamCount : the number of parameter values that are part of this vendor extension
138  *  nParamSizeUsed : the size of nParam
139  *                (must be at least 1 and at most OMX_MAX_ANDROID_VENDOR_PARAMCOUNT)
140  *  nParam      : the parameter values
141  */
142 typedef struct OMX_CONFIG_ANDROID_VENDOR_EXTENSIONTYPE {
143     OMX_U32 nSize;
144     OMX_VERSIONTYPE nVersion;
145     OMX_U32 nIndex;
146     OMX_U8  cName[OMX_MAX_STRINGNAME_SIZE];
147     OMX_DIRTYPE eDir;
148     OMX_U32 nParamCount;
149     OMX_U32 nParamSizeUsed;
150     OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE nParam[1];
151 } OMX_CONFIG_ANDROID_VENDOR_EXTENSIONTYPE;
152 
153 
154 #ifdef __cplusplus
155 }
156 #endif /* __cplusplus */
157 
158 #endif /* OMX_IndexExt_h */
159 /* File EOF */
160