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 /** Maximum number of VP8 temporal layers */ 118 #define OMX_VIDEO_ANDROID_MAXVP8TEMPORALLAYERS 3 119 120 /** VP8 temporal layer patterns */ 121 typedef enum OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE { 122 OMX_VIDEO_VPXTemporalLayerPatternNone = 0, 123 OMX_VIDEO_VPXTemporalLayerPatternWebRTC = 1, 124 OMX_VIDEO_VPXTemporalLayerPatternMax = 0x7FFFFFFF 125 } OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE; 126 127 /** 128 * Android specific VP8/VP9 encoder params 129 * 130 * STRUCT MEMBERS: 131 * nSize : Size of the structure in bytes 132 * nVersion : OMX specification version information 133 * nPortIndex : Port that this structure applies to 134 * nKeyFrameInterval : Key frame interval in frames 135 * eTemporalPattern : Type of temporal layer pattern 136 * nTemporalLayerCount : Number of temporal coding layers 137 * nTemporalLayerBitrateRatio : Bitrate ratio allocation between temporal 138 * streams in percentage 139 * nMinQuantizer : Minimum (best quality) quantizer 140 * nMaxQuantizer : Maximum (worst quality) quantizer 141 */ 142 typedef struct OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE { 143 OMX_U32 nSize; 144 OMX_VERSIONTYPE nVersion; 145 OMX_U32 nPortIndex; 146 OMX_U32 nKeyFrameInterval; // distance between consecutive key_frames (including one 147 // of the key_frames). 0 means interval is unspecified and 148 // can be freely chosen by the codec. 1 means a stream of 149 // only key_frames. 150 151 OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE eTemporalPattern; 152 OMX_U32 nTemporalLayerCount; 153 OMX_U32 nTemporalLayerBitrateRatio[OMX_VIDEO_ANDROID_MAXVP8TEMPORALLAYERS]; 154 OMX_U32 nMinQuantizer; 155 OMX_U32 nMaxQuantizer; 156 } OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE; 157 158 /** VP9 profiles */ 159 typedef enum OMX_VIDEO_VP9PROFILETYPE { 160 OMX_VIDEO_VP9Profile0 = 0x1, 161 OMX_VIDEO_VP9Profile1 = 0x2, 162 OMX_VIDEO_VP9Profile2 = 0x4, 163 OMX_VIDEO_VP9Profile3 = 0x8, 164 // HDR profiles also support passing HDR metadata 165 OMX_VIDEO_VP9Profile2HDR = 0x1000, 166 OMX_VIDEO_VP9Profile3HDR = 0x2000, 167 OMX_VIDEO_VP9ProfileUnknown = 0x6EFFFFFF, 168 OMX_VIDEO_VP9ProfileMax = 0x7FFFFFFF 169 } OMX_VIDEO_VP9PROFILETYPE; 170 171 /** VP9 levels */ 172 typedef enum OMX_VIDEO_VP9LEVELTYPE { 173 OMX_VIDEO_VP9Level1 = 0x1, 174 OMX_VIDEO_VP9Level11 = 0x2, 175 OMX_VIDEO_VP9Level2 = 0x4, 176 OMX_VIDEO_VP9Level21 = 0x8, 177 OMX_VIDEO_VP9Level3 = 0x10, 178 OMX_VIDEO_VP9Level31 = 0x20, 179 OMX_VIDEO_VP9Level4 = 0x40, 180 OMX_VIDEO_VP9Level41 = 0x80, 181 OMX_VIDEO_VP9Level5 = 0x100, 182 OMX_VIDEO_VP9Level51 = 0x200, 183 OMX_VIDEO_VP9Level52 = 0x400, 184 OMX_VIDEO_VP9Level6 = 0x800, 185 OMX_VIDEO_VP9Level61 = 0x1000, 186 OMX_VIDEO_VP9Level62 = 0x2000, 187 OMX_VIDEO_VP9LevelUnknown = 0x6EFFFFFF, 188 OMX_VIDEO_VP9LevelMax = 0x7FFFFFFF 189 } OMX_VIDEO_VP9LEVELTYPE; 190 191 /** 192 * VP9 Parameters. 193 * Encoder specific parameters (decoders should ignore these fields): 194 * - bErrorResilientMode 195 * - nTileRows 196 * - nTileColumns 197 * - bEnableFrameParallelDecoding 198 */ 199 typedef struct OMX_VIDEO_PARAM_VP9TYPE { 200 OMX_U32 nSize; 201 OMX_VERSIONTYPE nVersion; 202 OMX_U32 nPortIndex; 203 OMX_VIDEO_VP9PROFILETYPE eProfile; 204 OMX_VIDEO_VP9LEVELTYPE eLevel; 205 OMX_BOOL bErrorResilientMode; 206 OMX_U32 nTileRows; 207 OMX_U32 nTileColumns; 208 OMX_BOOL bEnableFrameParallelDecoding; 209 } OMX_VIDEO_PARAM_VP9TYPE; 210 211 /** HEVC Profile enum type */ 212 typedef enum OMX_VIDEO_HEVCPROFILETYPE { 213 OMX_VIDEO_HEVCProfileUnknown = 0x0, 214 OMX_VIDEO_HEVCProfileMain = 0x1, 215 OMX_VIDEO_HEVCProfileMain10 = 0x2, 216 // Main10 profile with HDR SEI support. 217 OMX_VIDEO_HEVCProfileMain10HDR10 = 0x1000, 218 OMX_VIDEO_HEVCProfileMax = 0x7FFFFFFF 219 } OMX_VIDEO_HEVCPROFILETYPE; 220 221 /** HEVC Level enum type */ 222 typedef enum OMX_VIDEO_HEVCLEVELTYPE { 223 OMX_VIDEO_HEVCLevelUnknown = 0x0, 224 OMX_VIDEO_HEVCMainTierLevel1 = 0x1, 225 OMX_VIDEO_HEVCHighTierLevel1 = 0x2, 226 OMX_VIDEO_HEVCMainTierLevel2 = 0x4, 227 OMX_VIDEO_HEVCHighTierLevel2 = 0x8, 228 OMX_VIDEO_HEVCMainTierLevel21 = 0x10, 229 OMX_VIDEO_HEVCHighTierLevel21 = 0x20, 230 OMX_VIDEO_HEVCMainTierLevel3 = 0x40, 231 OMX_VIDEO_HEVCHighTierLevel3 = 0x80, 232 OMX_VIDEO_HEVCMainTierLevel31 = 0x100, 233 OMX_VIDEO_HEVCHighTierLevel31 = 0x200, 234 OMX_VIDEO_HEVCMainTierLevel4 = 0x400, 235 OMX_VIDEO_HEVCHighTierLevel4 = 0x800, 236 OMX_VIDEO_HEVCMainTierLevel41 = 0x1000, 237 OMX_VIDEO_HEVCHighTierLevel41 = 0x2000, 238 OMX_VIDEO_HEVCMainTierLevel5 = 0x4000, 239 OMX_VIDEO_HEVCHighTierLevel5 = 0x8000, 240 OMX_VIDEO_HEVCMainTierLevel51 = 0x10000, 241 OMX_VIDEO_HEVCHighTierLevel51 = 0x20000, 242 OMX_VIDEO_HEVCMainTierLevel52 = 0x40000, 243 OMX_VIDEO_HEVCHighTierLevel52 = 0x80000, 244 OMX_VIDEO_HEVCMainTierLevel6 = 0x100000, 245 OMX_VIDEO_HEVCHighTierLevel6 = 0x200000, 246 OMX_VIDEO_HEVCMainTierLevel61 = 0x400000, 247 OMX_VIDEO_HEVCHighTierLevel61 = 0x800000, 248 OMX_VIDEO_HEVCMainTierLevel62 = 0x1000000, 249 OMX_VIDEO_HEVCHighTierLevel62 = 0x2000000, 250 OMX_VIDEO_HEVCHighTiermax = 0x7FFFFFFF 251 } OMX_VIDEO_HEVCLEVELTYPE; 252 253 /** Structure for controlling HEVC video encoding */ 254 typedef struct OMX_VIDEO_PARAM_HEVCTYPE { 255 OMX_U32 nSize; 256 OMX_VERSIONTYPE nVersion; 257 OMX_U32 nPortIndex; 258 OMX_VIDEO_HEVCPROFILETYPE eProfile; 259 OMX_VIDEO_HEVCLEVELTYPE eLevel; 260 OMX_U32 nKeyFrameInterval; // distance between consecutive I-frames (including one 261 // of the I frames). 0 means interval is unspecified and 262 // can be freely chosen by the codec. 1 means a stream of 263 // only I frames. 264 } OMX_VIDEO_PARAM_HEVCTYPE; 265 266 /** Structure to define if dependent slice segments should be used */ 267 typedef struct OMX_VIDEO_SLICESEGMENTSTYPE { 268 OMX_U32 nSize; 269 OMX_VERSIONTYPE nVersion; 270 OMX_U32 nPortIndex; 271 OMX_BOOL bDepedentSegments; 272 OMX_BOOL bEnableLoopFilterAcrossSlices; 273 } OMX_VIDEO_SLICESEGMENTSTYPE; 274 275 /** Structure to return timestamps of rendered output frames as well as EOS 276 * for tunneled components. 277 */ 278 typedef struct OMX_VIDEO_RENDEREVENTTYPE { 279 OMX_S64 nMediaTimeUs; // timestamp of rendered video frame 280 OMX_S64 nSystemTimeNs; // system monotonic time at the time frame was rendered 281 // Use INT64_MAX for nMediaTimeUs to signal that the EOS 282 // has been reached. In this case, nSystemTimeNs MUST be 283 // the system time when the last frame was rendered. 284 // This MUST be done in addition to returning (and 285 // following) the render information for the last frame. 286 } OMX_VIDEO_RENDEREVENTTYPE; 287 288 /** Dolby Vision Profile enum type */ 289 typedef enum OMX_VIDEO_DOLBYVISIONPROFILETYPE { 290 OMX_VIDEO_DolbyVisionProfileUnknown = 0x0, 291 OMX_VIDEO_DolbyVisionProfileDvavPer = 0x1, 292 OMX_VIDEO_DolbyVisionProfileDvavPen = 0x2, 293 OMX_VIDEO_DolbyVisionProfileDvheDer = 0x4, 294 OMX_VIDEO_DolbyVisionProfileDvheDen = 0x8, 295 OMX_VIDEO_DolbyVisionProfileDvheDtr = 0x10, 296 OMX_VIDEO_DolbyVisionProfileDvheStn = 0x20, 297 OMX_VIDEO_DolbyVisionProfileDvheDth = 0x40, 298 OMX_VIDEO_DolbyVisionProfileDvheDtb = 0x80, 299 OMX_VIDEO_DolbyVisionProfileDvheSt = 0x100, 300 OMX_VIDEO_DolbyVisionProfileDvavSe = 0x200, 301 OMX_VIDEO_DolbyVisionProfileMax = 0x7FFFFFFF 302 } OMX_VIDEO_DOLBYVISIONPROFILETYPE; 303 304 /** Dolby Vision Level enum type */ 305 typedef enum OMX_VIDEO_DOLBYVISIONLEVELTYPE { 306 OMX_VIDEO_DolbyVisionLevelUnknown = 0x0, 307 OMX_VIDEO_DolbyVisionLevelHd24 = 0x1, 308 OMX_VIDEO_DolbyVisionLevelHd30 = 0x2, 309 OMX_VIDEO_DolbyVisionLevelFhd24 = 0x4, 310 OMX_VIDEO_DolbyVisionLevelFhd30 = 0x8, 311 OMX_VIDEO_DolbyVisionLevelFhd60 = 0x10, 312 OMX_VIDEO_DolbyVisionLevelUhd24 = 0x20, 313 OMX_VIDEO_DolbyVisionLevelUhd30 = 0x40, 314 OMX_VIDEO_DolbyVisionLevelUhd48 = 0x80, 315 OMX_VIDEO_DolbyVisionLevelUhd60 = 0x100, 316 OMX_VIDEO_DolbyVisionLevelmax = 0x7FFFFFFF 317 } OMX_VIDEO_DOLBYVISIONLEVELTYPE; 318 319 /** 320 * Structure for configuring video compression intra refresh period 321 * 322 * STRUCT MEMBERS: 323 * nSize : Size of the structure in bytes 324 * nVersion : OMX specification version information 325 * nPortIndex : Port that this structure applies to 326 * nRefreshPeriod : Intra refreh period in frames. Value 0 means disable intra refresh 327 */ 328 typedef struct OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE { 329 OMX_U32 nSize; 330 OMX_VERSIONTYPE nVersion; 331 OMX_U32 nPortIndex; 332 OMX_U32 nRefreshPeriod; 333 } OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE; 334 335 /** Maximum number of temporal layers supported by AVC/HEVC */ 336 #define OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS 8 337 338 /** temporal layer patterns */ 339 typedef enum OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE { 340 OMX_VIDEO_AndroidTemporalLayeringPatternNone = 0, 341 // pattern as defined by WebRTC 342 OMX_VIDEO_AndroidTemporalLayeringPatternWebRTC = 1 << 0, 343 // pattern where frames in any layer other than the base layer only depend on at most the very 344 // last frame from each preceding layer (other than the base layer.) 345 OMX_VIDEO_AndroidTemporalLayeringPatternAndroid = 1 << 1, 346 } OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE; 347 348 /** 349 * Android specific param for configuration of temporal layering. 350 * Android only supports temporal layering where successive layers each double the 351 * previous layer's framerate. 352 * NOTE: Reading this parameter at run-time SHALL return actual run-time values. 353 * 354 * nSize : Size of the structure in bytes 355 * nVersion : OMX specification version information 356 * nPortIndex : Port that this structure applies to (output port for encoders) 357 * eSupportedPatterns : A bitmask of supported layering patterns 358 * nLayerCountMax : Max number of temporal coding layers supported 359 * by the encoder (must be at least 1, 1 meaning temporal layering 360 * is NOT supported) 361 * nBLayerCountMax : Max number of layers that can contain B frames 362 * (0) to (nLayerCountMax - 1) 363 * ePattern : Layering pattern. 364 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames, 365 * starting from and including the base-layer. 366 * (1 to nLayerCountMax - nBLayerCountActual) 367 * If nPLayerCountActual is 1 and nBLayerCountActual is 0, temporal 368 * layering is disabled. Otherwise, it is enabled. 369 * nBLayerCountActual : Number of temporal layers to be coded with B frames, 370 * starting after non-B layers. 371 * (0 to nBLayerCountMax) 372 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 373 * distribution is specified. 374 * nBitrateRatios : Bitrate ratio (100 based) per layer (index 0 is base layer). 375 * Honored if bBitrateRatiosSpecified is set. 376 * i.e for 4 layers with desired distribution (25% 25% 25% 25%), 377 * nBitrateRatio = {25, 50, 75, 100, ... } 378 * Values in indices not less than 'the actual number of layers 379 * minus 1' MAY be ignored and assumed to be 100. 380 */ 381 typedef struct OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE { 382 OMX_U32 nSize; 383 OMX_VERSIONTYPE nVersion; 384 OMX_U32 nPortIndex; 385 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE eSupportedPatterns; 386 OMX_U32 nLayerCountMax; 387 OMX_U32 nBLayerCountMax; 388 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 389 OMX_U32 nPLayerCountActual; 390 OMX_U32 nBLayerCountActual; 391 OMX_BOOL bBitrateRatiosSpecified; 392 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 393 } OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE; 394 395 /** 396 * Android specific config for changing the temporal-layer count or 397 * bitrate-distribution at run-time. 398 * 399 * nSize : Size of the structure in bytes 400 * nVersion : OMX specification version information 401 * nPortIndex : Port that this structure applies to (output port for encoders) 402 * ePattern : Layering pattern. 403 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames. 404 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 405 * nBLayerCountActual : Number of temporal layers to be coded with B frames. 406 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 407 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 408 * distribution is specified. 409 * nBitrateRatios : Bitrate ratio (100 based, Q16 values) per layer (0 is base layer). 410 * Honored if bBitrateRatiosSpecified is set. 411 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 412 */ 413 typedef struct OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE { 414 OMX_U32 nSize; 415 OMX_VERSIONTYPE nVersion; 416 OMX_U32 nPortIndex; 417 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 418 OMX_U32 nPLayerCountActual; 419 OMX_U32 nBLayerCountActual; 420 OMX_BOOL bBitrateRatiosSpecified; 421 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 422 } OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE; 423 424 #ifdef __cplusplus 425 } 426 #endif /* __cplusplus */ 427 428 #endif /* OMX_VideoExt_h */ 429 /* File EOF */ 430