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 OMX_VIDEO_HEVCProfileUnknown = 0x6EFFFFFF, 122 OMX_VIDEO_HEVCProfileMax = 0x7FFFFFFF 123 } OMX_VIDEO_HEVCPROFILETYPE; 124 125 /** HEVC levels */ 126 typedef enum OMX_VIDEO_HEVCLEVELTYPE { 127 OMX_VIDEO_HEVCLevel_Version0 = 0x0, 128 OMX_VIDEO_HEVCMainTierLevel1 = 0x1, 129 OMX_VIDEO_HEVCHighTierLevel1 = 0x2, 130 OMX_VIDEO_HEVCMainTierLevel2 = 0x4, 131 OMX_VIDEO_HEVCHighTierLevel2 = 0x8, 132 OMX_VIDEO_HEVCMainTierLevel21 = 0x10, 133 OMX_VIDEO_HEVCHighTierLevel21 = 0x20, 134 OMX_VIDEO_HEVCMainTierLevel3 = 0x40, 135 OMX_VIDEO_HEVCHighTierLevel3 = 0x80, 136 OMX_VIDEO_HEVCMainTierLevel31 = 0x100, 137 OMX_VIDEO_HEVCHighTierLevel31 = 0x200, 138 OMX_VIDEO_HEVCMainTierLevel4 = 0x400, 139 OMX_VIDEO_HEVCHighTierLevel4 = 0x800, 140 OMX_VIDEO_HEVCMainTierLevel41 = 0x1000, 141 OMX_VIDEO_HEVCHighTierLevel41 = 0x2000, 142 OMX_VIDEO_HEVCMainTierLevel5 = 0x4000, 143 OMX_VIDEO_HEVCHighTierLevel5 = 0x8000, 144 OMX_VIDEO_HEVCMainTierLevel51 = 0x10000, 145 OMX_VIDEO_HEVCHighTierLevel51 = 0x20000, 146 OMX_VIDEO_HEVCMainTierLevel52 = 0x40000, 147 OMX_VIDEO_HEVCHighTierLevel52 = 0x80000, 148 OMX_VIDEO_HEVCMainTierLevel6 = 0x100000, 149 OMX_VIDEO_HEVCHighTierLevel6 = 0x200000, 150 OMX_VIDEO_HEVCMainTierLevel61 = 0x400000, 151 OMX_VIDEO_HEVCHighTierLevel61 = 0x800000, 152 OMX_VIDEO_HEVCMainTierLevel62 = 0x1000000, 153 OMX_VIDEO_HEVCLevelUnknown = 0x6EFFFFFF, 154 OMX_VIDEO_HEVCLevelMax = 0x7FFFFFFF 155 } OMX_VIDEO_HEVCLEVELTYPE; 156 157 /** HEVC Param */ 158 typedef struct OMX_VIDEO_PARAM_HEVCTYPE { 159 OMX_U32 nSize; 160 OMX_VERSIONTYPE nVersion; 161 OMX_U32 nPortIndex; 162 OMX_VIDEO_HEVCPROFILETYPE eProfile; 163 OMX_VIDEO_HEVCLEVELTYPE eLevel; 164 OMX_U32 nKeyFrameInterval; /* 0 => undefined. Codec-default */ 165 } OMX_VIDEO_PARAM_HEVCTYPE; 166 167 /** 168 * Structure for configuring video compression intra refresh period 169 * 170 * STRUCT MEMBERS: 171 * nSize : Size of the structure in bytes 172 * nVersion : OMX specification version information 173 * nPortIndex : Port that this structure applies to 174 * nRefreshPeriod : Intra refreh period in frames. Value 0 means disable intra refresh 175 */ 176 typedef struct OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE { 177 OMX_U32 nSize; 178 OMX_VERSIONTYPE nVersion; 179 OMX_U32 nPortIndex; 180 OMX_U32 nRefreshPeriod; 181 } OMX_VIDEO_CONFIG_ANDROID_INTRAREFRESHTYPE; 182 183 /** Maximum number of temporal layers supported by AVC/HEVC */ 184 #define OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS 8 185 186 /** temporal layer patterns */ 187 typedef enum OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE { 188 OMX_VIDEO_AndroidTemporalLayeringPatternNone = 0, 189 // pattern as defined by WebRTC 190 OMX_VIDEO_AndroidTemporalLayeringPatternWebRTC = 1 << 0, 191 // pattern where frames in any layer other than the base layer only depend on at most the very 192 // last frame from each preceding layer (other than the base layer.) 193 OMX_VIDEO_AndroidTemporalLayeringPatternAndroid = 1 << 1, 194 } OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE; 195 196 /** 197 * Android specific param for configuration of temporal layering. 198 * Android only supports temporal layering where successive layers each double the 199 * previous layer's framerate. 200 * NOTE: Reading this parameter at run-time SHALL return actual run-time values. 201 * 202 * nSize : Size of the structure in bytes 203 * nVersion : OMX specification version information 204 * nPortIndex : Port that this structure applies to (output port for encoders) 205 * eSupportedPatterns : A bitmask of supported layering patterns 206 * nLayerCountMax : Max number of temporal coding layers supported 207 * by the encoder (must be at least 1, 1 meaning temporal layering 208 * is NOT supported) 209 * nBLayerCountMax : Max number of layers that can contain B frames 210 * (0) to (nLayerCountMax - 1) 211 * ePattern : Layering pattern. 212 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames, 213 * starting from and including the base-layer. 214 * (1 to nLayerCountMax - nBLayerCountActual) 215 * If nPLayerCountActual is 1 and nBLayerCountActual is 0, temporal 216 * layering is disabled. Otherwise, it is enabled. 217 * nBLayerCountActual : Number of temporal layers to be coded with B frames, 218 * starting after non-B layers. 219 * (0 to nBLayerCountMax) 220 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 221 * distribution is specified. 222 * nBitrateRatios : Bitrate ratio (100 based) per layer (index 0 is base layer). 223 * Honored if bBitrateRatiosSpecified is set. 224 * i.e for 4 layers with desired distribution (25% 25% 25% 25%), 225 * nBitrateRatio = {25, 50, 75, 100, ... } 226 * Values in indices not less than 'the actual number of layers 227 * minus 1' MAY be ignored and assumed to be 100. 228 */ 229 typedef struct OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE { 230 OMX_U32 nSize; 231 OMX_VERSIONTYPE nVersion; 232 OMX_U32 nPortIndex; 233 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE eSupportedPatterns; 234 OMX_U32 nLayerCountMax; 235 OMX_U32 nBLayerCountMax; 236 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 237 OMX_U32 nPLayerCountActual; 238 OMX_U32 nBLayerCountActual; 239 OMX_BOOL bBitrateRatiosSpecified; 240 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 241 } OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE; 242 243 /** 244 * Android specific config for changing the temporal-layer count or 245 * bitrate-distribution at run-time. 246 * 247 * nSize : Size of the structure in bytes 248 * nVersion : OMX specification version information 249 * nPortIndex : Port that this structure applies to (output port for encoders) 250 * ePattern : Layering pattern. 251 * nPLayerCountActual : Number of temporal layers to be coded with non-B frames. 252 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 253 * nBLayerCountActual : Number of temporal layers to be coded with B frames. 254 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 255 * bBitrateRatiosSpecified : Flag to indicate if layer-wise bitrate 256 * distribution is specified. 257 * nBitrateRatios : Bitrate ratio (100 based, Q16 values) per layer (0 is base layer). 258 * Honored if bBitrateRatiosSpecified is set. 259 * (same OMX_VIDEO_PARAM_ANDROID_TEMPORALLAYERINGTYPE limits apply.) 260 */ 261 typedef struct OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE { 262 OMX_U32 nSize; 263 OMX_VERSIONTYPE nVersion; 264 OMX_U32 nPortIndex; 265 OMX_VIDEO_ANDROID_TEMPORALLAYERINGPATTERNTYPE ePattern; 266 OMX_U32 nPLayerCountActual; 267 OMX_U32 nBLayerCountActual; 268 OMX_BOOL bBitrateRatiosSpecified; 269 OMX_U32 nBitrateRatios[OMX_VIDEO_ANDROID_MAXTEMPORALLAYERS]; 270 } OMX_VIDEO_CONFIG_ANDROID_TEMPORALLAYERINGTYPE; 271 272 #ifdef __cplusplus 273 } 274 #endif /* __cplusplus */ 275 276 #endif /* OMX_VideoExt_h */ 277 /* File EOF */ 278