/* * Copyright 2015 Rockchip Electronics Co. LTD * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef __MPP_FRAME_H__ #define __MPP_FRAME_H__ #include "mpp_buffer.h" #include "mpp_meta.h" /* * bit definition for mode flag in MppFrame */ /* progressive frame */ #define MPP_FRAME_FLAG_FRAME (0x00000000) /* top field only */ #define MPP_FRAME_FLAG_TOP_FIELD (0x00000001) /* bottom field only */ #define MPP_FRAME_FLAG_BOT_FIELD (0x00000002) /* paired field */ #define MPP_FRAME_FLAG_PAIRED_FIELD (MPP_FRAME_FLAG_TOP_FIELD|MPP_FRAME_FLAG_BOT_FIELD) /* paired field with field order of top first */ #define MPP_FRAME_FLAG_TOP_FIRST (0x00000004) /* paired field with field order of bottom first */ #define MPP_FRAME_FLAG_BOT_FIRST (0x00000008) /* paired field with unknown field order (MBAFF) */ #define MPP_FRAME_FLAG_DEINTERLACED (MPP_FRAME_FLAG_TOP_FIRST|MPP_FRAME_FLAG_BOT_FIRST) #define MPP_FRAME_FLAG_FIELD_ORDER_MASK (0x0000000C) // for multiview stream #define MPP_FRAME_FLAG_VIEW_ID_MASK (0x000000f0) #define MPP_FRAME_FLAG_IEP_DEI_MASK (0x00000f00) #define MPP_FRAME_FLAG_IEP_DEI_I2O1 (0x00000100) #define MPP_FRAME_FLAG_IEP_DEI_I4O2 (0x00000200) #define MPP_FRAME_FLAG_IEP_DEI_I4O1 (0x00000300) /* * MPEG vs JPEG YUV range. */ typedef enum { MPP_FRAME_RANGE_UNSPECIFIED = 0, MPP_FRAME_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges MPP_FRAME_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges MPP_FRAME_RANGE_NB, ///< Not part of ABI } MppFrameColorRange; typedef enum { MPP_FRAME_VIDEO_FMT_COMPONEMT = 0, MPP_FRAME_VIDEO_FMT_PAL = 1, MPP_FRAME_VIDEO_FMT_NTSC = 2, MPP_FRAME_VIDEO_FMT_SECAM = 3, MPP_FRAME_VIDEO_FMT_MAC = 4, MPP_FRAME_VIDEO_FMT_UNSPECIFIED = 5, MPP_FRAME_VIDEO_FMT_RESERVED0 = 6, MPP_FRAME_VIDEO_FMT_RESERVED1 = 7, } MppFrameVideoFormat; /* * Chromaticity coordinates of the source primaries. */ typedef enum { MPP_FRAME_PRI_RESERVED0 = 0, MPP_FRAME_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B MPP_FRAME_PRI_UNSPECIFIED = 2, MPP_FRAME_PRI_RESERVED = 3, MPP_FRAME_PRI_BT470M = 4, ///< also FCC Title 47 Code of Federal Regulations 73.682 (a)(20) MPP_FRAME_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM MPP_FRAME_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC/SMPTE ST 170 (2004) MPP_FRAME_PRI_SMPTE240M = 7, ///< functionally identical to above/SMPTE ST 240 MPP_FRAME_PRI_FILM = 8, ///< colour filters using Illuminant C MPP_FRAME_PRI_BT2020 = 9, ///< ITU-R BT2020 / ITU-R BT.2100-2 MPP_FRAME_PRI_SMPTEST428_1 = 10, ///< SMPTE ST 428-1 (CIE 1931 XYZ) MPP_FRAME_PRI_SMPTE431 = 11, ///< SMPTE ST 431-2 (2011) / DCI P3 MPP_FRAME_PRI_SMPTE432 = 12, ///< SMPTE ST 432-1 (2010) / P3 D65 / Display P3 MPP_FRAME_PRI_JEDEC_P22 = 22, ///< JEDEC P22 phosphors MPP_FRAME_PRI_NB, ///< Not part of ABI } MppFrameColorPrimaries; /* * Color Transfer Characteristic. */ typedef enum { MPP_FRAME_TRC_RESERVED0 = 0, MPP_FRAME_TRC_BT709 = 1, ///< also ITU-R BT1361 MPP_FRAME_TRC_UNSPECIFIED = 2, MPP_FRAME_TRC_RESERVED = 3, MPP_FRAME_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM MPP_FRAME_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG MPP_FRAME_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC MPP_FRAME_TRC_SMPTE240M = 7, MPP_FRAME_TRC_LINEAR = 8, ///< "Linear transfer characteristics" MPP_FRAME_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)" MPP_FRAME_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range)" MPP_FRAME_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4 MPP_FRAME_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut MPP_FRAME_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC) MPP_FRAME_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system MPP_FRAME_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system MPP_FRAME_TRC_SMPTEST2084 = 16, ///< SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems MPP_FRAME_TRC_SMPTEST428_1 = 17, ///< SMPTE ST 428-1 MPP_FRAME_TRC_ARIB_STD_B67 = 18, ///< ARIB STD-B67, known as "Hybrid log-gamma" MPP_FRAME_TRC_NB, ///< Not part of ABI } MppFrameColorTransferCharacteristic; /* * YUV colorspace type. */ typedef enum { MPP_FRAME_SPC_RGB = 0, ///< order of coefficients is actually GBR, also IEC 61966-2-1 (sRGB) MPP_FRAME_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B MPP_FRAME_SPC_UNSPECIFIED = 2, MPP_FRAME_SPC_RESERVED = 3, MPP_FRAME_SPC_FCC = 4, ///< FCC Title 47 Code of Federal Regulations 73.682 (a)(20) MPP_FRAME_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601 MPP_FRAME_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above MPP_FRAME_SPC_SMPTE240M = 7, MPP_FRAME_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16 MPP_FRAME_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system MPP_FRAME_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system MPP_FRAME_SPC_SMPTE2085 = 11, ///< SMPTE 2085, Y'D'zD'x MPP_FRAME_SPC_CHROMA_DERIVED_NCL = 12, ///< Chromaticity-derived non-constant luminance system MPP_FRAME_SPC_CHROMA_DERIVED_CL = 13, ///< Chromaticity-derived constant luminance system MPP_FRAME_SPC_ICTCP = 14, ///< ITU-R BT.2100-0, ICtCp MPP_FRAME_SPC_NB, ///< Not part of ABI } MppFrameColorSpace; /* * Location of chroma samples. * * Illustration showing the location of the first (top left) chroma sample of the * image, the left shows only luma, the right * shows the location of the chroma sample, the 2 could be imagined to overlay * each other but are drawn separately due to limitations of ASCII * * 1st 2nd 1st 2nd horizontal luma sample positions * v v v v * ______ ______ *1st luma line > |X X ... |3 4 X ... X are luma samples, * | |1 2 1-6 are possible chroma positions *2nd luma line > |X X ... |5 6 X ... 0 is undefined/unknown position */ typedef enum { MPP_CHROMA_LOC_UNSPECIFIED = 0, MPP_CHROMA_LOC_LEFT = 1, ///< mpeg2/4 4:2:0, h264 default for 4:2:0 MPP_CHROMA_LOC_CENTER = 2, ///< mpeg1 4:2:0, jpeg 4:2:0, h263 4:2:0 MPP_CHROMA_LOC_TOPLEFT = 3, ///< ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2 MPP_CHROMA_LOC_TOP = 4, MPP_CHROMA_LOC_BOTTOMLEFT = 5, MPP_CHROMA_LOC_BOTTOM = 6, MPP_CHROMA_LOC_NB, ///< Not part of ABI } MppFrameChromaLocation; #define MPP_FRAME_FMT_MASK (0x000fffff) #define MPP_FRAME_FMT_PROP_MASK (0x0ff00000) #define MPP_FRAME_FMT_COLOR_MASK (0x000f0000) #define MPP_FRAME_FMT_YUV (0x00000000) #define MPP_FRAME_FMT_RGB (0x00010000) #define MPP_FRAME_FBC_MASK (0x00f00000) #define MPP_FRAME_FBC_NONE (0x00000000) #define MPP_FRAME_HDR_MASK (0x0c000000) #define MPP_FRAME_HDR_NONE (0x00000000) #define MPP_FRAME_HDR (0x04000000) /* * AFBC_V1 is for ISP output. * It has default payload offset to be calculated * from width and height: * Payload offset = MPP_ALIGN(MPP_ALIGN(width, 16) * MPP_ALIGN(height, 16) / 16, SZ_4K) */ #define MPP_FRAME_FBC_AFBC_V1 (0x00100000) /* * AFBC_V2 is for video decoder output. * It stores payload offset in first 32-bit in header address * Payload offset is always set to zero. */ #define MPP_FRAME_FBC_AFBC_V2 (0x00200000) #define MPP_FRAME_FMT_LE_MASK (0x01000000) #define MPP_FRAME_FMT_IS_YUV(fmt) (((fmt & MPP_FRAME_FMT_COLOR_MASK) == MPP_FRAME_FMT_YUV) && \ ((fmt & MPP_FRAME_FMT_MASK) < MPP_FMT_YUV_BUTT)) #define MPP_FRAME_FMT_IS_YUV_10BIT(fmt) ((fmt & MPP_FRAME_FMT_MASK) == MPP_FMT_YUV420SP_10BIT || \ (fmt & MPP_FRAME_FMT_MASK) == MPP_FMT_YUV422SP_10BIT) #define MPP_FRAME_FMT_IS_RGB(fmt) (((fmt & MPP_FRAME_FMT_COLOR_MASK) == MPP_FRAME_FMT_RGB) && \ ((fmt & MPP_FRAME_FMT_MASK) < MPP_FMT_RGB_BUTT)) /* * For MPP_FRAME_FBC_AFBC_V1 the 16byte aligned stride is used. */ #define MPP_FRAME_FMT_IS_FBC(fmt) (fmt & MPP_FRAME_FBC_MASK) #define MPP_FRAME_FMT_IS_HDR(fmt) (fmt & MPP_FRAME_HDR_MASK) #define MPP_FRAME_FMT_IS_LE(fmt) ((fmt & MPP_FRAME_FMT_LE_MASK) == MPP_FRAME_FMT_LE_MASK) #define MPP_FRAME_FMT_IS_BE(fmt) ((fmt & MPP_FRAME_FMT_LE_MASK) == 0) /* mpp color format index definition */ typedef enum { MPP_FMT_YUV420SP = (MPP_FRAME_FMT_YUV + 0), /* YYYY... UV... (NV12) */ /* * A rockchip specific pixel format, without gap between pixel aganist * the P010_10LE/P010_10BE */ MPP_FMT_YUV420SP_10BIT = (MPP_FRAME_FMT_YUV + 1), MPP_FMT_YUV422SP = (MPP_FRAME_FMT_YUV + 2), /* YYYY... UVUV... (NV16) */ MPP_FMT_YUV422SP_10BIT = (MPP_FRAME_FMT_YUV + 3), ///< Not part of ABI MPP_FMT_YUV420P = (MPP_FRAME_FMT_YUV + 4), /* YYYY... U...V... (I420) */ MPP_FMT_YUV420SP_VU = (MPP_FRAME_FMT_YUV + 5), /* YYYY... VUVUVU... (NV21) */ MPP_FMT_YUV422P = (MPP_FRAME_FMT_YUV + 6), /* YYYY... UU...VV...(422P) */ MPP_FMT_YUV422SP_VU = (MPP_FRAME_FMT_YUV + 7), /* YYYY... VUVUVU... (NV61) */ MPP_FMT_YUV422_YUYV = (MPP_FRAME_FMT_YUV + 8), /* YUYVYUYV... (YUY2) */ MPP_FMT_YUV422_YVYU = (MPP_FRAME_FMT_YUV + 9), /* YVYUYVYU... (YVY2) */ MPP_FMT_YUV422_UYVY = (MPP_FRAME_FMT_YUV + 10), /* UYVYUYVY... (UYVY) */ MPP_FMT_YUV422_VYUY = (MPP_FRAME_FMT_YUV + 11), /* VYUYVYUY... (VYUY) */ MPP_FMT_YUV400 = (MPP_FRAME_FMT_YUV + 12), /* YYYY... */ MPP_FMT_YUV440SP = (MPP_FRAME_FMT_YUV + 13), /* YYYY... UVUV... */ MPP_FMT_YUV411SP = (MPP_FRAME_FMT_YUV + 14), /* YYYY... UV... */ MPP_FMT_YUV444SP = (MPP_FRAME_FMT_YUV + 15), /* YYYY... UVUVUVUV... */ MPP_FMT_YUV444P = (MPP_FRAME_FMT_YUV + 16), /* YYYY... UUUU... VVVV... */ MPP_FMT_YUV_BUTT, MPP_FMT_RGB565 = (MPP_FRAME_FMT_RGB + 0), /* 16-bit RGB */ MPP_FMT_BGR565 = (MPP_FRAME_FMT_RGB + 1), /* 16-bit RGB */ MPP_FMT_RGB555 = (MPP_FRAME_FMT_RGB + 2), /* 15-bit RGB */ MPP_FMT_BGR555 = (MPP_FRAME_FMT_RGB + 3), /* 15-bit RGB */ MPP_FMT_RGB444 = (MPP_FRAME_FMT_RGB + 4), /* 12-bit RGB */ MPP_FMT_BGR444 = (MPP_FRAME_FMT_RGB + 5), /* 12-bit RGB */ MPP_FMT_RGB888 = (MPP_FRAME_FMT_RGB + 6), /* 24-bit RGB */ MPP_FMT_BGR888 = (MPP_FRAME_FMT_RGB + 7), /* 24-bit RGB */ MPP_FMT_RGB101010 = (MPP_FRAME_FMT_RGB + 8), /* 30-bit RGB */ MPP_FMT_BGR101010 = (MPP_FRAME_FMT_RGB + 9), /* 30-bit RGB */ MPP_FMT_ARGB8888 = (MPP_FRAME_FMT_RGB + 10), /* 32-bit RGB */ MPP_FMT_ABGR8888 = (MPP_FRAME_FMT_RGB + 11), /* 32-bit RGB */ MPP_FMT_BGRA8888 = (MPP_FRAME_FMT_RGB + 12), /* 32-bit RGB */ MPP_FMT_RGBA8888 = (MPP_FRAME_FMT_RGB + 13), /* 32-bit RGB */ MPP_FMT_RGB_BUTT, MPP_FMT_BUTT, } MppFrameFormat; /** * Rational number (pair of numerator and denominator). */ typedef struct MppFrameRational { RK_S32 num; ///< Numerator RK_S32 den; ///< Denominator } MppFrameRational; typedef struct MppFrameMasteringDisplayMetadata { RK_U16 display_primaries[3][2]; RK_U16 white_point[2]; RK_U32 max_luminance; RK_U32 min_luminance; } MppFrameMasteringDisplayMetadata; typedef struct MppFrameContentLightMetadata { RK_U16 MaxCLL; RK_U16 MaxFALL; } MppFrameContentLightMetadata; typedef struct MppFrameHdrDynamicMeta { RK_U32 hdr_fmt; RK_U32 size; RK_U8 data[]; } MppFrameHdrDynamicMeta; typedef enum MppFrameError { /* General error not specified */ MPP_FRAME_ERR_UNKNOW = 0x0001, /* Critical error for decoder not support error */ MPP_FRAME_ERR_UNSUPPORT = 0x0002, /* * Fatal error for decoder can not parse a valid frame for hardware. * the pixel data is all invalid. */ MPP_FRAME_ERR_DEC_INVALID = 0x0010, /* * Normal error for decoder found hardware error on decoding. */ MPP_FRAME_ERR_DEC_HW_ERR = 0x0100, /* * Normal error for decoder found missing reference frame on decoding. */ MPP_FRAME_ERR_DEC_MISS_REF = 0x0200, } MppFrameError; #ifdef __cplusplus extern "C" { #endif /* * MppFrame interface */ MPP_RET mpp_frame_init(MppFrame *frame); MPP_RET mpp_frame_deinit(MppFrame *frame); /* * normal parameter * * offset_x * <--------> * * <---------------+ hor_stride +---------------> * * +------------------------------------------------------+ ^ ^ * | | | | * | | | | offset_y * | | | | * | +--------------------------------+ ^ | | v * | | | | | | * | | | + | + * | | | | * | | valid data area | height | ver_stride * | | | | * | | | + | + * | | | | | | * | +--------------------------------+ v | | * | | | * | <----------+ width +---------> | | * | | | * +------------------------------------------------------+ v * */ RK_U32 mpp_frame_get_width(const MppFrame frame); void mpp_frame_set_width(MppFrame frame, RK_U32 width); RK_U32 mpp_frame_get_height(const MppFrame frame); void mpp_frame_set_height(MppFrame frame, RK_U32 height); RK_U32 mpp_frame_get_hor_stride(const MppFrame frame); void mpp_frame_set_hor_stride(MppFrame frame, RK_U32 hor_stride); RK_U32 mpp_frame_get_ver_stride(const MppFrame frame); void mpp_frame_set_ver_stride(MppFrame frame, RK_U32 ver_stride); void mpp_frame_set_hor_stride_pixel(MppFrame frame, RK_U32 hor_stride_pixel); RK_U32 mpp_frame_get_hor_stride_pixel(const MppFrame frame); void mpp_frame_set_fbc_hdr_stride(MppFrame frame, RK_U32 fbc_hdr_stride); RK_U32 mpp_frame_get_fbc_hdr_stride(const MppFrame frame); RK_U32 mpp_frame_get_offset_x(const MppFrame frame); void mpp_frame_set_offset_x(MppFrame frame, RK_U32 offset_x); RK_U32 mpp_frame_get_offset_y(const MppFrame frame); void mpp_frame_set_offset_y(MppFrame frame, RK_U32 offset_y); RK_U32 mpp_frame_get_mode(const MppFrame frame); void mpp_frame_set_mode(MppFrame frame, RK_U32 mode); RK_U32 mpp_frame_get_discard(const MppFrame frame); void mpp_frame_set_discard(MppFrame frame, RK_U32 discard); RK_U32 mpp_frame_get_viewid(const MppFrame frame); void mpp_frame_set_viewid(MppFrame frame, RK_U32 viewid); RK_U32 mpp_frame_get_poc(const MppFrame frame); void mpp_frame_set_poc(MppFrame frame, RK_U32 poc); RK_S64 mpp_frame_get_pts(const MppFrame frame); void mpp_frame_set_pts(MppFrame frame, RK_S64 pts); RK_S64 mpp_frame_get_dts(const MppFrame frame); void mpp_frame_set_dts(MppFrame frame, RK_S64 dts); RK_U32 mpp_frame_get_errinfo(const MppFrame frame); void mpp_frame_set_errinfo(MppFrame frame, RK_U32 errinfo); size_t mpp_frame_get_buf_size(const MppFrame frame); void mpp_frame_set_buf_size(MppFrame frame, size_t buf_size); void mpp_frame_set_thumbnail_en(MppFrame frame, RK_U32 thumbnail_en); RK_U32 mpp_frame_get_thumbnail_en(const MppFrame frame); /* * flow control parmeter */ RK_U32 mpp_frame_get_eos(const MppFrame frame); void mpp_frame_set_eos(MppFrame frame, RK_U32 eos); RK_U32 mpp_frame_get_info_change(const MppFrame frame); void mpp_frame_set_info_change(MppFrame frame, RK_U32 info_change); /* * buffer parameter */ MppBuffer mpp_frame_get_buffer(const MppFrame frame); void mpp_frame_set_buffer(MppFrame frame, MppBuffer buffer); /* * meta data parameter */ RK_S32 mpp_frame_has_meta(const MppFrame frame); MppMeta mpp_frame_get_meta(const MppFrame frame); void mpp_frame_set_meta(MppFrame frame, MppMeta meta); /* * color related parameter */ MppFrameColorRange mpp_frame_get_color_range(const MppFrame frame); void mpp_frame_set_color_range(MppFrame frame, MppFrameColorRange color_range); MppFrameColorPrimaries mpp_frame_get_color_primaries(const MppFrame frame); void mpp_frame_set_color_primaries(MppFrame frame, MppFrameColorPrimaries color_primaries); MppFrameColorTransferCharacteristic mpp_frame_get_color_trc(const MppFrame frame); void mpp_frame_set_color_trc(MppFrame frame, MppFrameColorTransferCharacteristic color_trc); MppFrameColorSpace mpp_frame_get_colorspace(const MppFrame frame); void mpp_frame_set_colorspace(MppFrame frame, MppFrameColorSpace colorspace); MppFrameChromaLocation mpp_frame_get_chroma_location(const MppFrame frame); void mpp_frame_set_chroma_location(MppFrame frame, MppFrameChromaLocation chroma_location); MppFrameFormat mpp_frame_get_fmt(MppFrame frame); void mpp_frame_set_fmt(MppFrame frame, MppFrameFormat fmt); MppFrameRational mpp_frame_get_sar(const MppFrame frame); void mpp_frame_set_sar(MppFrame frame, MppFrameRational sar); MppFrameMasteringDisplayMetadata mpp_frame_get_mastering_display(const MppFrame frame); void mpp_frame_set_mastering_display(MppFrame frame, MppFrameMasteringDisplayMetadata mastering_display); MppFrameContentLightMetadata mpp_frame_get_content_light(const MppFrame frame); void mpp_frame_set_content_light(MppFrame frame, MppFrameContentLightMetadata content_light); MppFrameHdrDynamicMeta* mpp_frame_get_hdr_dynamic_meta(const MppFrame frame); void mpp_frame_set_hdr_dynamic_meta(MppFrame frame, MppFrameHdrDynamicMeta *vivi_data); /* * HDR parameter */ #ifdef __cplusplus } #endif #endif /*__MPP_FRAME_H__*/