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