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 /** OMX_VideoExt.h - OpenMax IL version 1.1.2 25 * The OMX_VideoExt header file contains extensions to the 26 * definitions used by both the application and the component to 27 * access video items. 28 */ 29 30 #ifndef OMX_VideoExt_h 31 #define OMX_VideoExt_h 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif /* __cplusplus */ 36 37 /* Each OMX header shall include all required header files to allow the 38 * header to compile without errors. The includes below are required 39 * for this header file to compile successfully 40 */ 41 #include <OMX_Core.h> 42 43 /** NALU Formats */ 44 typedef enum OMX_NALUFORMATSTYPE { 45 OMX_NaluFormatStartCodes = 1, 46 OMX_NaluFormatOneNaluPerBuffer = 2, 47 OMX_NaluFormatOneByteInterleaveLength = 4, 48 OMX_NaluFormatTwoByteInterleaveLength = 8, 49 OMX_NaluFormatFourByteInterleaveLength = 16, 50 OMX_NaluFormatCodingMax = 0x7FFFFFFF 51 } OMX_NALUFORMATSTYPE; 52 53 /** NAL Stream Format */ 54 typedef struct OMX_NALSTREAMFORMATTYPE{ 55 OMX_U32 nSize; 56 OMX_VERSIONTYPE nVersion; 57 OMX_U32 nPortIndex; 58 OMX_NALUFORMATSTYPE eNaluFormat; 59 } OMX_NALSTREAMFORMATTYPE; 60 61 /** AVC additional profiles */ 62 typedef enum OMX_VIDEO_AVCPROFILEEXTTYPE { 63 OMX_VIDEO_AVCProfileConstrainedBaseline = 0x10000, /**< Constrained baseline profile */ 64 OMX_VIDEO_AVCProfileConstrainedHigh = 0x80000, /**< Constrained high profile */ 65 } OMX_VIDEO_AVCPROFILEEXTTYPE; 66 67 /** VP8 profiles */ 68 typedef enum OMX_VIDEO_VP8PROFILETYPE { 69 OMX_VIDEO_VP8ProfileMain = 0x01, 70 OMX_VIDEO_VP8ProfileUnknown = 0x6EFFFFFF, 71 OMX_VIDEO_VP8ProfileMax = 0x7FFFFFFF 72 } OMX_VIDEO_VP8PROFILETYPE; 73 74 /** VP8 levels */ 75 typedef enum OMX_VIDEO_VP8LEVELTYPE { 76 OMX_VIDEO_VP8Level_Version0 = 0x01, 77 OMX_VIDEO_VP8Level_Version1 = 0x02, 78 OMX_VIDEO_VP8Level_Version2 = 0x04, 79 OMX_VIDEO_VP8Level_Version3 = 0x08, 80 OMX_VIDEO_VP8LevelUnknown = 0x6EFFFFFF, 81 OMX_VIDEO_VP8LevelMax = 0x7FFFFFFF 82 } OMX_VIDEO_VP8LEVELTYPE; 83 84 /** VP8 Param */ 85 typedef struct OMX_VIDEO_PARAM_VP8TYPE { 86 OMX_U32 nSize; 87 OMX_VERSIONTYPE nVersion; 88 OMX_U32 nPortIndex; 89 OMX_VIDEO_VP8PROFILETYPE eProfile; 90 OMX_VIDEO_VP8LEVELTYPE eLevel; 91 OMX_U32 nDCTPartitions; 92 OMX_BOOL bErrorResilientMode; 93 } OMX_VIDEO_PARAM_VP8TYPE; 94 95 /** Structure for configuring VP8 reference frames */ 96 typedef struct OMX_VIDEO_VP8REFERENCEFRAMETYPE { 97 OMX_U32 nSize; 98 OMX_VERSIONTYPE nVersion; 99 OMX_U32 nPortIndex; 100 OMX_BOOL bPreviousFrameRefresh; 101 OMX_BOOL bGoldenFrameRefresh; 102 OMX_BOOL bAlternateFrameRefresh; 103 OMX_BOOL bUsePreviousFrame; 104 OMX_BOOL bUseGoldenFrame; 105 OMX_BOOL bUseAlternateFrame; 106 } OMX_VIDEO_VP8REFERENCEFRAMETYPE; 107 108 /** Structure for querying VP8 reference frame type */ 109 typedef struct OMX_VIDEO_VP8REFERENCEFRAMEINFOTYPE { 110 OMX_U32 nSize; 111 OMX_VERSIONTYPE nVersion; 112 OMX_U32 nPortIndex; 113 OMX_BOOL bIsIntraFrame; 114 OMX_BOOL bIsGoldenOrAlternateFrame; 115 } OMX_VIDEO_VP8REFERENCEFRAMEINFOTYPE; 116 117 /** HEVC Profiles */ 118 typedef enum OMX_VIDEO_HEVCPROFILETYPE { 119 OMX_VIDEO_HEVCProfileMain = 0x01, 120 OMX_VIDEO_HEVCProfileMain10 = 0x02, 121 // Main10 profile with HDR SEI support. 122 OMX_VIDEO_HEVCProfileMain10HDR10 = 0x1000, 123 OMX_VIDEO_HEVCProfileUnknown = 0x6EFFFFFF, 124 OMX_VIDEO_HEVCProfileMax = 0x7FFFFFFF 125 } OMX_VIDEO_HEVCPROFILETYPE; 126 127 /** HEVC levels */ 128 typedef enum OMX_VIDEO_HEVCLEVELTYPE { 129 OMX_VIDEO_HEVCLevel_Version0 = 0x0, 130 OMX_VIDEO_HEVCMainTierLevel1 = 0x1, 131 OMX_VIDEO_HEVCHighTierLevel1 = 0x2, 132 OMX_VIDEO_HEVCMainTierLevel2 = 0x4, 133 OMX_VIDEO_HEVCHighTierLevel2 = 0x8, 134 OMX_VIDEO_HEVCMainTierLevel21 = 0x10, 135 OMX_VIDEO_HEVCHighTierLevel21 = 0x20, 136 OMX_VIDEO_HEVCMainTierLevel3 = 0x40, 137 OMX_VIDEO_HEVCHighTierLevel3 = 0x80, 138 OMX_VIDEO_HEVCMainTierLevel31 = 0x100, 139 OMX_VIDEO_HEVCHighTierLevel31 = 0x200, 140 OMX_VIDEO_HEVCMainTierLevel4 = 0x400, 141 OMX_VIDEO_HEVCHighTierLevel4 = 0x800, 142 OMX_VIDEO_HEVCMainTierLevel41 = 0x1000, 143 OMX_VIDEO_HEVCHighTierLevel41 = 0x2000, 144 OMX_VIDEO_HEVCMainTierLevel5 = 0x4000, 145 OMX_VIDEO_HEVCHighTierLevel5 = 0x8000, 146 OMX_VIDEO_HEVCMainTierLevel51 = 0x10000, 147 OMX_VIDEO_HEVCHighTierLevel51 = 0x20000, 148 OMX_VIDEO_HEVCMainTierLevel52 = 0x40000, 149 OMX_VIDEO_HEVCHighTierLevel52 = 0x80000, 150 OMX_VIDEO_HEVCMainTierLevel6 = 0x100000, 151 OMX_VIDEO_HEVCHighTierLevel6 = 0x200000, 152 OMX_VIDEO_HEVCMainTierLevel61 = 0x400000, 153 OMX_VIDEO_HEVCHighTierLevel61 = 0x800000, 154 OMX_VIDEO_HEVCMainTierLevel62 = 0x1000000, 155 OMX_VIDEO_HEVCLevelUnknown = 0x6EFFFFFF, 156 OMX_VIDEO_HEVCLevelMax = 0x7FFFFFFF 157 } OMX_VIDEO_HEVCLEVELTYPE; 158 159 /** HEVC Param */ 160 typedef struct OMX_VIDEO_PARAM_HEVCTYPE { 161 OMX_U32 nSize; 162 OMX_VERSIONTYPE nVersion; 163 OMX_U32 nPortIndex; 164 OMX_VIDEO_HEVCPROFILETYPE eProfile; 165 OMX_VIDEO_HEVCLEVELTYPE eLevel; 166 OMX_U32 nKeyFrameInterval; 167 } OMX_VIDEO_PARAM_HEVCTYPE; 168 169 /** 170 * Structure for configuring video compression intra refresh period 171 * 172 * STRUCT MEMBERS: 173 * nSize : Size of the structure in bytes 174 * nVersion : OMX specification version information 175 * nPortIndex : Port that this structure applies to 176 * nRefreshPeriod : Intra refreh period in frames. Value 0 means disable intra refresh 177 */ 178 typedef struct OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE { 179 OMX_U32 nSize; 180 OMX_VERSIONTYPE nVersion; 181 OMX_U32 nPortIndex; 182 OMX_U32 nRefreshPeriod; 183 } OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE; 184 185 /** Maximum number of temporal layers supported by AVC/HEVC */ 186 #define OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS 8 187 188 /** temporal layer patterns */ 189 typedef enum OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE { 190 OMX_VIDEO_AndroidTemporalLayeringPatternNone = 0, 191 // pattern as defined by WebRTC 192 OMX_VIDEO_AndroidTemporalLayeringPatternWebRTC = 1 << 0, 193 // pattern where frames in any layer other than the base layer only depend on at most the very 194 // last frame from each preceding layer (other than the base layer.) 195 OMX_VIDEO_AndroidTemporalLayeringPatternAndroid = 1 << 1, 196 } OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE; 197 198 /** 199 * Android specific param for configuration of temporal layering. 200 * Android only supports temporal layering where successive layers each double the 201 * previous layer's framerate. 202 * NOTE: Reading this parameter at run-time SHALL return actual run-time values. 203 * 204 * nSize : Size of the structure in bytes 205 * nVersion : OMX specification version information 206 * nPortIndex : Port that this structure applies to (output port for encoders) 207 * eSupportedPatterns : A bitmask of supported layering patterns 208 * nLayerCountMax : Max number of temporal coding layers supported 209 * by the encoder (must be at least 1, 1 meaning temporal layering 210 * is NOT supported) 211 * nBLayerCountMax : Max number of layers that can contain B frames 212 * (0) to (nLayerCountMax - 1) 213 * ePattern : Layering pattern. 214 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames, 215 * starting from and including the base-layer. 216 * (1 to nLayerCountMax - nBLayerCountActual) 217 * If nPLayerCountActual is 1 and nBLayerCountActual is 0, temporal 218 * layering is disabled. Otherwise, it is enabled. 219 * nBLayerCountActual : Number of temporal layers to be coded with B frames, 220 * starting after non-B layers. 221 * (0 to nBLayerCountMax) 222 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 223 * distribution is specified. 224 * nBitrateRatios : Bitrate ratio (100 based) per layer (index 0 is base layer). 225 * Honored if bBitrateRatiosSpecified is set. 226 * i.e for 4 layers with desired distribution (25% 25% 25% 25%), 227 * nBitrateRatio = {25, 50, 75, 100, ... } 228 * Values in indices not less than 'the actual number of layers 229 * minus 1' MAY be ignored and assumed to be 100. 230 */ 231 typedef struct OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE { 232 OMX_U32 nSize; 233 OMX_VERSIONTYPE nVersion; 234 OMX_U32 nPortIndex; 235 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE eSupportedPatterns; 236 OMX_U32 nLayerCountMax; 237 OMX_U32 nBLayerCountMax; 238 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 239 OMX_U32 nPLayerCountActual; 240 OMX_U32 nBLayerCountActual; 241 OMX_BOOL bBitrateRatiosSpecified; 242 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 243 } OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE; 244 245 /** 246 * Android specific config for changing the temporal-layer count or 247 * bitrate-distribution at run-time. 248 * 249 * nSize : Size of the structure in bytes 250 * nVersion : OMX specification version information 251 * nPortIndex : Port that this structure applies to (output port for encoders) 252 * ePattern : Layering pattern. 253 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames. 254 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 255 * nBLayerCountActual : Number of temporal layers to be coded with B frames. 256 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 257 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 258 * distribution is specified. 259 * nBitrateRatios : Bitrate ratio (100 based, Q16 values) per layer (0 is base layer). 260 * Honored if bBitrateRatiosSpecified is set. 261 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 262 */ 263 typedef struct OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE { 264 OMX_U32 nSize; 265 OMX_VERSIONTYPE nVersion; 266 OMX_U32 nPortIndex; 267 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 268 OMX_U32 nPLayerCountActual; 269 OMX_U32 nBLayerCountActual; 270 OMX_BOOL bBitrateRatiosSpecified; 271 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 272 } OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE; 273 274 #ifdef __cplusplus 275 } 276 #endif /* __cplusplus */ 277 278 #endif /* OMX_VideoExt_h */ 279 /* File EOF */ 280