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