1 /* ------------------------------------------------------------------
2 * Copyright (C) 1998-2009 PacketVideo
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
14 * See the License for the specific language governing permissions
15 * and limitations under the License.
16 * -------------------------------------------------------------------
19 * Copyright (c) 2008 The Khronos Group Inc.
21 * Permission is hereby granted, free of charge, to any person obtaining
22 * a copy of this software and associated documentation files (the
23 * "Software"), to deal in the Software without restriction, including
24 * without limitation the rights to use, copy, modify, merge, publish,
25 * distribute, sublicense, and/or sell copies of the Software, and to
26 * permit persons to whom the Software is furnished to do so, subject
27 * to the following conditions:
28 * The above copyright notice and this permission notice shall be included
29 * in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
32 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
34 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
35 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
36 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
37 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42 * @file OMX_Video.h - OpenMax IL version 1.1.2
43 * The structures is needed by Video components to exchange parameters
44 * and configuration data with OMX components.
49 /** @defgroup video OpenMAX IL Video Domain
51 * Structures for OpenMAX IL Video domain
57 #endif /* __cplusplus */
61 * Each OMX header must include all required header files to allow the
62 * header to compile without errors. The includes below are required
63 * for this header file to compile successfully
66 #include <OMX_IVCommon.h>
70 * Enumeration used to define the possible video compression codings.
71 * NOTE: This essentially refers to file extensions. If the coding is
72 * being used to specify the ENCODE type, then additional work
73 * must be done to configure the exact flavor of the compression
74 * to be used. For decode cases where the user application can
75 * not differentiate between MPEG-4 and H.264 bit streams, it is
76 * up to the codec to handle this.
78 typedef enum OMX_VIDEO_CODINGTYPE {
79 OMX_VIDEO_CodingUnused, /**< Value when coding is N/A */
80 OMX_VIDEO_CodingAutoDetect, /**< Autodetection of coding type */
81 OMX_VIDEO_CodingMPEG2, /**< AKA: H.262 */
82 OMX_VIDEO_CodingH263, /**< H.263 */
83 OMX_VIDEO_CodingMPEG4, /**< MPEG-4 */
84 OMX_VIDEO_CodingWMV, /**< all versions of Windows Media Video */
85 OMX_VIDEO_CodingRV, /**< all versions of Real Video */
86 OMX_VIDEO_CodingAVC, /**< H.264/AVC */
87 OMX_VIDEO_CodingMJPEG, /**< Motion JPEG */
88 OMX_VIDEO_CodingVP8, /**< Google VP8, formerly known as On2 VP8 */
89 OMX_VIDEO_CodingVP9, /**< Google VP9 */
90 OMX_VIDEO_CodingKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
91 OMX_VIDEO_CodingVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
92 OMX_VIDEO_CodingMax = 0x7FFFFFFF
93 } OMX_VIDEO_CODINGTYPE;
97 * Data structure used to define a video path. The number of Video paths for
98 * input and output will vary by type of the Video component.
100 * Input (aka Source) : zero Inputs, one Output,
101 * Splitter : one Input, 2 or more Outputs,
102 * Processing Element : one Input, one output,
103 * Mixer : 2 or more inputs, one output,
104 * Output (aka Sink) : one Input, zero outputs.
106 * The PortDefinition structure is used to define all of the parameters
107 * necessary for the compliant component to setup an input or an output video
108 * path. If additional vendor specific data is required, it should be
109 * transmitted to the component using the CustomCommand function. Compliant
110 * components will prepopulate this structure with optimal values during the
111 * GetDefaultInitParams command.
114 * cMIMEType : MIME type of data for the port
115 * pNativeRender : Platform specific reference for a display if a
116 * sync, otherwise this field is 0
117 * nFrameWidth : Width of frame to be used on channel if
118 * uncompressed format is used. Use 0 for unknown,
119 * don't care or variable
120 * nFrameHeight : Height of frame to be used on channel if
121 * uncompressed format is used. Use 0 for unknown,
122 * don't care or variable
123 * nStride : Number of bytes per span of an image
124 * (i.e. indicates the number of bytes to get
125 * from span N to span N+1, where negative stride
126 * indicates the image is bottom up
127 * nSliceHeight : Height used when encoding in slices
128 * nBitrate : Bit rate of frame to be used on channel if
129 * compressed format is used. Use 0 for unknown,
130 * don't care or variable
131 * xFramerate : Frame rate to be used on channel if uncompressed
132 * format is used. Use 0 for unknown, don't care or
133 * variable. Units are Q16 frames per second.
134 * bFlagErrorConcealment : Turns on error concealment if it is supported by
136 * eCompressionFormat : Compression format used in this instance of the
137 * component. When OMX_VIDEO_CodingUnused is
138 * specified, eColorFormat is used
139 * eColorFormat : Decompressed format used by this component
140 * pNativeWindow : Platform specific reference for a window object if a
141 * display sink , otherwise this field is 0x0.
143 typedef struct OMX_VIDEO_PORTDEFINITIONTYPE {
144 OMX_STRING cMIMEType;
145 OMX_NATIVE_DEVICETYPE pNativeRender;
147 OMX_U32 nFrameHeight;
149 OMX_U32 nSliceHeight;
152 OMX_BOOL bFlagErrorConcealment;
153 OMX_VIDEO_CODINGTYPE eCompressionFormat;
154 OMX_COLOR_FORMATTYPE eColorFormat;
155 OMX_NATIVE_WINDOWTYPE pNativeWindow;
156 } OMX_VIDEO_PORTDEFINITIONTYPE;
159 * Port format parameter. This structure is used to enumerate the various
160 * data input/output format supported by the port.
163 * nSize : Size of the structure in bytes
164 * nVersion : OMX specification version information
165 * nPortIndex : Indicates which port to set
166 * nIndex : Indicates the enumeration index for the format from
168 * eCompressionFormat : Compression format used in this instance of the
169 * component. When OMX_VIDEO_CodingUnused is specified,
170 * eColorFormat is used
171 * eColorFormat : Decompressed format used by this component
172 * xFrameRate : Indicates the video frame rate in Q16 format
174 typedef struct OMX_VIDEO_PARAM_PORTFORMATTYPE {
176 OMX_VERSIONTYPE nVersion;
179 OMX_VIDEO_CODINGTYPE eCompressionFormat;
180 OMX_COLOR_FORMATTYPE eColorFormat;
182 } OMX_VIDEO_PARAM_PORTFORMATTYPE;
186 * This is a structure for configuring video compression quantization
187 * parameter values. Codecs may support different QP values for different
191 * nSize : Size of the structure in bytes
192 * nVersion : OMX specification version info
193 * nPortIndex : Port that this structure applies to
194 * nQpI : QP value to use for index frames
195 * nQpP : QP value to use for P frames
196 * nQpB : QP values to use for bidirectional frames
198 typedef struct OMX_VIDEO_PARAM_QUANTIZATIONTYPE {
200 OMX_VERSIONTYPE nVersion;
205 } OMX_VIDEO_PARAM_QUANTIZATIONTYPE;
209 * Structure for configuration of video fast update parameters.
212 * nSize : Size of the structure in bytes
213 * nVersion : OMX specification version info
214 * nPortIndex : Port that this structure applies to
215 * bEnableVFU : Enable/Disable video fast update
216 * nFirstGOB : Specifies the number of the first macroblock row
217 * nFirstMB : specifies the first MB relative to the specified first GOB
218 * nNumMBs : Specifies the number of MBs to be refreshed from nFirstGOB
221 typedef struct OMX_VIDEO_PARAM_VIDEOFASTUPDATETYPE {
223 OMX_VERSIONTYPE nVersion;
229 } OMX_VIDEO_PARAM_VIDEOFASTUPDATETYPE;
233 * Enumeration of possible bitrate control types
235 typedef enum OMX_VIDEO_CONTROLRATETYPE {
236 OMX_Video_ControlRateDisable,
237 OMX_Video_ControlRateVariable,
238 OMX_Video_ControlRateConstant,
239 OMX_Video_ControlRateVariableSkipFrames,
240 OMX_Video_ControlRateConstantSkipFrames,
241 OMX_Video_ControlRateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
242 OMX_Video_ControlRateVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
243 OMX_Video_ControlRateMax = 0x7FFFFFFF
244 } OMX_VIDEO_CONTROLRATETYPE;
248 * Structure for configuring bitrate mode of a codec.
251 * nSize : Size of the struct in bytes
252 * nVersion : OMX spec version info
253 * nPortIndex : Port that this struct applies to
254 * eControlRate : Control rate type enum
255 * nTargetBitrate : Target bitrate to encode with
257 typedef struct OMX_VIDEO_PARAM_BITRATETYPE {
259 OMX_VERSIONTYPE nVersion;
261 OMX_VIDEO_CONTROLRATETYPE eControlRate;
262 OMX_U32 nTargetBitrate;
263 } OMX_VIDEO_PARAM_BITRATETYPE;
267 * Enumeration of possible motion vector (MV) types
269 typedef enum OMX_VIDEO_MOTIONVECTORTYPE {
270 OMX_Video_MotionVectorPixel,
271 OMX_Video_MotionVectorHalfPel,
272 OMX_Video_MotionVectorQuarterPel,
273 OMX_Video_MotionVectorEighthPel,
274 OMX_Video_MotionVectorKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
275 OMX_Video_MotionVectorVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
276 OMX_Video_MotionVectorMax = 0x7FFFFFFF
277 } OMX_VIDEO_MOTIONVECTORTYPE;
281 * Structure for configuring the number of motion vectors used as well
285 * nSize : Size of the struct in bytes
286 * nVersion : OMX spec version info
287 * nPortIndex : port that this structure applies to
288 * eAccuracy : Enumerated MV accuracy
289 * bUnrestrictedMVs : Allow unrestricted MVs
290 * bFourMV : Allow use of 4 MVs
291 * sXSearchRange : Search range in horizontal direction for MVs
292 * sYSearchRange : Search range in vertical direction for MVs
294 typedef struct OMX_VIDEO_PARAM_MOTIONVECTORTYPE {
296 OMX_VERSIONTYPE nVersion;
298 OMX_VIDEO_MOTIONVECTORTYPE eAccuracy;
299 OMX_BOOL bUnrestrictedMVs;
301 OMX_S32 sXSearchRange;
302 OMX_S32 sYSearchRange;
303 } OMX_VIDEO_PARAM_MOTIONVECTORTYPE;
307 * Enumeration of possible methods to use for Intra Refresh
309 typedef enum OMX_VIDEO_INTRAREFRESHTYPE {
310 OMX_VIDEO_IntraRefreshCyclic,
311 OMX_VIDEO_IntraRefreshAdaptive,
312 OMX_VIDEO_IntraRefreshBoth,
313 OMX_VIDEO_IntraRefreshKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
314 OMX_VIDEO_IntraRefreshVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
315 OMX_VIDEO_IntraRefreshMax = 0x7FFFFFFF
316 } OMX_VIDEO_INTRAREFRESHTYPE;
320 * Structure for configuring intra refresh mode
323 * nSize : Size of the structure in bytes
324 * nVersion : OMX specification version information
325 * nPortIndex : Port that this structure applies to
326 * eRefreshMode : Cyclic, Adaptive, or Both
327 * nAirMBs : Number of intra macroblocks to refresh in a frame when
329 * nAirRef : Number of times a motion marked macroblock has to be
331 * nCirMBs : Number of consecutive macroblocks to be coded as "intra"
332 * when CIR is enabled
334 typedef struct OMX_VIDEO_PARAM_INTRAREFRESHTYPE {
336 OMX_VERSIONTYPE nVersion;
338 OMX_VIDEO_INTRAREFRESHTYPE eRefreshMode;
342 } OMX_VIDEO_PARAM_INTRAREFRESHTYPE;
346 * Structure for enabling various error correction methods for video
350 * nSize : Size of the structure in bytes
351 * nVersion : OMX specification version information
352 * nPortIndex : Port that this structure applies to
353 * bEnableHEC : Enable/disable header extension codes (HEC)
354 * bEnableResync : Enable/disable resynchronization markers
355 * nResynchMarkerSpacing : Resynch markers interval (in bits) to be
356 * applied in the stream
357 * bEnableDataPartitioning : Enable/disable data partitioning
358 * bEnableRVLC : Enable/disable reversible variable length
361 typedef struct OMX_VIDEO_PARAM_ERRORCORRECTIONTYPE {
363 OMX_VERSIONTYPE nVersion;
366 OMX_BOOL bEnableResync;
367 OMX_U32 nResynchMarkerSpacing;
368 OMX_BOOL bEnableDataPartitioning;
369 OMX_BOOL bEnableRVLC;
370 } OMX_VIDEO_PARAM_ERRORCORRECTIONTYPE;
374 * Configuration of variable block-size motion compensation (VBSMC)
377 * nSize : Size of the structure in bytes
378 * nVersion : OMX specification version information
379 * nPortIndex : Port that this structure applies to
380 * b16x16 : Enable inter block search 16x16
381 * b16x8 : Enable inter block search 16x8
382 * b8x16 : Enable inter block search 8x16
383 * b8x8 : Enable inter block search 8x8
384 * b8x4 : Enable inter block search 8x4
385 * b4x8 : Enable inter block search 4x8
386 * b4x4 : Enable inter block search 4x4
388 typedef struct OMX_VIDEO_PARAM_VBSMCTYPE {
390 OMX_VERSIONTYPE nVersion;
399 } OMX_VIDEO_PARAM_VBSMCTYPE;
403 * H.263 profile types, each profile indicates support for various
404 * performance bounds and different annexes.
407 * Baseline : Baseline Profile: H.263 (V1), no optional modes
408 * H320 Coding : H.320 Coding Efficiency Backward Compatibility
409 * Profile: H.263+ (V2), includes annexes I, J, L.4
411 * BackwardCompatible : Backward Compatibility Profile: H.263 (V1),
413 * ISWV2 : Interactive Streaming Wireless Profile: H.263+
414 * (V2), includes annexes I, J, K and T
415 * ISWV3 : Interactive Streaming Wireless Profile: H.263++
416 * (V3), includes profile 3 and annexes V and W.6.3.8
417 * HighCompression : Conversational High Compression Profile: H.263++
418 * (V3), includes profiles 1 & 2 and annexes D and U
419 * Internet : Conversational Internet Profile: H.263++ (V3),
420 * includes profile 5 and annex K
421 * Interlace : Conversational Interlace Profile: H.263++ (V3),
422 * includes profile 5 and annex W.6.3.11
423 * HighLatency : High Latency Profile: H.263++ (V3), includes
424 * profile 6 and annexes O.1 and P.5
426 typedef enum OMX_VIDEO_H263PROFILETYPE {
427 OMX_VIDEO_H263ProfileBaseline = 0x01,
428 OMX_VIDEO_H263ProfileH320Coding = 0x02,
429 OMX_VIDEO_H263ProfileBackwardCompatible = 0x04,
430 OMX_VIDEO_H263ProfileISWV2 = 0x08,
431 OMX_VIDEO_H263ProfileISWV3 = 0x10,
432 OMX_VIDEO_H263ProfileHighCompression = 0x20,
433 OMX_VIDEO_H263ProfileInternet = 0x40,
434 OMX_VIDEO_H263ProfileInterlace = 0x80,
435 OMX_VIDEO_H263ProfileHighLatency = 0x100,
436 OMX_VIDEO_H263ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
437 OMX_VIDEO_H263ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
438 OMX_VIDEO_H263ProfileMax = 0x7FFFFFFF
439 } OMX_VIDEO_H263PROFILETYPE;
443 * H.263 level types, each level indicates support for various frame sizes,
444 * bit rates, decoder frame rates.
446 typedef enum OMX_VIDEO_H263LEVELTYPE {
447 OMX_VIDEO_H263Level10 = 0x01,
448 OMX_VIDEO_H263Level20 = 0x02,
449 OMX_VIDEO_H263Level30 = 0x04,
450 OMX_VIDEO_H263Level40 = 0x08,
451 OMX_VIDEO_H263Level45 = 0x10,
452 OMX_VIDEO_H263Level50 = 0x20,
453 OMX_VIDEO_H263Level60 = 0x40,
454 OMX_VIDEO_H263Level70 = 0x80,
455 OMX_VIDEO_H263LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
456 OMX_VIDEO_H263LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
457 OMX_VIDEO_H263LevelMax = 0x7FFFFFFF
458 } OMX_VIDEO_H263LEVELTYPE;
462 * Specifies the picture type. These values should be OR'd to signal all
463 * pictures types which are allowed.
466 * Generic Picture Types: I, P and B
467 * H.263 Specific Picture Types: SI and SP
468 * H.264 Specific Picture Types: EI and EP
469 * MPEG-4 Specific Picture Types: S
471 typedef enum OMX_VIDEO_PICTURETYPE {
472 OMX_VIDEO_PictureTypeI = 0x01,
473 OMX_VIDEO_PictureTypeP = 0x02,
474 OMX_VIDEO_PictureTypeB = 0x04,
475 OMX_VIDEO_PictureTypeSI = 0x08,
476 OMX_VIDEO_PictureTypeSP = 0x10,
477 OMX_VIDEO_PictureTypeEI = 0x11,
478 OMX_VIDEO_PictureTypeEP = 0x12,
479 OMX_VIDEO_PictureTypeS = 0x14,
480 OMX_VIDEO_PictureTypeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
481 OMX_VIDEO_PictureTypeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
482 OMX_VIDEO_PictureTypeMax = 0x7FFFFFFF
483 } OMX_VIDEO_PICTURETYPE;
490 * nSize : Size of the structure in bytes
491 * nVersion : OMX specification version information
492 * nPortIndex : Port that this structure applies to
493 * nPFrames : Number of P frames between each I frame
494 * nBFrames : Number of B frames between each I frame
495 * eProfile : H.263 profile(s) to use
496 * eLevel : H.263 level(s) to use
497 * bPLUSPTYPEAllowed : Indicating that it is allowed to use PLUSPTYPE
498 * (specified in the 1998 version of H.263) to
499 * indicate custom picture sizes or clock
501 * nAllowedPictureTypes : Specifies the picture types allowed in the
503 * bForceRoundingTypeToZero : value of the RTYPE bit (bit 6 of MPPTYPE) is
504 * not constrained. It is recommended to change
505 * the value of the RTYPE bit for each reference
506 * picture in error-free communication
507 * nPictureHeaderRepetition : Specifies the frequency of picture header
509 * nGOBHeaderInterval : Specifies the interval of non-empty GOB
510 * headers in units of GOBs
512 typedef struct OMX_VIDEO_PARAM_H263TYPE {
514 OMX_VERSIONTYPE nVersion;
518 OMX_VIDEO_H263PROFILETYPE eProfile;
519 OMX_VIDEO_H263LEVELTYPE eLevel;
520 OMX_BOOL bPLUSPTYPEAllowed;
521 OMX_U32 nAllowedPictureTypes;
522 OMX_BOOL bForceRoundingTypeToZero;
523 OMX_U32 nPictureHeaderRepetition;
524 OMX_U32 nGOBHeaderInterval;
525 } OMX_VIDEO_PARAM_H263TYPE;
529 * MPEG-2 profile types, each profile indicates support for various
530 * performance bounds and different annexes.
532 typedef enum OMX_VIDEO_MPEG2PROFILETYPE {
533 OMX_VIDEO_MPEG2ProfileSimple = 0, /**< Simple Profile */
534 OMX_VIDEO_MPEG2ProfileMain, /**< Main Profile */
535 OMX_VIDEO_MPEG2Profile422, /**< 4:2:2 Profile */
536 OMX_VIDEO_MPEG2ProfileSNR, /**< SNR Profile */
537 OMX_VIDEO_MPEG2ProfileSpatial, /**< Spatial Profile */
538 OMX_VIDEO_MPEG2ProfileHigh, /**< High Profile */
539 OMX_VIDEO_MPEG2ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
540 OMX_VIDEO_MPEG2ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
541 OMX_VIDEO_MPEG2ProfileMax = 0x7FFFFFFF
542 } OMX_VIDEO_MPEG2PROFILETYPE;
546 * MPEG-2 level types, each level indicates support for various frame
547 * sizes, bit rates, decoder frame rates. No need
549 typedef enum OMX_VIDEO_MPEG2LEVELTYPE {
550 OMX_VIDEO_MPEG2LevelLL = 0, /**< Low Level */
551 OMX_VIDEO_MPEG2LevelML, /**< Main Level */
552 OMX_VIDEO_MPEG2LevelH14, /**< High 1440 */
553 OMX_VIDEO_MPEG2LevelHL, /**< High Level */
554 OMX_VIDEO_MPEG2LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
555 OMX_VIDEO_MPEG2LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
556 OMX_VIDEO_MPEG2LevelMax = 0x7FFFFFFF
557 } OMX_VIDEO_MPEG2LEVELTYPE;
564 * nSize : Size of the structure in bytes
565 * nVersion : OMX specification version information
566 * nPortIndex : Port that this structure applies to
567 * nPFrames : Number of P frames between each I frame
568 * nBFrames : Number of B frames between each I frame
569 * eProfile : MPEG-2 profile(s) to use
570 * eLevel : MPEG-2 levels(s) to use
572 typedef struct OMX_VIDEO_PARAM_MPEG2TYPE {
574 OMX_VERSIONTYPE nVersion;
578 OMX_VIDEO_MPEG2PROFILETYPE eProfile;
579 OMX_VIDEO_MPEG2LEVELTYPE eLevel;
580 } OMX_VIDEO_PARAM_MPEG2TYPE;
584 * MPEG-4 profile types, each profile indicates support for various
585 * performance bounds and different annexes.
588 * - Simple Profile, Levels 1-3
589 * - Simple Scalable Profile, Levels 1-2
590 * - Core Profile, Levels 1-2
591 * - Main Profile, Levels 2-4
592 * - N-bit Profile, Level 2
593 * - Scalable Texture Profile, Level 1
594 * - Simple Face Animation Profile, Levels 1-2
595 * - Simple Face and Body Animation (FBA) Profile, Levels 1-2
596 * - Basic Animated Texture Profile, Levels 1-2
597 * - Hybrid Profile, Levels 1-2
598 * - Advanced Real Time Simple Profiles, Levels 1-4
599 * - Core Scalable Profile, Levels 1-3
600 * - Advanced Coding Efficiency Profile, Levels 1-4
601 * - Advanced Core Profile, Levels 1-2
602 * - Advanced Scalable Texture, Levels 2-3
604 typedef enum OMX_VIDEO_MPEG4PROFILETYPE {
605 OMX_VIDEO_MPEG4ProfileSimple = 0x01,
606 OMX_VIDEO_MPEG4ProfileSimpleScalable = 0x02,
607 OMX_VIDEO_MPEG4ProfileCore = 0x04,
608 OMX_VIDEO_MPEG4ProfileMain = 0x08,
609 OMX_VIDEO_MPEG4ProfileNbit = 0x10,
610 OMX_VIDEO_MPEG4ProfileScalableTexture = 0x20,
611 OMX_VIDEO_MPEG4ProfileSimpleFace = 0x40,
612 OMX_VIDEO_MPEG4ProfileSimpleFBA = 0x80,
613 OMX_VIDEO_MPEG4ProfileBasicAnimated = 0x100,
614 OMX_VIDEO_MPEG4ProfileHybrid = 0x200,
615 OMX_VIDEO_MPEG4ProfileAdvancedRealTime = 0x400,
616 OMX_VIDEO_MPEG4ProfileCoreScalable = 0x800,
617 OMX_VIDEO_MPEG4ProfileAdvancedCoding = 0x1000,
618 OMX_VIDEO_MPEG4ProfileAdvancedCore = 0x2000,
619 OMX_VIDEO_MPEG4ProfileAdvancedScalable = 0x4000,
620 OMX_VIDEO_MPEG4ProfileAdvancedSimple = 0x8000,
621 OMX_VIDEO_MPEG4ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
622 OMX_VIDEO_MPEG4ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
623 OMX_VIDEO_MPEG4ProfileMax = 0x7FFFFFFF
624 } OMX_VIDEO_MPEG4PROFILETYPE;
628 * MPEG-4 level types, each level indicates support for various frame
629 * sizes, bit rates, decoder frame rates. No need
631 typedef enum OMX_VIDEO_MPEG4LEVELTYPE {
632 OMX_VIDEO_MPEG4Level0 = 0x01, /**< Level 0 */
633 OMX_VIDEO_MPEG4Level0b = 0x02, /**< Level 0b */
634 OMX_VIDEO_MPEG4Level1 = 0x04, /**< Level 1 */
635 OMX_VIDEO_MPEG4Level2 = 0x08, /**< Level 2 */
636 OMX_VIDEO_MPEG4Level3 = 0x10, /**< Level 3 */
637 OMX_VIDEO_MPEG4Level4 = 0x20, /**< Level 4 */
638 OMX_VIDEO_MPEG4Level4a = 0x40, /**< Level 4a */
639 OMX_VIDEO_MPEG4Level5 = 0x80, /**< Level 5 */
640 OMX_VIDEO_MPEG4LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
641 OMX_VIDEO_MPEG4LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
642 OMX_VIDEO_MPEG4LevelMax = 0x7FFFFFFF
643 } OMX_VIDEO_MPEG4LEVELTYPE;
647 * MPEG-4 configuration. This structure handles configuration options
648 * which are specific to MPEG4 algorithms
651 * nSize : Size of the structure in bytes
652 * nVersion : OMX specification version information
653 * nPortIndex : Port that this structure applies to
654 * nSliceHeaderSpacing : Number of macroblocks between slice header (H263+
655 * Annex K). Put zero if not used
656 * bSVH : Enable Short Video Header mode
657 * bGov : Flag to enable GOV
658 * nPFrames : Number of P frames between each I frame (also called
660 * nBFrames : Number of B frames between each I frame
661 * nIDCVLCThreshold : Value of intra DC VLC threshold
662 * bACPred : Flag to use ac prediction
663 * nMaxPacketSize : Maximum size of packet in bytes.
664 * nTimeIncRes : Used to pass VOP time increment resolution for MPEG4.
665 * Interpreted as described in MPEG4 standard.
666 * eProfile : MPEG-4 profile(s) to use.
667 * eLevel : MPEG-4 level(s) to use.
668 * nAllowedPictureTypes : Specifies the picture types allowed in the bitstream
669 * nHeaderExtension : Specifies the number of consecutive video packet
670 * headers within a VOP
671 * bReversibleVLC : Specifies whether reversible variable length coding
674 typedef struct OMX_VIDEO_PARAM_MPEG4TYPE {
676 OMX_VERSIONTYPE nVersion;
678 OMX_U32 nSliceHeaderSpacing;
683 OMX_U32 nIDCVLCThreshold;
685 OMX_U32 nMaxPacketSize;
687 OMX_VIDEO_MPEG4PROFILETYPE eProfile;
688 OMX_VIDEO_MPEG4LEVELTYPE eLevel;
689 OMX_U32 nAllowedPictureTypes;
690 OMX_U32 nHeaderExtension;
691 OMX_BOOL bReversibleVLC;
692 } OMX_VIDEO_PARAM_MPEG4TYPE;
698 typedef enum OMX_VIDEO_WMVFORMATTYPE {
699 OMX_VIDEO_WMVFormatUnused = 0x01, /**< Format unused or unknown */
700 OMX_VIDEO_WMVFormat7 = 0x02, /**< Windows Media Video format 7 */
701 OMX_VIDEO_WMVFormat8 = 0x04, /**< Windows Media Video format 8 */
702 OMX_VIDEO_WMVFormat9 = 0x08, /**< Windows Media Video format 9 */
703 OMX_VIDEO_WMFFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
704 OMX_VIDEO_WMFFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
705 OMX_VIDEO_WMVFormatMax = 0x7FFFFFFF
706 } OMX_VIDEO_WMVFORMATTYPE;
713 * nSize : Size of the structure in bytes
714 * nVersion : OMX specification version information
715 * nPortIndex : Port that this structure applies to
716 * eFormat : Version of WMV stream / data
718 typedef struct OMX_VIDEO_PARAM_WMVTYPE {
720 OMX_VERSIONTYPE nVersion;
722 OMX_VIDEO_WMVFORMATTYPE eFormat;
723 } OMX_VIDEO_PARAM_WMVTYPE;
729 typedef enum OMX_VIDEO_RVFORMATTYPE {
730 OMX_VIDEO_RVFormatUnused = 0, /**< Format unused or unknown */
731 OMX_VIDEO_RVFormat8, /**< Real Video format 8 */
732 OMX_VIDEO_RVFormat9, /**< Real Video format 9 */
733 OMX_VIDEO_RVFormatG2, /**< Real Video Format G2 */
734 OMX_VIDEO_RVFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
735 OMX_VIDEO_RVFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
736 OMX_VIDEO_RVFormatMax = 0x7FFFFFFF
737 } OMX_VIDEO_RVFORMATTYPE;
744 * nSize : Size of the structure in bytes
745 * nVersion : OMX specification version information
746 * nPortIndex : Port that this structure applies to
747 * eFormat : Version of RV stream / data
748 * nBitsPerPixel : Bits per pixel coded in the frame
749 * nPaddedWidth : Padded width in pixel of a video frame
750 * nPaddedHeight : Padded Height in pixels of a video frame
751 * nFrameRate : Rate of video in frames per second
752 * nBitstreamFlags : Flags which internal information about the bitstream
753 * nBitstreamVersion : Bitstream version
754 * nMaxEncodeFrameSize: Max encoded frame size
755 * bEnablePostFilter : Turn on/off post filter
756 * bEnableTemporalInterpolation : Turn on/off temporal interpolation
757 * bEnableLatencyMode : When enabled, the decoder does not display a decoded
758 * frame until it has detected that no enhancement layer
759 * frames or dependent B frames will be coming. This
760 * detection usually occurs when a subsequent non-B
761 * frame is encountered
763 typedef struct OMX_VIDEO_PARAM_RVTYPE {
765 OMX_VERSIONTYPE nVersion;
767 OMX_VIDEO_RVFORMATTYPE eFormat;
768 OMX_U16 nBitsPerPixel;
769 OMX_U16 nPaddedWidth;
770 OMX_U16 nPaddedHeight;
772 OMX_U32 nBitstreamFlags;
773 OMX_U32 nBitstreamVersion;
774 OMX_U32 nMaxEncodeFrameSize;
775 OMX_BOOL bEnablePostFilter;
776 OMX_BOOL bEnableTemporalInterpolation;
777 OMX_BOOL bEnableLatencyMode;
778 } OMX_VIDEO_PARAM_RVTYPE;
782 * AVC profile types, each profile indicates support for various
783 * performance bounds and different annexes.
785 typedef enum OMX_VIDEO_AVCPROFILETYPE {
786 OMX_VIDEO_AVCProfileBaseline = 0x01, /**< Baseline profile */
787 OMX_VIDEO_AVCProfileMain = 0x02, /**< Main profile */
788 OMX_VIDEO_AVCProfileExtended = 0x04, /**< Extended profile */
789 OMX_VIDEO_AVCProfileHigh = 0x08, /**< High profile */
790 OMX_VIDEO_AVCProfileHigh10 = 0x10, /**< High 10 profile */
791 OMX_VIDEO_AVCProfileHigh422 = 0x20, /**< High 4:2:2 profile */
792 OMX_VIDEO_AVCProfileHigh444 = 0x40, /**< High 4:4:4 profile */
793 OMX_VIDEO_AVCProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
794 OMX_VIDEO_AVCProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
795 OMX_VIDEO_AVCProfileMax = 0x7FFFFFFF
796 } OMX_VIDEO_AVCPROFILETYPE;
800 * AVC level types, each level indicates support for various frame sizes,
801 * bit rates, decoder frame rates. No need
803 typedef enum OMX_VIDEO_AVCLEVELTYPE {
804 OMX_VIDEO_AVCLevel1 = 0x01, /**< Level 1 */
805 OMX_VIDEO_AVCLevel1b = 0x02, /**< Level 1b */
806 OMX_VIDEO_AVCLevel11 = 0x04, /**< Level 1.1 */
807 OMX_VIDEO_AVCLevel12 = 0x08, /**< Level 1.2 */
808 OMX_VIDEO_AVCLevel13 = 0x10, /**< Level 1.3 */
809 OMX_VIDEO_AVCLevel2 = 0x20, /**< Level 2 */
810 OMX_VIDEO_AVCLevel21 = 0x40, /**< Level 2.1 */
811 OMX_VIDEO_AVCLevel22 = 0x80, /**< Level 2.2 */
812 OMX_VIDEO_AVCLevel3 = 0x100, /**< Level 3 */
813 OMX_VIDEO_AVCLevel31 = 0x200, /**< Level 3.1 */
814 OMX_VIDEO_AVCLevel32 = 0x400, /**< Level 3.2 */
815 OMX_VIDEO_AVCLevel4 = 0x800, /**< Level 4 */
816 OMX_VIDEO_AVCLevel41 = 0x1000, /**< Level 4.1 */
817 OMX_VIDEO_AVCLevel42 = 0x2000, /**< Level 4.2 */
818 OMX_VIDEO_AVCLevel5 = 0x4000, /**< Level 5 */
819 OMX_VIDEO_AVCLevel51 = 0x8000, /**< Level 5.1 */
820 OMX_VIDEO_AVCLevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
821 OMX_VIDEO_AVCLevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
822 OMX_VIDEO_AVCLevelMax = 0x7FFFFFFF
823 } OMX_VIDEO_AVCLEVELTYPE;
827 * AVC loop filter modes
829 * OMX_VIDEO_AVCLoopFilterEnable : Enable
830 * OMX_VIDEO_AVCLoopFilterDisable : Disable
831 * OMX_VIDEO_AVCLoopFilterDisableSliceBoundary : Disabled on slice boundaries
833 typedef enum OMX_VIDEO_AVCLOOPFILTERTYPE {
834 OMX_VIDEO_AVCLoopFilterEnable = 0,
835 OMX_VIDEO_AVCLoopFilterDisable,
836 OMX_VIDEO_AVCLoopFilterDisableSliceBoundary,
837 OMX_VIDEO_AVCLoopFilterKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
838 OMX_VIDEO_AVCLoopFilterVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
839 OMX_VIDEO_AVCLoopFilterMax = 0x7FFFFFFF
840 } OMX_VIDEO_AVCLOOPFILTERTYPE;
847 * nSize : Size of the structure in bytes
848 * nVersion : OMX specification version information
849 * nPortIndex : Port that this structure applies to
850 * nSliceHeaderSpacing : Number of macroblocks between slice header, put
852 * nPFrames : Number of P frames between each I frame
853 * nBFrames : Number of B frames between each I frame
854 * bUseHadamard : Enable/disable Hadamard transform
855 * nRefFrames : Max number of reference frames to use for inter
856 * motion search (1-16)
857 * nRefIdxTrailing : Pic param set ref frame index (index into ref
858 * frame buffer of trailing frames list), B frame
860 * nRefIdxForward : Pic param set ref frame index (index into ref
861 * frame buffer of forward frames list), B frame
863 * bEnableUEP : Enable/disable unequal error protection. This
864 * is only valid of data partitioning is enabled.
865 * bEnableFMO : Enable/disable flexible macroblock ordering
866 * bEnableASO : Enable/disable arbitrary slice ordering
867 * bEnableRS : Enable/disable sending of redundant slices
868 * eProfile : AVC profile(s) to use
869 * eLevel : AVC level(s) to use
870 * nAllowedPictureTypes : Specifies the picture types allowed in the
872 * bFrameMBsOnly : specifies that every coded picture of the
873 * coded video sequence is a coded frame
874 * containing only frame macroblocks
875 * bMBAFF : Enable/disable switching between frame and
876 * field macroblocks within a picture
877 * bEntropyCodingCABAC : Entropy decoding method to be applied for the
878 * syntax elements for which two descriptors appear
879 * in the syntax tables
880 * bWeightedPPrediction : Enable/disable weighted prediction shall not
881 * be applied to P and SP slices
882 * nWeightedBipredicitonMode : Default weighted prediction is applied to B
884 * bconstIpred : Enable/disable intra prediction
885 * bDirect8x8Inference : Specifies the method used in the derivation
886 * process for luma motion vectors for B_Skip,
887 * B_Direct_16x16 and B_Direct_8x8 as specified
888 * in subclause 8.4.1.2 of the AVC spec
889 * bDirectSpatialTemporal : Flag indicating spatial or temporal direct
890 * mode used in B slice coding (related to
891 * bDirect8x8Inference) . Spatial direct mode is
892 * more common and should be the default.
893 * nCabacInitIdx : Index used to init CABAC contexts
894 * eLoopFilterMode : Enable/disable loop filter
896 typedef struct OMX_VIDEO_PARAM_AVCTYPE {
898 OMX_VERSIONTYPE nVersion;
900 OMX_U32 nSliceHeaderSpacing;
903 OMX_BOOL bUseHadamard;
905 OMX_U32 nRefIdx10ActiveMinus1;
906 OMX_U32 nRefIdx11ActiveMinus1;
911 OMX_VIDEO_AVCPROFILETYPE eProfile;
912 OMX_VIDEO_AVCLEVELTYPE eLevel;
913 OMX_U32 nAllowedPictureTypes;
914 OMX_BOOL bFrameMBsOnly;
916 OMX_BOOL bEntropyCodingCABAC;
917 OMX_BOOL bWeightedPPrediction;
918 OMX_U32 nWeightedBipredicitonMode;
919 OMX_BOOL bconstIpred ;
920 OMX_BOOL bDirect8x8Inference;
921 OMX_BOOL bDirectSpatialTemporal;
922 OMX_U32 nCabacInitIdc;
923 OMX_VIDEO_AVCLOOPFILTERTYPE eLoopFilterMode;
924 } OMX_VIDEO_PARAM_AVCTYPE;
926 typedef struct OMX_VIDEO_PARAM_PROFILELEVELTYPE {
928 OMX_VERSIONTYPE nVersion;
930 OMX_U32 eProfile; /**< type is OMX_VIDEO_AVCPROFILETYPE, OMX_VIDEO_H263PROFILETYPE,
931 or OMX_VIDEO_MPEG4PROFILETYPE depending on context */
932 OMX_U32 eLevel; /**< type is OMX_VIDEO_AVCLEVELTYPE, OMX_VIDEO_H263LEVELTYPE,
933 or OMX_VIDEO_MPEG4PROFILETYPE depending on context */
934 OMX_U32 nProfileIndex; /**< Used to query for individual profile support information,
935 This parameter is valid only for
936 OMX_IndexParamVideoProfileLevelQuerySupported index,
937 For all other indices this parameter is to be ignored. */
938 } OMX_VIDEO_PARAM_PROFILELEVELTYPE;
941 * Structure for dynamically configuring bitrate mode of a codec.
944 * nSize : Size of the struct in bytes
945 * nVersion : OMX spec version info
946 * nPortIndex : Port that this struct applies to
947 * nEncodeBitrate : Target average bitrate to be generated in bps
949 typedef struct OMX_VIDEO_CONFIG_BITRATETYPE {
951 OMX_VERSIONTYPE nVersion;
953 OMX_U32 nEncodeBitrate;
954 } OMX_VIDEO_CONFIG_BITRATETYPE;
957 * Defines Encoder Frame Rate setting
960 * nSize : Size of the structure in bytes
961 * nVersion : OMX specification version information
962 * nPortIndex : Port that this structure applies to
963 * xEncodeFramerate : Encoding framerate represented in Q16 format
965 typedef struct OMX_CONFIG_FRAMERATETYPE {
967 OMX_VERSIONTYPE nVersion;
969 OMX_U32 xEncodeFramerate; /* Q16 format */
970 } OMX_CONFIG_FRAMERATETYPE;
972 typedef struct OMX_CONFIG_INTRAREFRESHVOPTYPE {
974 OMX_VERSIONTYPE nVersion;
976 OMX_BOOL IntraRefreshVOP;
977 } OMX_CONFIG_INTRAREFRESHVOPTYPE;
979 typedef struct OMX_CONFIG_MACROBLOCKERRORMAPTYPE {
981 OMX_VERSIONTYPE nVersion;
983 OMX_U32 nErrMapSize; /* Size of the Error Map in bytes */
984 OMX_U8 ErrMap[1]; /* Error map hint */
985 } OMX_CONFIG_MACROBLOCKERRORMAPTYPE;
987 typedef struct OMX_CONFIG_MBERRORREPORTINGTYPE {
989 OMX_VERSIONTYPE nVersion;
992 } OMX_CONFIG_MBERRORREPORTINGTYPE;
994 typedef struct OMX_PARAM_MACROBLOCKSTYPE {
996 OMX_VERSIONTYPE nVersion;
998 OMX_U32 nMacroblocks;
999 } OMX_PARAM_MACROBLOCKSTYPE;
1002 * AVC Slice Mode modes
1004 * OMX_VIDEO_SLICEMODE_AVCDefault : Normal frame encoding, one slice per frame
1005 * OMX_VIDEO_SLICEMODE_AVCMBSlice : NAL mode, number of MBs per frame
1006 * OMX_VIDEO_SLICEMODE_AVCByteSlice : NAL mode, number of bytes per frame
1008 typedef enum OMX_VIDEO_AVCSLICEMODETYPE {
1009 OMX_VIDEO_SLICEMODE_AVCDefault = 0,
1010 OMX_VIDEO_SLICEMODE_AVCMBSlice,
1011 OMX_VIDEO_SLICEMODE_AVCByteSlice,
1012 OMX_VIDEO_SLICEMODE_AVCKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
1013 OMX_VIDEO_SLICEMODE_AVCVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
1014 OMX_VIDEO_SLICEMODE_AVCLevelMax = 0x7FFFFFFF
1015 } OMX_VIDEO_AVCSLICEMODETYPE;
1018 * AVC FMO Slice Mode Params
1021 * nSize : Size of the structure in bytes
1022 * nVersion : OMX specification version information
1023 * nPortIndex : Port that this structure applies to
1024 * nNumSliceGroups : Specifies the number of slice groups
1025 * nSliceGroupMapType : Specifies the type of slice groups
1026 * eSliceMode : Specifies the type of slice
1028 typedef struct OMX_VIDEO_PARAM_AVCSLICEFMO {
1030 OMX_VERSIONTYPE nVersion;
1032 OMX_U8 nNumSliceGroups;
1033 OMX_U8 nSliceGroupMapType;
1034 OMX_VIDEO_AVCSLICEMODETYPE eSliceMode;
1035 } OMX_VIDEO_PARAM_AVCSLICEFMO;
1038 * AVC IDR Period Configs
1041 * nSize : Size of the structure in bytes
1042 * nVersion : OMX specification version information
1043 * nPortIndex : Port that this structure applies to
1044 * nIDRPeriod : Specifies periodicity of IDR frames
1045 * nPFrames : Specifies internal of coding Intra frames
1047 typedef struct OMX_VIDEO_CONFIG_AVCINTRAPERIOD {
1049 OMX_VERSIONTYPE nVersion;
1053 } OMX_VIDEO_CONFIG_AVCINTRAPERIOD;
1056 * AVC NAL Size Configs
1059 * nSize : Size of the structure in bytes
1060 * nVersion : OMX specification version information
1061 * nPortIndex : Port that this structure applies to
1062 * nNaluBytes : Specifies the NAL unit size
1064 typedef struct OMX_VIDEO_CONFIG_NALSIZE {
1066 OMX_VERSIONTYPE nVersion;
1069 } OMX_VIDEO_CONFIG_NALSIZE;
1075 #endif /* __cplusplus */