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_IndexParamVideoAndroidVp8Encoder, /**< reference: OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE */ 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_IndexParamMaxFrameDurationForBitrateControl,/**< reference: OMX_PARAM_U32TYPE */ 86 OMX_IndexParamVideoVp9, /**< reference: OMX_VIDEO_PARAM_VP9TYPE */ 87 OMX_IndexParamVideoAndroidVp9Encoder, /**< reference: OMX_VIDEO_PARAM_ANDROID_VP9ENCODERTYPE */ 88 OMX_IndexExtVideoEndUnused, 89 90 /* Image & Video common configurations */ 91 OMX_IndexExtCommonStartUnused = OMX_IndexKhronosExtensions + 0x00700000, 92 93 /* Other configurations */ 94 OMX_IndexExtOtherStartUnused = OMX_IndexKhronosExtensions + 0x00800000, 95 OMX_IndexConfigAutoFramerateConversion, /**< reference: OMX_CONFIG_BOOLEANTYPE */ 96 OMX_IndexConfigPriority, /**< reference: OMX_PARAM_U32TYPE */ 97 OMX_IndexConfigOperatingRate, /**< reference: OMX_PARAM_U32TYPE in Q16 format for video and in Hz for audio */ 98 OMX_IndexParamConsumerUsageBits, /**< reference: OMX_PARAM_U32TYPE */ 99 OMX_IndexConfigLatency, /**< reference: OMX_PARAM_U32TYPE */ 100 OMX_IndexExtOtherEndUnused, 101 102 /* Time configurations */ 103 OMX_IndexExtTimeStartUnused = OMX_IndexKhronosExtensions + 0x00900000, 104 105 OMX_IndexExtMax = 0x7FFFFFFF 106 } OMX_INDEXEXTTYPE; 107 108 #define OMX_MAX_STRINGVALUE_SIZE OMX_MAX_STRINGNAME_SIZE 109 #define OMX_MAX_ANDROID_VENDOR_PARAMCOUNT 32 110 111 typedef enum OMX_ANDROID_VENDOR_VALUETYPE { 112 OMX_AndroidVendorValueInt32 = 0, /*<< int32_t value */ 113 OMX_AndroidVendorValueInt64, /*<< int64_t value */ 114 OMX_AndroidVendorValueString, /*<< string value */ 115 OMX_AndroidVendorValueEndUnused, 116 } OMX_ANDROID_VENDOR_VALUETYPE; 117 118 /** 119 * Structure describing a single value of an Android vendor extension. 120 * 121 * STRUCTURE MEMBERS: 122 * cKey : parameter value name. 123 * eValueType : parameter value type 124 * bSet : if false, the parameter is not set (for OMX_GetConfig) or is unset (OMX_SetConfig) 125 * if true, the parameter is set to the corresponding value below 126 * nInt64 : int64 value 127 * cString : string value 128 */ 129 typedef struct OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE { 130 OMX_U8 cKey[OMX_MAX_STRINGNAME_SIZE]; 131 OMX_ANDROID_VENDOR_VALUETYPE eValueType; 132 OMX_BOOL bSet; 133 union { 134 OMX_S32 nInt32; 135 OMX_S64 nInt64; 136 OMX_U8 cString[OMX_MAX_STRINGVALUE_SIZE]; 137 }; 138 } OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE; 139 140 /** 141 * OMX_CONFIG_ANDROID_VENDOR_EXTENSIONTYPE is the structure for an Android vendor extension 142 * supported by the component. This structure enumerates the various extension parameters and their 143 * values. 144 * 145 * Android vendor extensions have a name and one or more parameter values - each with a string key - 146 * that are set together. The values are exposed to Android applications via a string key that is 147 * the concatenation of 'vendor', the extension name and the parameter key, each separated by dot 148 * (.), with any trailing '.value' suffix(es) removed (though optionally allowed). 149 * 150 * Extension names and parameter keys are subject to the following rules: 151 * - Each SHALL contain a set of lowercase alphanumeric (underscore allowed) tags separated by 152 * dot (.) or dash (-). 153 * - The first character of the first tag, and any tag following a dot SHALL not start with a 154 * digit. 155 * - Tags 'value', 'vendor', 'omx' and 'android' (even if trailed and/or followed by any number 156 * of underscores) are prohibited in the extension name. 157 * - Tags 'vendor', 'omx' and 'android' (even if trailed and/or followed by any number 158 * of underscores) are prohibited in parameter keys. 159 * - The tag 'value' (even if trailed and/or followed by any number 160 * of underscores) is prohibited in parameter keys with the following exception: 161 * the parameter key may be exactly 'value' 162 * - The parameter key for extensions with a single parameter value SHALL be 'value' 163 * - No two extensions SHALL have the same name 164 * - No extension's name SHALL start with another extension's NAME followed by a dot (.) 165 * - No two parameters of an extension SHALL have the same key 166 * 167 * This config can be used with both OMX_GetConfig and OMX_SetConfig. In the OMX_GetConfig 168 * case, the caller specifies nIndex and nParamSizeUsed. The component fills in cName, 169 * eDir and nParamCount. Additionally, if nParamSizeUsed is not less than nParamCount, the 170 * component fills out the parameter values (nParam) with the current values for each parameter 171 * of the vendor extension. 172 * 173 * The value of nIndex goes from 0 to N-1, where N is the number of Android vendor extensions 174 * supported by the component. The component does not need to report N as the caller can determine 175 * N by enumerating all extensions supported by the component. The component may not support any 176 * extensions. If there are no more extensions, OMX_GetParameter returns OMX_ErrorNoMore. The 177 * component supplies extensions in the order it wants clients to set them. 178 * 179 * The component SHALL return OMX_ErrorNone for all cases where nIndex is less than N (specifically 180 * even in the case of where nParamCount is greater than nParamSizeUsed). 181 * 182 * In the OMX_SetConfig case the field nIndex is ignored. If the component supports an Android 183 * vendor extension with the name in cName, it SHALL configure the parameter values for that 184 * extension according to the parameters in nParam. nParamCount is the number of valid parameters 185 * in the nParam array, and nParamSizeUsed is the size of the nParam array. (nParamSizeUsed 186 * SHALL be at least nParamCount) Parameters that are part of a vendor extension but are not 187 * in the nParam array are assumed to be unset (this is different from not changed). 188 * All parameter values SHALL have distinct keys in nParam (the component can assume that this 189 * is the case. Otherwise, the actual value for the parameters that are multiply defined can 190 * be any of the set values.) 191 * 192 * Return values in case of OMX_SetConfig: 193 * OMX_ErrorUnsupportedIndex: the component does not support the extension specified by cName 194 * OMX_ErrorUnsupportedSetting: the component does not support some or any of the parameters 195 * (names) specified in nParam 196 * OMX_ErrorBadParameter: the parameter is invalid (e.g. nParamCount is greater than 197 * nParamSizeUsed, or some parameter value has invalid type) 198 * 199 * STRUCTURE MEMBERS: 200 * nSize : size of the structure in bytes 201 * nVersion : OMX specification version information 202 * cName : name of vendor extension 203 * nParamCount : the number of parameter values that are part of this vendor extension 204 * nParamSizeUsed : the size of nParam 205 * (must be at least 1 and at most OMX_MAX_ANDROID_VENDOR_PARAMCOUNT) 206 * param : the parameter values 207 */ 208 typedef struct OMX_CONFIG_ANDROID_VENDOR_EXTENSIONTYPE { 209 OMX_U32 nSize; 210 OMX_VERSIONTYPE nVersion; 211 OMX_U32 nIndex; 212 OMX_U8 cName[OMX_MAX_STRINGNAME_SIZE]; 213 OMX_DIRTYPE eDir; 214 OMX_U32 nParamCount; 215 OMX_U32 nParamSizeUsed; 216 OMX_CONFIG_ANDROID_VENDOR_PARAMTYPE param[1]; 217 } OMX_CONFIG_ANDROID_VENDOR_EXTENSIONTYPE; 218 219 #ifdef __cplusplus 220 } 221 #endif /* __cplusplus */ 222 223 #endif /* OMX_IndexExt_h */ 224 /* File EOF */ 225
