include/media/openmax/OMX_VideoExt.h

   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 /** VP8 profiles */
  62 typedef enum OMX_VIDEO_VP8PROFILETYPE {
  63     OMX_VIDEO_VP8ProfileMain = 0x01,
  64     OMX_VIDEO_VP8ProfileUnknown = 0x6EFFFFFF,
  65     OMX_VIDEO_VP8ProfileMax = 0x7FFFFFFF
  66 } OMX_VIDEO_VP8PROFILETYPE;
  67
  68 /** VP8 levels */
  69 typedef enum OMX_VIDEO_VP8LEVELTYPE {
  70     OMX_VIDEO_VP8Level_Version0 = 0x01,
  71     OMX_VIDEO_VP8Level_Version1 = 0x02,
  72     OMX_VIDEO_VP8Level_Version2 = 0x04,
  73     OMX_VIDEO_VP8Level_Version3 = 0x08,
  74     OMX_VIDEO_VP8LevelUnknown = 0x6EFFFFFF,
  75     OMX_VIDEO_VP8LevelMax = 0x7FFFFFFF
  76 } OMX_VIDEO_VP8LEVELTYPE;
  77
  78 /** VP9 profiles */
  79 typedef enum OMX_VIDEO_VP9PROFILETYPE {
  80     OMX_VIDEO_VP9Profile0 = 0x0,
  81     OMX_VIDEO_VP9Profile1 = 0x1,
  82     OMX_VIDEO_VP9Profile2 = 0x2,
  83     OMX_VIDEO_VP9Profile3 = 0x3,
  84     OMX_VIDEO_VP9ProfileUnknown = 0x6EFFFFFF,
  85     OMX_VIDEO_VP9ProfileMax = 0x7FFFFFFF
  86 } OMX_VIDEO_VP9PROFILETYPE;
  87
  88 /** VP9 levels */
  89 typedef enum OMX_VIDEO_VP9LEVELTYPE {
  90     OMX_VIDEO_VP9Level1  = 0x0,
  91     OMX_VIDEO_VP9Level11 = 0x1,
  92     OMX_VIDEO_VP9Level2  = 0x2,
  93     OMX_VIDEO_VP9Level21 = 0x4,
  94     OMX_VIDEO_VP9Level3  = 0x8,
  95     OMX_VIDEO_VP9Level31 = 0x10,
  96     OMX_VIDEO_VP9Level4  = 0x20,
  97     OMX_VIDEO_VP9Level41 = 0x40,
  98     OMX_VIDEO_VP9Level5  = 0x80,
  99     OMX_VIDEO_VP9Level51 = 0x100,
 100     OMX_VIDEO_VP9Level52 = 0x200,
 101     OMX_VIDEO_VP9Level6  = 0x400,
 102     OMX_VIDEO_VP9Level61 = 0x800,
 103     OMX_VIDEO_VP9Level62 = 0x1000,
 104     OMX_VIDEO_VP9LevelUnknown = 0x6EFFFFFF,
 105     OMX_VIDEO_VP9LevelMax = 0x7FFFFFFF
 106 } OMX_VIDEO_VP9LEVELTYPE;
 107
 108 /** VP8 Param */
 109 typedef struct OMX_VIDEO_PARAM_VP8TYPE {
 110     OMX_U32 nSize;
 111     OMX_VERSIONTYPE nVersion;
 112     OMX_U32 nPortIndex;
 113     OMX_VIDEO_VP8PROFILETYPE eProfile;
 114     OMX_VIDEO_VP8LEVELTYPE eLevel;
 115     OMX_U32 nDCTPartitions;
 116     OMX_BOOL bErrorResilientMode;
 117 } OMX_VIDEO_PARAM_VP8TYPE;
 118
 119 /** Structure for configuring VP8 reference frames */
 120 typedef struct OMX_VIDEO_VP8REFERENCEFRAMETYPE {
 121     OMX_U32 nSize;
 122     OMX_VERSIONTYPE nVersion;
 123     OMX_U32 nPortIndex;
 124     OMX_BOOL bPreviousFrameRefresh;
 125     OMX_BOOL bGoldenFrameRefresh;
 126     OMX_BOOL bAlternateFrameRefresh;
 127     OMX_BOOL bUsePreviousFrame;
 128     OMX_BOOL bUseGoldenFrame;
 129     OMX_BOOL bUseAlternateFrame;
 130 } OMX_VIDEO_VP8REFERENCEFRAMETYPE;
 131
 132 /** Structure for querying VP8 reference frame type */
 133 typedef struct OMX_VIDEO_VP8REFERENCEFRAMEINFOTYPE {
 134     OMX_U32 nSize;
 135     OMX_VERSIONTYPE nVersion;
 136     OMX_U32 nPortIndex;
 137     OMX_BOOL bIsIntraFrame;
 138     OMX_BOOL bIsGoldenOrAlternateFrame;
 139 } OMX_VIDEO_VP8REFERENCEFRAMEINFOTYPE;
 140
 141 /** Maximum number of VP8 temporal layers */
 142 #define OMX_VIDEO_ANDROID_MAXVP8TEMPORALLAYERS 3
 143
 144 /** VP8 temporal layer patterns */
 145 typedef enum OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE {
 146     OMX_VIDEO_VPXTemporalLayerPatternNone = 0,
 147     OMX_VIDEO_VPXTemporalLayerPatternWebRTC = 1,
 148     OMX_VIDEO_VPXTemporalLayerPatternMax = 0x7FFFFFFF
 149 } OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE;
 150
 151 /**
 152  * Android specific VP8 encoder params
 153  *
 154  * STRUCT MEMBERS:
 155  *  nSize                      : Size of the structure in bytes
 156  *  nVersion                   : OMX specification version information
 157  *  nPortIndex                 : Port that this structure applies to
 158  *  nKeyFrameInterval          : Key frame interval in frames
 159  *  eTemporalPattern           : Type of temporal layer pattern
 160  *  nTemporalLayerCount        : Number of temporal coding layers
 161  *  nTemporalLayerBitrateRatio : Bitrate ratio allocation between temporal
 162  *                               streams in percentage
 163  *  nMinQuantizer              : Minimum (best quality) quantizer
 164  *  nMaxQuantizer              : Maximum (worst quality) quantizer
 165  */
 166 typedef struct OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE {
 167     OMX_U32 nSize;
 168     OMX_VERSIONTYPE nVersion;
 169     OMX_U32 nPortIndex;
 170     OMX_U32 nKeyFrameInterval;
 171     OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE eTemporalPattern;
 172     OMX_U32 nTemporalLayerCount;
 173     OMX_U32 nTemporalLayerBitrateRatio[OMX_VIDEO_ANDROID_MAXVP8TEMPORALLAYERS];
 174     OMX_U32 nMinQuantizer;
 175     OMX_U32 nMaxQuantizer;
 176 } OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE;
 177
 178 /** HEVC Profile enum type */
 179 typedef enum OMX_VIDEO_HEVCPROFILETYPE {
 180     OMX_VIDEO_HEVCProfileUnknown = 0x0,
 181     OMX_VIDEO_HEVCProfileMain    = 0x1,
 182     OMX_VIDEO_HEVCProfileMain10  = 0x2,
 183     OMX_VIDEO_HEVCProfileMax     = 0x7FFFFFFF
 184 } OMX_VIDEO_HEVCPROFILETYPE;
 185
 186 /** HEVC Level enum type */
 187 typedef enum OMX_VIDEO_HEVCLEVELTYPE {
 188     OMX_VIDEO_HEVCLevelUnknown    = 0x0,
 189     OMX_VIDEO_HEVCMainTierLevel1  = 0x1,
 190     OMX_VIDEO_HEVCHighTierLevel1  = 0x2,
 191     OMX_VIDEO_HEVCMainTierLevel2  = 0x4,
 192     OMX_VIDEO_HEVCHighTierLevel2  = 0x8,
 193     OMX_VIDEO_HEVCMainTierLevel21 = 0x10,
 194     OMX_VIDEO_HEVCHighTierLevel21 = 0x20,
 195     OMX_VIDEO_HEVCMainTierLevel3  = 0x40,
 196     OMX_VIDEO_HEVCHighTierLevel3  = 0x80,
 197     OMX_VIDEO_HEVCMainTierLevel31 = 0x100,
 198     OMX_VIDEO_HEVCHighTierLevel31 = 0x200,
 199     OMX_VIDEO_HEVCMainTierLevel4  = 0x400,
 200     OMX_VIDEO_HEVCHighTierLevel4  = 0x800,
 201     OMX_VIDEO_HEVCMainTierLevel41 = 0x1000,
 202     OMX_VIDEO_HEVCHighTierLevel41 = 0x2000,
 203     OMX_VIDEO_HEVCMainTierLevel5  = 0x4000,
 204     OMX_VIDEO_HEVCHighTierLevel5  = 0x8000,
 205     OMX_VIDEO_HEVCMainTierLevel51 = 0x10000,
 206     OMX_VIDEO_HEVCHighTierLevel51 = 0x20000,
 207     OMX_VIDEO_HEVCMainTierLevel52 = 0x40000,
 208     OMX_VIDEO_HEVCHighTierLevel52 = 0x80000,
 209     OMX_VIDEO_HEVCMainTierLevel6  = 0x100000,
 210     OMX_VIDEO_HEVCHighTierLevel6  = 0x200000,
 211     OMX_VIDEO_HEVCMainTierLevel61 = 0x400000,
 212     OMX_VIDEO_HEVCHighTierLevel61 = 0x800000,
 213     OMX_VIDEO_HEVCMainTierLevel62 = 0x1000000,
 214     OMX_VIDEO_HEVCHighTierLevel62 = 0x2000000,
 215     OMX_VIDEO_HEVCHighTiermax     = 0x7FFFFFFF
 216 } OMX_VIDEO_HEVCLEVELTYPE;
 217
 218 /** Structure for controlling HEVC video encoding and decoding */
 219 typedef struct OMX_VIDEO_PARAM_HEVCTYPE {
 220     OMX_U32 nSize;
 221     OMX_VERSIONTYPE nVersion;
 222     OMX_U32 nPortIndex;
 223     OMX_VIDEO_HEVCPROFILETYPE eProfile;
 224     OMX_VIDEO_HEVCLEVELTYPE eLevel;
 225 } OMX_VIDEO_PARAM_HEVCTYPE;
 226
 227 /** Structure to define if dependent slice segments should be used */
 228 typedef struct OMX_VIDEO_SLICESEGMENTSTYPE {
 229     OMX_U32 nSize;
 230     OMX_VERSIONTYPE nVersion;
 231     OMX_U32 nPortIndex;
 232     OMX_BOOL bDepedentSegments;
 233     OMX_BOOL bEnableLoopFilterAcrossSlices;
 234 } OMX_VIDEO_SLICESEGMENTSTYPE;
 235
 236 /** Structure to return timestamps of rendered output frames as well as EOS
 237  *  for tunneled components.
 238  */
 239 typedef struct OMX_VIDEO_RENDEREVENTTYPE {
 240     OMX_S64 nMediaTimeUs;  // timestamp of rendered video frame
 241     OMX_S64 nSystemTimeNs; // system monotonic time at the time frame was rendered
 242                            // Use INT64_MAX for nMediaTimeUs to signal that the EOS
 243                            // has been reached. In this case, nSystemTimeNs MUST be
 244                            // the system time when the last frame was rendered.
 245                            // This MUST be done in addition to returning (and
 246                            // following) the render information for the last frame.
 247 } OMX_VIDEO_RENDEREVENTTYPE;
 248
 249 #ifdef __cplusplus
 250 }
 251 #endif /* __cplusplus */
 252
 253 #endif /* OMX_VideoExt_h */
 254 /* File EOF */