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_CodingVPX, /**< Google VPX, formerly known as On2 VP8 */
89 OMX_VIDEO_CodingKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
90 OMX_VIDEO_CodingVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
91 OMX_VIDEO_CodingMax = 0x7FFFFFFF
92 } OMX_VIDEO_CODINGTYPE;
96 * Data structure used to define a video path. The number of Video paths for
97 * input and output will vary by type of the Video component.
99 * Input (aka Source) : zero Inputs, one Output,
100 * Splitter : one Input, 2 or more Outputs,
101 * Processing Element : one Input, one output,
102 * Mixer : 2 or more inputs, one output,
103 * Output (aka Sink) : one Input, zero outputs.
105 * The PortDefinition structure is used to define all of the parameters
106 * necessary for the compliant component to setup an input or an output video
107 * path. If additional vendor specific data is required, it should be
108 * transmitted to the component using the CustomCommand function. Compliant
109 * components will prepopulate this structure with optimal values during the
110 * GetDefaultInitParams command.
113 * cMIMEType : MIME type of data for the port
114 * pNativeRender : Platform specific reference for a display if a
115 * sync, otherwise this field is 0
116 * nFrameWidth : Width of frame to be used on channel if
117 * uncompressed format is used. Use 0 for unknown,
118 * don't care or variable
119 * nFrameHeight : Height of frame to be used on channel if
120 * uncompressed format is used. Use 0 for unknown,
121 * don't care or variable
122 * nStride : Number of bytes per span of an image
123 * (i.e. indicates the number of bytes to get
124 * from span N to span N+1, where negative stride
125 * indicates the image is bottom up
126 * nSliceHeight : Height used when encoding in slices
127 * nBitrate : Bit rate of frame to be used on channel if
128 * compressed format is used. Use 0 for unknown,
129 * don't care or variable
130 * xFramerate : Frame rate to be used on channel if uncompressed
131 * format is used. Use 0 for unknown, don't care or
132 * variable. Units are Q16 frames per second.
133 * bFlagErrorConcealment : Turns on error concealment if it is supported by
135 * eCompressionFormat : Compression format used in this instance of the
136 * component. When OMX_VIDEO_CodingUnused is
137 * specified, eColorFormat is used
138 * eColorFormat : Decompressed format used by this component
139 * pNativeWindow : Platform specific reference for a window object if a
140 * display sink , otherwise this field is 0x0.
142 typedef struct OMX_VIDEO_PORTDEFINITIONTYPE {
143 OMX_STRING cMIMEType;
144 OMX_NATIVE_DEVICETYPE pNativeRender;
146 OMX_U32 nFrameHeight;
148 OMX_U32 nSliceHeight;
151 OMX_BOOL bFlagErrorConcealment;
152 OMX_VIDEO_CODINGTYPE eCompressionFormat;
153 OMX_COLOR_FORMATTYPE eColorFormat;
154 OMX_NATIVE_WINDOWTYPE pNativeWindow;
155 } OMX_VIDEO_PORTDEFINITIONTYPE;
158 * Port format parameter. This structure is used to enumerate the various
159 * data input/output format supported by the port.
162 * nSize : Size of the structure in bytes
163 * nVersion : OMX specification version information
164 * nPortIndex : Indicates which port to set
165 * nIndex : Indicates the enumeration index for the format from
167 * eCompressionFormat : Compression format used in this instance of the
168 * component. When OMX_VIDEO_CodingUnused is specified,
169 * eColorFormat is used
170 * eColorFormat : Decompressed format used by this component
171 * xFrameRate : Indicates the video frame rate in Q16 format
173 typedef struct OMX_VIDEO_PARAM_PORTFORMATTYPE {
175 OMX_VERSIONTYPE nVersion;
178 OMX_VIDEO_CODINGTYPE eCompressionFormat;
179 OMX_COLOR_FORMATTYPE eColorFormat;
181 } OMX_VIDEO_PARAM_PORTFORMATTYPE;
185 * This is a structure for configuring video compression quantization
186 * parameter values. Codecs may support different QP values for different
190 * nSize : Size of the structure in bytes
191 * nVersion : OMX specification version info
192 * nPortIndex : Port that this structure applies to
193 * nQpI : QP value to use for index frames
194 * nQpP : QP value to use for P frames
195 * nQpB : QP values to use for bidirectional frames
197 typedef struct OMX_VIDEO_PARAM_QUANTIZATIONTYPE {
199 OMX_VERSIONTYPE nVersion;
204 } OMX_VIDEO_PARAM_QUANTIZATIONTYPE;
208 * Structure for configuration of video fast update parameters.
211 * nSize : Size of the structure in bytes
212 * nVersion : OMX specification version info
213 * nPortIndex : Port that this structure applies to
214 * bEnableVFU : Enable/Disable video fast update
215 * nFirstGOB : Specifies the number of the first macroblock row
216 * nFirstMB : specifies the first MB relative to the specified first GOB
217 * nNumMBs : Specifies the number of MBs to be refreshed from nFirstGOB
220 typedef struct OMX_VIDEO_PARAM_VIDEOFASTUPDATETYPE {
222 OMX_VERSIONTYPE nVersion;
228 } OMX_VIDEO_PARAM_VIDEOFASTUPDATETYPE;
232 * Enumeration of possible bitrate control types
234 typedef enum OMX_VIDEO_CONTROLRATETYPE {
235 OMX_Video_ControlRateDisable,
236 OMX_Video_ControlRateVariable,
237 OMX_Video_ControlRateConstant,
238 OMX_Video_ControlRateVariableSkipFrames,
239 OMX_Video_ControlRateConstantSkipFrames,
240 OMX_Video_ControlRateKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
241 OMX_Video_ControlRateVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
242 OMX_Video_ControlRateMax = 0x7FFFFFFF
243 } OMX_VIDEO_CONTROLRATETYPE;
247 * Structure for configuring bitrate mode of a codec.
250 * nSize : Size of the struct in bytes
251 * nVersion : OMX spec version info
252 * nPortIndex : Port that this struct applies to
253 * eControlRate : Control rate type enum
254 * nTargetBitrate : Target bitrate to encode with
256 typedef struct OMX_VIDEO_PARAM_BITRATETYPE {
258 OMX_VERSIONTYPE nVersion;
260 OMX_VIDEO_CONTROLRATETYPE eControlRate;
261 OMX_U32 nTargetBitrate;
262 } OMX_VIDEO_PARAM_BITRATETYPE;
266 * Enumeration of possible motion vector (MV) types
268 typedef enum OMX_VIDEO_MOTIONVECTORTYPE {
269 OMX_Video_MotionVectorPixel,
270 OMX_Video_MotionVectorHalfPel,
271 OMX_Video_MotionVectorQuarterPel,
272 OMX_Video_MotionVectorEighthPel,
273 OMX_Video_MotionVectorKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
274 OMX_Video_MotionVectorVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
275 OMX_Video_MotionVectorMax = 0x7FFFFFFF
276 } OMX_VIDEO_MOTIONVECTORTYPE;
280 * Structure for configuring the number of motion vectors used as well
284 * nSize : Size of the struct in bytes
285 * nVersion : OMX spec version info
286 * nPortIndex : port that this structure applies to
287 * eAccuracy : Enumerated MV accuracy
288 * bUnrestrictedMVs : Allow unrestricted MVs
289 * bFourMV : Allow use of 4 MVs
290 * sXSearchRange : Search range in horizontal direction for MVs
291 * sYSearchRange : Search range in vertical direction for MVs
293 typedef struct OMX_VIDEO_PARAM_MOTIONVECTORTYPE {
295 OMX_VERSIONTYPE nVersion;
297 OMX_VIDEO_MOTIONVECTORTYPE eAccuracy;
298 OMX_BOOL bUnrestrictedMVs;
300 OMX_S32 sXSearchRange;
301 OMX_S32 sYSearchRange;
302 } OMX_VIDEO_PARAM_MOTIONVECTORTYPE;
306 * Enumeration of possible methods to use for Intra Refresh
308 typedef enum OMX_VIDEO_INTRAREFRESHTYPE {
309 OMX_VIDEO_IntraRefreshCyclic,
310 OMX_VIDEO_IntraRefreshAdaptive,
311 OMX_VIDEO_IntraRefreshBoth,
312 OMX_VIDEO_IntraRefreshKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
313 OMX_VIDEO_IntraRefreshVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
314 OMX_VIDEO_IntraRefreshMax = 0x7FFFFFFF
315 } OMX_VIDEO_INTRAREFRESHTYPE;
319 * Structure for configuring intra refresh mode
322 * nSize : Size of the structure in bytes
323 * nVersion : OMX specification version information
324 * nPortIndex : Port that this structure applies to
325 * eRefreshMode : Cyclic, Adaptive, or Both
326 * nAirMBs : Number of intra macroblocks to refresh in a frame when
328 * nAirRef : Number of times a motion marked macroblock has to be
330 * nCirMBs : Number of consecutive macroblocks to be coded as "intra"
331 * when CIR is enabled
333 typedef struct OMX_VIDEO_PARAM_INTRAREFRESHTYPE {
335 OMX_VERSIONTYPE nVersion;
337 OMX_VIDEO_INTRAREFRESHTYPE eRefreshMode;
341 } OMX_VIDEO_PARAM_INTRAREFRESHTYPE;
345 * Structure for enabling various error correction methods for video
349 * nSize : Size of the structure in bytes
350 * nVersion : OMX specification version information
351 * nPortIndex : Port that this structure applies to
352 * bEnableHEC : Enable/disable header extension codes (HEC)
353 * bEnableResync : Enable/disable resynchronization markers
354 * nResynchMarkerSpacing : Resynch markers interval (in bits) to be
355 * applied in the stream
356 * bEnableDataPartitioning : Enable/disable data partitioning
357 * bEnableRVLC : Enable/disable reversible variable length
360 typedef struct OMX_VIDEO_PARAM_ERRORCORRECTIONTYPE {
362 OMX_VERSIONTYPE nVersion;
365 OMX_BOOL bEnableResync;
366 OMX_U32 nResynchMarkerSpacing;
367 OMX_BOOL bEnableDataPartitioning;
368 OMX_BOOL bEnableRVLC;
369 } OMX_VIDEO_PARAM_ERRORCORRECTIONTYPE;
373 * Configuration of variable block-size motion compensation (VBSMC)
376 * nSize : Size of the structure in bytes
377 * nVersion : OMX specification version information
378 * nPortIndex : Port that this structure applies to
379 * b16x16 : Enable inter block search 16x16
380 * b16x8 : Enable inter block search 16x8
381 * b8x16 : Enable inter block search 8x16
382 * b8x8 : Enable inter block search 8x8
383 * b8x4 : Enable inter block search 8x4
384 * b4x8 : Enable inter block search 4x8
385 * b4x4 : Enable inter block search 4x4
387 typedef struct OMX_VIDEO_PARAM_VBSMCTYPE {
389 OMX_VERSIONTYPE nVersion;
398 } OMX_VIDEO_PARAM_VBSMCTYPE;
402 * H.263 profile types, each profile indicates support for various
403 * performance bounds and different annexes.
406 * Baseline : Baseline Profile: H.263 (V1), no optional modes
407 * H320 Coding : H.320 Coding Efficiency Backward Compatibility
408 * Profile: H.263+ (V2), includes annexes I, J, L.4
410 * BackwardCompatible : Backward Compatibility Profile: H.263 (V1),
412 * ISWV2 : Interactive Streaming Wireless Profile: H.263+
413 * (V2), includes annexes I, J, K and T
414 * ISWV3 : Interactive Streaming Wireless Profile: H.263++
415 * (V3), includes profile 3 and annexes V and W.6.3.8
416 * HighCompression : Conversational High Compression Profile: H.263++
417 * (V3), includes profiles 1 & 2 and annexes D and U
418 * Internet : Conversational Internet Profile: H.263++ (V3),
419 * includes profile 5 and annex K
420 * Interlace : Conversational Interlace Profile: H.263++ (V3),
421 * includes profile 5 and annex W.6.3.11
422 * HighLatency : High Latency Profile: H.263++ (V3), includes
423 * profile 6 and annexes O.1 and P.5
425 typedef enum OMX_VIDEO_H263PROFILETYPE {
426 OMX_VIDEO_H263ProfileBaseline = 0x01,
427 OMX_VIDEO_H263ProfileH320Coding = 0x02,
428 OMX_VIDEO_H263ProfileBackwardCompatible = 0x04,
429 OMX_VIDEO_H263ProfileISWV2 = 0x08,
430 OMX_VIDEO_H263ProfileISWV3 = 0x10,
431 OMX_VIDEO_H263ProfileHighCompression = 0x20,
432 OMX_VIDEO_H263ProfileInternet = 0x40,
433 OMX_VIDEO_H263ProfileInterlace = 0x80,
434 OMX_VIDEO_H263ProfileHighLatency = 0x100,
435 OMX_VIDEO_H263ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
436 OMX_VIDEO_H263ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
437 OMX_VIDEO_H263ProfileMax = 0x7FFFFFFF
438 } OMX_VIDEO_H263PROFILETYPE;
442 * H.263 level types, each level indicates support for various frame sizes,
443 * bit rates, decoder frame rates.
445 typedef enum OMX_VIDEO_H263LEVELTYPE {
446 OMX_VIDEO_H263Level10 = 0x01,
447 OMX_VIDEO_H263Level20 = 0x02,
448 OMX_VIDEO_H263Level30 = 0x04,
449 OMX_VIDEO_H263Level40 = 0x08,
450 OMX_VIDEO_H263Level45 = 0x10,
451 OMX_VIDEO_H263Level50 = 0x20,
452 OMX_VIDEO_H263Level60 = 0x40,
453 OMX_VIDEO_H263Level70 = 0x80,
454 OMX_VIDEO_H263LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
455 OMX_VIDEO_H263LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
456 OMX_VIDEO_H263LevelMax = 0x7FFFFFFF
457 } OMX_VIDEO_H263LEVELTYPE;
461 * Specifies the picture type. These values should be OR'd to signal all
462 * pictures types which are allowed.
465 * Generic Picture Types: I, P and B
466 * H.263 Specific Picture Types: SI and SP
467 * H.264 Specific Picture Types: EI and EP
468 * MPEG-4 Specific Picture Types: S
470 typedef enum OMX_VIDEO_PICTURETYPE {
471 OMX_VIDEO_PictureTypeI = 0x01,
472 OMX_VIDEO_PictureTypeP = 0x02,
473 OMX_VIDEO_PictureTypeB = 0x04,
474 OMX_VIDEO_PictureTypeSI = 0x08,
475 OMX_VIDEO_PictureTypeSP = 0x10,
476 OMX_VIDEO_PictureTypeEI = 0x11,
477 OMX_VIDEO_PictureTypeEP = 0x12,
478 OMX_VIDEO_PictureTypeS = 0x14,
479 OMX_VIDEO_PictureTypeKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
480 OMX_VIDEO_PictureTypeVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
481 OMX_VIDEO_PictureTypeMax = 0x7FFFFFFF
482 } OMX_VIDEO_PICTURETYPE;
489 * nSize : Size of the structure in bytes
490 * nVersion : OMX specification version information
491 * nPortIndex : Port that this structure applies to
492 * nPFrames : Number of P frames between each I frame
493 * nBFrames : Number of B frames between each I frame
494 * eProfile : H.263 profile(s) to use
495 * eLevel : H.263 level(s) to use
496 * bPLUSPTYPEAllowed : Indicating that it is allowed to use PLUSPTYPE
497 * (specified in the 1998 version of H.263) to
498 * indicate custom picture sizes or clock
500 * nAllowedPictureTypes : Specifies the picture types allowed in the
502 * bForceRoundingTypeToZero : value of the RTYPE bit (bit 6 of MPPTYPE) is
503 * not constrained. It is recommended to change
504 * the value of the RTYPE bit for each reference
505 * picture in error-free communication
506 * nPictureHeaderRepetition : Specifies the frequency of picture header
508 * nGOBHeaderInterval : Specifies the interval of non-empty GOB
509 * headers in units of GOBs
511 typedef struct OMX_VIDEO_PARAM_H263TYPE {
513 OMX_VERSIONTYPE nVersion;
517 OMX_VIDEO_H263PROFILETYPE eProfile;
518 OMX_VIDEO_H263LEVELTYPE eLevel;
519 OMX_BOOL bPLUSPTYPEAllowed;
520 OMX_U32 nAllowedPictureTypes;
521 OMX_BOOL bForceRoundingTypeToZero;
522 OMX_U32 nPictureHeaderRepetition;
523 OMX_U32 nGOBHeaderInterval;
524 } OMX_VIDEO_PARAM_H263TYPE;
528 * MPEG-2 profile types, each profile indicates support for various
529 * performance bounds and different annexes.
531 typedef enum OMX_VIDEO_MPEG2PROFILETYPE {
532 OMX_VIDEO_MPEG2ProfileSimple = 0, /**< Simple Profile */
533 OMX_VIDEO_MPEG2ProfileMain, /**< Main Profile */
534 OMX_VIDEO_MPEG2Profile422, /**< 4:2:2 Profile */
535 OMX_VIDEO_MPEG2ProfileSNR, /**< SNR Profile */
536 OMX_VIDEO_MPEG2ProfileSpatial, /**< Spatial Profile */
537 OMX_VIDEO_MPEG2ProfileHigh, /**< High Profile */
538 OMX_VIDEO_MPEG2ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
539 OMX_VIDEO_MPEG2ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
540 OMX_VIDEO_MPEG2ProfileMax = 0x7FFFFFFF
541 } OMX_VIDEO_MPEG2PROFILETYPE;
545 * MPEG-2 level types, each level indicates support for various frame
546 * sizes, bit rates, decoder frame rates. No need
548 typedef enum OMX_VIDEO_MPEG2LEVELTYPE {
549 OMX_VIDEO_MPEG2LevelLL = 0, /**< Low Level */
550 OMX_VIDEO_MPEG2LevelML, /**< Main Level */
551 OMX_VIDEO_MPEG2LevelH14, /**< High 1440 */
552 OMX_VIDEO_MPEG2LevelHL, /**< High Level */
553 OMX_VIDEO_MPEG2LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
554 OMX_VIDEO_MPEG2LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
555 OMX_VIDEO_MPEG2LevelMax = 0x7FFFFFFF
556 } OMX_VIDEO_MPEG2LEVELTYPE;
563 * nSize : Size of the structure in bytes
564 * nVersion : OMX specification version information
565 * nPortIndex : Port that this structure applies to
566 * nPFrames : Number of P frames between each I frame
567 * nBFrames : Number of B frames between each I frame
568 * eProfile : MPEG-2 profile(s) to use
569 * eLevel : MPEG-2 levels(s) to use
571 typedef struct OMX_VIDEO_PARAM_MPEG2TYPE {
573 OMX_VERSIONTYPE nVersion;
577 OMX_VIDEO_MPEG2PROFILETYPE eProfile;
578 OMX_VIDEO_MPEG2LEVELTYPE eLevel;
579 } OMX_VIDEO_PARAM_MPEG2TYPE;
583 * MPEG-4 profile types, each profile indicates support for various
584 * performance bounds and different annexes.
587 * - Simple Profile, Levels 1-3
588 * - Simple Scalable Profile, Levels 1-2
589 * - Core Profile, Levels 1-2
590 * - Main Profile, Levels 2-4
591 * - N-bit Profile, Level 2
592 * - Scalable Texture Profile, Level 1
593 * - Simple Face Animation Profile, Levels 1-2
594 * - Simple Face and Body Animation (FBA) Profile, Levels 1-2
595 * - Basic Animated Texture Profile, Levels 1-2
596 * - Hybrid Profile, Levels 1-2
597 * - Advanced Real Time Simple Profiles, Levels 1-4
598 * - Core Scalable Profile, Levels 1-3
599 * - Advanced Coding Efficiency Profile, Levels 1-4
600 * - Advanced Core Profile, Levels 1-2
601 * - Advanced Scalable Texture, Levels 2-3
603 typedef enum OMX_VIDEO_MPEG4PROFILETYPE {
604 OMX_VIDEO_MPEG4ProfileSimple = 0x01,
605 OMX_VIDEO_MPEG4ProfileSimpleScalable = 0x02,
606 OMX_VIDEO_MPEG4ProfileCore = 0x04,
607 OMX_VIDEO_MPEG4ProfileMain = 0x08,
608 OMX_VIDEO_MPEG4ProfileNbit = 0x10,
609 OMX_VIDEO_MPEG4ProfileScalableTexture = 0x20,
610 OMX_VIDEO_MPEG4ProfileSimpleFace = 0x40,
611 OMX_VIDEO_MPEG4ProfileSimpleFBA = 0x80,
612 OMX_VIDEO_MPEG4ProfileBasicAnimated = 0x100,
613 OMX_VIDEO_MPEG4ProfileHybrid = 0x200,
614 OMX_VIDEO_MPEG4ProfileAdvancedRealTime = 0x400,
615 OMX_VIDEO_MPEG4ProfileCoreScalable = 0x800,
616 OMX_VIDEO_MPEG4ProfileAdvancedCoding = 0x1000,
617 OMX_VIDEO_MPEG4ProfileAdvancedCore = 0x2000,
618 OMX_VIDEO_MPEG4ProfileAdvancedScalable = 0x4000,
619 OMX_VIDEO_MPEG4ProfileAdvancedSimple = 0x8000,
620 OMX_VIDEO_MPEG4ProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
621 OMX_VIDEO_MPEG4ProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
622 OMX_VIDEO_MPEG4ProfileMax = 0x7FFFFFFF
623 } OMX_VIDEO_MPEG4PROFILETYPE;
627 * MPEG-4 level types, each level indicates support for various frame
628 * sizes, bit rates, decoder frame rates. No need
630 typedef enum OMX_VIDEO_MPEG4LEVELTYPE {
631 OMX_VIDEO_MPEG4Level0 = 0x01, /**< Level 0 */
632 OMX_VIDEO_MPEG4Level0b = 0x02, /**< Level 0b */
633 OMX_VIDEO_MPEG4Level1 = 0x04, /**< Level 1 */
634 OMX_VIDEO_MPEG4Level2 = 0x08, /**< Level 2 */
635 OMX_VIDEO_MPEG4Level3 = 0x10, /**< Level 3 */
636 OMX_VIDEO_MPEG4Level4 = 0x20, /**< Level 4 */
637 OMX_VIDEO_MPEG4Level4a = 0x40, /**< Level 4a */
638 OMX_VIDEO_MPEG4Level5 = 0x80, /**< Level 5 */
639 OMX_VIDEO_MPEG4LevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
640 OMX_VIDEO_MPEG4LevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
641 OMX_VIDEO_MPEG4LevelMax = 0x7FFFFFFF
642 } OMX_VIDEO_MPEG4LEVELTYPE;
646 * MPEG-4 configuration. This structure handles configuration options
647 * which are specific to MPEG4 algorithms
650 * nSize : Size of the structure in bytes
651 * nVersion : OMX specification version information
652 * nPortIndex : Port that this structure applies to
653 * nSliceHeaderSpacing : Number of macroblocks between slice header (H263+
654 * Annex K). Put zero if not used
655 * bSVH : Enable Short Video Header mode
656 * bGov : Flag to enable GOV
657 * nPFrames : Number of P frames between each I frame (also called
659 * nBFrames : Number of B frames between each I frame
660 * nIDCVLCThreshold : Value of intra DC VLC threshold
661 * bACPred : Flag to use ac prediction
662 * nMaxPacketSize : Maximum size of packet in bytes.
663 * nTimeIncRes : Used to pass VOP time increment resolution for MPEG4.
664 * Interpreted as described in MPEG4 standard.
665 * eProfile : MPEG-4 profile(s) to use.
666 * eLevel : MPEG-4 level(s) to use.
667 * nAllowedPictureTypes : Specifies the picture types allowed in the bitstream
668 * nHeaderExtension : Specifies the number of consecutive video packet
669 * headers within a VOP
670 * bReversibleVLC : Specifies whether reversible variable length coding
673 typedef struct OMX_VIDEO_PARAM_MPEG4TYPE {
675 OMX_VERSIONTYPE nVersion;
677 OMX_U32 nSliceHeaderSpacing;
682 OMX_U32 nIDCVLCThreshold;
684 OMX_U32 nMaxPacketSize;
686 OMX_VIDEO_MPEG4PROFILETYPE eProfile;
687 OMX_VIDEO_MPEG4LEVELTYPE eLevel;
688 OMX_U32 nAllowedPictureTypes;
689 OMX_U32 nHeaderExtension;
690 OMX_BOOL bReversibleVLC;
691 } OMX_VIDEO_PARAM_MPEG4TYPE;
697 typedef enum OMX_VIDEO_WMVFORMATTYPE {
698 OMX_VIDEO_WMVFormatUnused = 0x01, /**< Format unused or unknown */
699 OMX_VIDEO_WMVFormat7 = 0x02, /**< Windows Media Video format 7 */
700 OMX_VIDEO_WMVFormat8 = 0x04, /**< Windows Media Video format 8 */
701 OMX_VIDEO_WMVFormat9 = 0x08, /**< Windows Media Video format 9 */
702 OMX_VIDEO_WMFFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
703 OMX_VIDEO_WMFFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
704 OMX_VIDEO_WMVFormatMax = 0x7FFFFFFF
705 } OMX_VIDEO_WMVFORMATTYPE;
712 * nSize : Size of the structure in bytes
713 * nVersion : OMX specification version information
714 * nPortIndex : Port that this structure applies to
715 * eFormat : Version of WMV stream / data
717 typedef struct OMX_VIDEO_PARAM_WMVTYPE {
719 OMX_VERSIONTYPE nVersion;
721 OMX_VIDEO_WMVFORMATTYPE eFormat;
722 } OMX_VIDEO_PARAM_WMVTYPE;
728 typedef enum OMX_VIDEO_RVFORMATTYPE {
729 OMX_VIDEO_RVFormatUnused = 0, /**< Format unused or unknown */
730 OMX_VIDEO_RVFormat8, /**< Real Video format 8 */
731 OMX_VIDEO_RVFormat9, /**< Real Video format 9 */
732 OMX_VIDEO_RVFormatG2, /**< Real Video Format G2 */
733 OMX_VIDEO_RVFormatKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
734 OMX_VIDEO_RVFormatVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
735 OMX_VIDEO_RVFormatMax = 0x7FFFFFFF
736 } OMX_VIDEO_RVFORMATTYPE;
743 * nSize : Size of the structure in bytes
744 * nVersion : OMX specification version information
745 * nPortIndex : Port that this structure applies to
746 * eFormat : Version of RV stream / data
747 * nBitsPerPixel : Bits per pixel coded in the frame
748 * nPaddedWidth : Padded width in pixel of a video frame
749 * nPaddedHeight : Padded Height in pixels of a video frame
750 * nFrameRate : Rate of video in frames per second
751 * nBitstreamFlags : Flags which internal information about the bitstream
752 * nBitstreamVersion : Bitstream version
753 * nMaxEncodeFrameSize: Max encoded frame size
754 * bEnablePostFilter : Turn on/off post filter
755 * bEnableTemporalInterpolation : Turn on/off temporal interpolation
756 * bEnableLatencyMode : When enabled, the decoder does not display a decoded
757 * frame until it has detected that no enhancement layer
758 * frames or dependent B frames will be coming. This
759 * detection usually occurs when a subsequent non-B
760 * frame is encountered
762 typedef struct OMX_VIDEO_PARAM_RVTYPE {
764 OMX_VERSIONTYPE nVersion;
766 OMX_VIDEO_RVFORMATTYPE eFormat;
767 OMX_U16 nBitsPerPixel;
768 OMX_U16 nPaddedWidth;
769 OMX_U16 nPaddedHeight;
771 OMX_U32 nBitstreamFlags;
772 OMX_U32 nBitstreamVersion;
773 OMX_U32 nMaxEncodeFrameSize;
774 OMX_BOOL bEnablePostFilter;
775 OMX_BOOL bEnableTemporalInterpolation;
776 OMX_BOOL bEnableLatencyMode;
777 } OMX_VIDEO_PARAM_RVTYPE;
781 * AVC profile types, each profile indicates support for various
782 * performance bounds and different annexes.
784 typedef enum OMX_VIDEO_AVCPROFILETYPE {
785 OMX_VIDEO_AVCProfileBaseline = 0x01, /**< Baseline profile */
786 OMX_VIDEO_AVCProfileMain = 0x02, /**< Main profile */
787 OMX_VIDEO_AVCProfileExtended = 0x04, /**< Extended profile */
788 OMX_VIDEO_AVCProfileHigh = 0x08, /**< High profile */
789 OMX_VIDEO_AVCProfileHigh10 = 0x10, /**< High 10 profile */
790 OMX_VIDEO_AVCProfileHigh422 = 0x20, /**< High 4:2:2 profile */
791 OMX_VIDEO_AVCProfileHigh444 = 0x40, /**< High 4:4:4 profile */
792 OMX_VIDEO_AVCProfileKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
793 OMX_VIDEO_AVCProfileVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
794 OMX_VIDEO_AVCProfileMax = 0x7FFFFFFF
795 } OMX_VIDEO_AVCPROFILETYPE;
799 * AVC level types, each level indicates support for various frame sizes,
800 * bit rates, decoder frame rates. No need
802 typedef enum OMX_VIDEO_AVCLEVELTYPE {
803 OMX_VIDEO_AVCLevel1 = 0x01, /**< Level 1 */
804 OMX_VIDEO_AVCLevel1b = 0x02, /**< Level 1b */
805 OMX_VIDEO_AVCLevel11 = 0x04, /**< Level 1.1 */
806 OMX_VIDEO_AVCLevel12 = 0x08, /**< Level 1.2 */
807 OMX_VIDEO_AVCLevel13 = 0x10, /**< Level 1.3 */
808 OMX_VIDEO_AVCLevel2 = 0x20, /**< Level 2 */
809 OMX_VIDEO_AVCLevel21 = 0x40, /**< Level 2.1 */
810 OMX_VIDEO_AVCLevel22 = 0x80, /**< Level 2.2 */
811 OMX_VIDEO_AVCLevel3 = 0x100, /**< Level 3 */
812 OMX_VIDEO_AVCLevel31 = 0x200, /**< Level 3.1 */
813 OMX_VIDEO_AVCLevel32 = 0x400, /**< Level 3.2 */
814 OMX_VIDEO_AVCLevel4 = 0x800, /**< Level 4 */
815 OMX_VIDEO_AVCLevel41 = 0x1000, /**< Level 4.1 */
816 OMX_VIDEO_AVCLevel42 = 0x2000, /**< Level 4.2 */
817 OMX_VIDEO_AVCLevel5 = 0x4000, /**< Level 5 */
818 OMX_VIDEO_AVCLevel51 = 0x8000, /**< Level 5.1 */
819 OMX_VIDEO_AVCLevelKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
820 OMX_VIDEO_AVCLevelVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
821 OMX_VIDEO_AVCLevelMax = 0x7FFFFFFF
822 } OMX_VIDEO_AVCLEVELTYPE;
826 * AVC loop filter modes
828 * OMX_VIDEO_AVCLoopFilterEnable : Enable
829 * OMX_VIDEO_AVCLoopFilterDisable : Disable
830 * OMX_VIDEO_AVCLoopFilterDisableSliceBoundary : Disabled on slice boundaries
832 typedef enum OMX_VIDEO_AVCLOOPFILTERTYPE {
833 OMX_VIDEO_AVCLoopFilterEnable = 0,
834 OMX_VIDEO_AVCLoopFilterDisable,
835 OMX_VIDEO_AVCLoopFilterDisableSliceBoundary,
836 OMX_VIDEO_AVCLoopFilterKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
837 OMX_VIDEO_AVCLoopFilterVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
838 OMX_VIDEO_AVCLoopFilterMax = 0x7FFFFFFF
839 } OMX_VIDEO_AVCLOOPFILTERTYPE;
846 * nSize : Size of the structure in bytes
847 * nVersion : OMX specification version information
848 * nPortIndex : Port that this structure applies to
849 * nSliceHeaderSpacing : Number of macroblocks between slice header, put
851 * nPFrames : Number of P frames between each I frame
852 * nBFrames : Number of B frames between each I frame
853 * bUseHadamard : Enable/disable Hadamard transform
854 * nRefFrames : Max number of reference frames to use for inter
855 * motion search (1-16)
856 * nRefIdxTrailing : Pic param set ref frame index (index into ref
857 * frame buffer of trailing frames list), B frame
859 * nRefIdxForward : Pic param set ref frame index (index into ref
860 * frame buffer of forward frames list), B frame
862 * bEnableUEP : Enable/disable unequal error protection. This
863 * is only valid of data partitioning is enabled.
864 * bEnableFMO : Enable/disable flexible macroblock ordering
865 * bEnableASO : Enable/disable arbitrary slice ordering
866 * bEnableRS : Enable/disable sending of redundant slices
867 * eProfile : AVC profile(s) to use
868 * eLevel : AVC level(s) to use
869 * nAllowedPictureTypes : Specifies the picture types allowed in the
871 * bFrameMBsOnly : specifies that every coded picture of the
872 * coded video sequence is a coded frame
873 * containing only frame macroblocks
874 * bMBAFF : Enable/disable switching between frame and
875 * field macroblocks within a picture
876 * bEntropyCodingCABAC : Entropy decoding method to be applied for the
877 * syntax elements for which two descriptors appear
878 * in the syntax tables
879 * bWeightedPPrediction : Enable/disable weighted prediction shall not
880 * be applied to P and SP slices
881 * nWeightedBipredicitonMode : Default weighted prediction is applied to B
883 * bconstIpred : Enable/disable intra prediction
884 * bDirect8x8Inference : Specifies the method used in the derivation
885 * process for luma motion vectors for B_Skip,
886 * B_Direct_16x16 and B_Direct_8x8 as specified
887 * in subclause 8.4.1.2 of the AVC spec
888 * bDirectSpatialTemporal : Flag indicating spatial or temporal direct
889 * mode used in B slice coding (related to
890 * bDirect8x8Inference) . Spatial direct mode is
891 * more common and should be the default.
892 * nCabacInitIdx : Index used to init CABAC contexts
893 * eLoopFilterMode : Enable/disable loop filter
895 typedef struct OMX_VIDEO_PARAM_AVCTYPE {
897 OMX_VERSIONTYPE nVersion;
899 OMX_U32 nSliceHeaderSpacing;
902 OMX_BOOL bUseHadamard;
904 OMX_U32 nRefIdx10ActiveMinus1;
905 OMX_U32 nRefIdx11ActiveMinus1;
910 OMX_VIDEO_AVCPROFILETYPE eProfile;
911 OMX_VIDEO_AVCLEVELTYPE eLevel;
912 OMX_U32 nAllowedPictureTypes;
913 OMX_BOOL bFrameMBsOnly;
915 OMX_BOOL bEntropyCodingCABAC;
916 OMX_BOOL bWeightedPPrediction;
917 OMX_U32 nWeightedBipredicitonMode;
918 OMX_BOOL bconstIpred ;
919 OMX_BOOL bDirect8x8Inference;
920 OMX_BOOL bDirectSpatialTemporal;
921 OMX_U32 nCabacInitIdc;
922 OMX_VIDEO_AVCLOOPFILTERTYPE eLoopFilterMode;
923 } OMX_VIDEO_PARAM_AVCTYPE;
925 typedef struct OMX_VIDEO_PARAM_PROFILELEVELTYPE {
927 OMX_VERSIONTYPE nVersion;
929 OMX_U32 eProfile; /**< type is OMX_VIDEO_AVCPROFILETYPE, OMX_VIDEO_H263PROFILETYPE,
930 or OMX_VIDEO_MPEG4PROFILETYPE depending on context */
931 OMX_U32 eLevel; /**< type is OMX_VIDEO_AVCLEVELTYPE, OMX_VIDEO_H263LEVELTYPE,
932 or OMX_VIDEO_MPEG4PROFILETYPE depending on context */
933 OMX_U32 nProfileIndex; /**< Used to query for individual profile support information,
934 This parameter is valid only for
935 OMX_IndexParamVideoProfileLevelQuerySupported index,
936 For all other indices this parameter is to be ignored. */
937 } OMX_VIDEO_PARAM_PROFILELEVELTYPE;
940 * Structure for dynamically configuring bitrate mode of a codec.
943 * nSize : Size of the struct in bytes
944 * nVersion : OMX spec version info
945 * nPortIndex : Port that this struct applies to
946 * nEncodeBitrate : Target average bitrate to be generated in bps
948 typedef struct OMX_VIDEO_CONFIG_BITRATETYPE {
950 OMX_VERSIONTYPE nVersion;
952 OMX_U32 nEncodeBitrate;
953 } OMX_VIDEO_CONFIG_BITRATETYPE;
956 * Defines Encoder Frame Rate setting
959 * nSize : Size of the structure in bytes
960 * nVersion : OMX specification version information
961 * nPortIndex : Port that this structure applies to
962 * xEncodeFramerate : Encoding framerate represented in Q16 format
964 typedef struct OMX_CONFIG_FRAMERATETYPE {
966 OMX_VERSIONTYPE nVersion;
968 OMX_U32 xEncodeFramerate; /* Q16 format */
969 } OMX_CONFIG_FRAMERATETYPE;
971 typedef struct OMX_CONFIG_INTRAREFRESHVOPTYPE {
973 OMX_VERSIONTYPE nVersion;
975 OMX_BOOL IntraRefreshVOP;
976 } OMX_CONFIG_INTRAREFRESHVOPTYPE;
978 typedef struct OMX_CONFIG_MACROBLOCKERRORMAPTYPE {
980 OMX_VERSIONTYPE nVersion;
982 OMX_U32 nErrMapSize; /* Size of the Error Map in bytes */
983 OMX_U8 ErrMap[1]; /* Error map hint */
984 } OMX_CONFIG_MACROBLOCKERRORMAPTYPE;
986 typedef struct OMX_CONFIG_MBERRORREPORTINGTYPE {
988 OMX_VERSIONTYPE nVersion;
991 } OMX_CONFIG_MBERRORREPORTINGTYPE;
993 typedef struct OMX_PARAM_MACROBLOCKSTYPE {
995 OMX_VERSIONTYPE nVersion;
997 OMX_U32 nMacroblocks;
998 } OMX_PARAM_MACROBLOCKSTYPE;
1001 * AVC Slice Mode modes
1003 * OMX_VIDEO_SLICEMODE_AVCDefault : Normal frame encoding, one slice per frame
1004 * OMX_VIDEO_SLICEMODE_AVCMBSlice : NAL mode, number of MBs per frame
1005 * OMX_VIDEO_SLICEMODE_AVCByteSlice : NAL mode, number of bytes per frame
1007 typedef enum OMX_VIDEO_AVCSLICEMODETYPE {
1008 OMX_VIDEO_SLICEMODE_AVCDefault = 0,
1009 OMX_VIDEO_SLICEMODE_AVCMBSlice,
1010 OMX_VIDEO_SLICEMODE_AVCByteSlice,
1011 OMX_VIDEO_SLICEMODE_AVCKhronosExtensions = 0x6F000000, /**< Reserved region for introducing Khronos Standard Extensions */
1012 OMX_VIDEO_SLICEMODE_AVCVendorStartUnused = 0x7F000000, /**< Reserved region for introducing Vendor Extensions */
1013 OMX_VIDEO_SLICEMODE_AVCLevelMax = 0x7FFFFFFF
1014 } OMX_VIDEO_AVCSLICEMODETYPE;
1017 * AVC FMO Slice Mode Params
1020 * nSize : Size of the structure in bytes
1021 * nVersion : OMX specification version information
1022 * nPortIndex : Port that this structure applies to
1023 * nNumSliceGroups : Specifies the number of slice groups
1024 * nSliceGroupMapType : Specifies the type of slice groups
1025 * eSliceMode : Specifies the type of slice
1027 typedef struct OMX_VIDEO_PARAM_AVCSLICEFMO {
1029 OMX_VERSIONTYPE nVersion;
1031 OMX_U8 nNumSliceGroups;
1032 OMX_U8 nSliceGroupMapType;
1033 OMX_VIDEO_AVCSLICEMODETYPE eSliceMode;
1034 } OMX_VIDEO_PARAM_AVCSLICEFMO;
1037 * AVC IDR Period Configs
1040 * nSize : Size of the structure in bytes
1041 * nVersion : OMX specification version information
1042 * nPortIndex : Port that this structure applies to
1043 * nIDRPeriod : Specifies periodicity of IDR frames
1044 * nPFrames : Specifies internal of coding Intra frames
1046 typedef struct OMX_VIDEO_CONFIG_AVCINTRAPERIOD {
1048 OMX_VERSIONTYPE nVersion;
1052 } OMX_VIDEO_CONFIG_AVCINTRAPERIOD;
1055 * AVC NAL Size Configs
1058 * nSize : Size of the structure in bytes
1059 * nVersion : OMX specification version information
1060 * nPortIndex : Port that this structure applies to
1061 * nNaluBytes : Specifies the NAL unit size
1063 typedef struct OMX_VIDEO_CONFIG_NALSIZE {
1065 OMX_VERSIONTYPE nVersion;
1068 } OMX_VIDEO_CONFIG_NALSIZE;
1074 #endif /* __cplusplus */