xref: /OK3568_Linux_fs/external/mpp/inc/mpp_frame.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright 2015 Rockchip Electronics Co. LTD
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Licensed under the Apache License, Version 2.0 (the "License");
5*4882a593Smuzhiyun  * you may not use this file except in compliance with the License.
6*4882a593Smuzhiyun  * You may obtain a copy of the License at
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  *      http://www.apache.org/licenses/LICENSE-2.0
9*4882a593Smuzhiyun  *
10*4882a593Smuzhiyun  * Unless required by applicable law or agreed to in writing, software
11*4882a593Smuzhiyun  * distributed under the License is distributed on an "AS IS" BASIS,
12*4882a593Smuzhiyun  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4882a593Smuzhiyun  * See the License for the specific language governing permissions and
14*4882a593Smuzhiyun  * limitations under the License.
15*4882a593Smuzhiyun  */
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #ifndef __MPP_FRAME_H__
18*4882a593Smuzhiyun #define __MPP_FRAME_H__
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #include "mpp_buffer.h"
21*4882a593Smuzhiyun #include "mpp_meta.h"
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun /*
24*4882a593Smuzhiyun  * bit definition for mode flag in MppFrame
25*4882a593Smuzhiyun  */
26*4882a593Smuzhiyun /* progressive frame */
27*4882a593Smuzhiyun #define MPP_FRAME_FLAG_FRAME            (0x00000000)
28*4882a593Smuzhiyun /* top field only */
29*4882a593Smuzhiyun #define MPP_FRAME_FLAG_TOP_FIELD        (0x00000001)
30*4882a593Smuzhiyun /* bottom field only */
31*4882a593Smuzhiyun #define MPP_FRAME_FLAG_BOT_FIELD        (0x00000002)
32*4882a593Smuzhiyun /* paired field */
33*4882a593Smuzhiyun #define MPP_FRAME_FLAG_PAIRED_FIELD     (MPP_FRAME_FLAG_TOP_FIELD|MPP_FRAME_FLAG_BOT_FIELD)
34*4882a593Smuzhiyun /* paired field with field order of top first */
35*4882a593Smuzhiyun #define MPP_FRAME_FLAG_TOP_FIRST        (0x00000004)
36*4882a593Smuzhiyun /* paired field with field order of bottom first */
37*4882a593Smuzhiyun #define MPP_FRAME_FLAG_BOT_FIRST        (0x00000008)
38*4882a593Smuzhiyun /* paired field with unknown field order (MBAFF) */
39*4882a593Smuzhiyun #define MPP_FRAME_FLAG_DEINTERLACED     (MPP_FRAME_FLAG_TOP_FIRST|MPP_FRAME_FLAG_BOT_FIRST)
40*4882a593Smuzhiyun #define MPP_FRAME_FLAG_FIELD_ORDER_MASK (0x0000000C)
41*4882a593Smuzhiyun // for multiview stream
42*4882a593Smuzhiyun #define MPP_FRAME_FLAG_VIEW_ID_MASK     (0x000000f0)
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #define MPP_FRAME_FLAG_IEP_DEI_MASK     (0x00000f00)
45*4882a593Smuzhiyun #define MPP_FRAME_FLAG_IEP_DEI_I2O1     (0x00000100)
46*4882a593Smuzhiyun #define MPP_FRAME_FLAG_IEP_DEI_I4O2     (0x00000200)
47*4882a593Smuzhiyun #define MPP_FRAME_FLAG_IEP_DEI_I4O1     (0x00000300)
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun /*
50*4882a593Smuzhiyun  * MPEG vs JPEG YUV range.
51*4882a593Smuzhiyun  */
52*4882a593Smuzhiyun typedef enum {
53*4882a593Smuzhiyun     MPP_FRAME_RANGE_UNSPECIFIED = 0,
54*4882a593Smuzhiyun     MPP_FRAME_RANGE_MPEG        = 1,    ///< the normal 219*2^(n-8) "MPEG" YUV ranges
55*4882a593Smuzhiyun     MPP_FRAME_RANGE_JPEG        = 2,    ///< the normal     2^n-1   "JPEG" YUV ranges
56*4882a593Smuzhiyun     MPP_FRAME_RANGE_NB,                 ///< Not part of ABI
57*4882a593Smuzhiyun } MppFrameColorRange;
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun typedef enum {
60*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_COMPONEMT   = 0,
61*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_PAL         = 1,
62*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_NTSC        = 2,
63*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_SECAM       = 3,
64*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_MAC         = 4,
65*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_UNSPECIFIED = 5,
66*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_RESERVED0   = 6,
67*4882a593Smuzhiyun     MPP_FRAME_VIDEO_FMT_RESERVED1   = 7,
68*4882a593Smuzhiyun } MppFrameVideoFormat;
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /*
71*4882a593Smuzhiyun  * Chromaticity coordinates of the source primaries.
72*4882a593Smuzhiyun  */
73*4882a593Smuzhiyun typedef enum {
74*4882a593Smuzhiyun     MPP_FRAME_PRI_RESERVED0     = 0,
75*4882a593Smuzhiyun     MPP_FRAME_PRI_BT709         = 1,    ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
76*4882a593Smuzhiyun     MPP_FRAME_PRI_UNSPECIFIED   = 2,
77*4882a593Smuzhiyun     MPP_FRAME_PRI_RESERVED      = 3,
78*4882a593Smuzhiyun     MPP_FRAME_PRI_BT470M        = 4,    ///< also FCC Title 47 Code of Federal Regulations 73.682 (a)(20)
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun     MPP_FRAME_PRI_BT470BG       = 5,    ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
81*4882a593Smuzhiyun     MPP_FRAME_PRI_SMPTE170M     = 6,    ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC/SMPTE ST 170 (2004)
82*4882a593Smuzhiyun     MPP_FRAME_PRI_SMPTE240M     = 7,    ///< functionally identical to above/SMPTE ST 240
83*4882a593Smuzhiyun     MPP_FRAME_PRI_FILM          = 8,    ///< colour filters using Illuminant C
84*4882a593Smuzhiyun     MPP_FRAME_PRI_BT2020        = 9,    ///< ITU-R BT2020 / ITU-R BT.2100-2
85*4882a593Smuzhiyun     MPP_FRAME_PRI_SMPTEST428_1  = 10,   ///< SMPTE ST 428-1 (CIE 1931 XYZ)
86*4882a593Smuzhiyun     MPP_FRAME_PRI_SMPTE431      = 11,   ///< SMPTE ST 431-2 (2011) / DCI P3
87*4882a593Smuzhiyun     MPP_FRAME_PRI_SMPTE432      = 12,   ///< SMPTE ST 432-1 (2010) / P3 D65 / Display P3
88*4882a593Smuzhiyun     MPP_FRAME_PRI_JEDEC_P22     = 22,   ///< JEDEC P22 phosphors
89*4882a593Smuzhiyun     MPP_FRAME_PRI_NB,                   ///< Not part of ABI
90*4882a593Smuzhiyun } MppFrameColorPrimaries;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun /*
93*4882a593Smuzhiyun  * Color Transfer Characteristic.
94*4882a593Smuzhiyun  */
95*4882a593Smuzhiyun typedef enum {
96*4882a593Smuzhiyun     MPP_FRAME_TRC_RESERVED0    = 0,
97*4882a593Smuzhiyun     MPP_FRAME_TRC_BT709        = 1,     ///< also ITU-R BT1361
98*4882a593Smuzhiyun     MPP_FRAME_TRC_UNSPECIFIED  = 2,
99*4882a593Smuzhiyun     MPP_FRAME_TRC_RESERVED     = 3,
100*4882a593Smuzhiyun     MPP_FRAME_TRC_GAMMA22      = 4,     ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
101*4882a593Smuzhiyun     MPP_FRAME_TRC_GAMMA28      = 5,     ///< also ITU-R BT470BG
102*4882a593Smuzhiyun     MPP_FRAME_TRC_SMPTE170M    = 6,     ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
103*4882a593Smuzhiyun     MPP_FRAME_TRC_SMPTE240M    = 7,
104*4882a593Smuzhiyun     MPP_FRAME_TRC_LINEAR       = 8,     ///< "Linear transfer characteristics"
105*4882a593Smuzhiyun     MPP_FRAME_TRC_LOG          = 9,     ///< "Logarithmic transfer characteristic (100:1 range)"
106*4882a593Smuzhiyun     MPP_FRAME_TRC_LOG_SQRT     = 10,    ///< "Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range)"
107*4882a593Smuzhiyun     MPP_FRAME_TRC_IEC61966_2_4 = 11,    ///< IEC 61966-2-4
108*4882a593Smuzhiyun     MPP_FRAME_TRC_BT1361_ECG   = 12,    ///< ITU-R BT1361 Extended Colour Gamut
109*4882a593Smuzhiyun     MPP_FRAME_TRC_IEC61966_2_1 = 13,    ///< IEC 61966-2-1 (sRGB or sYCC)
110*4882a593Smuzhiyun     MPP_FRAME_TRC_BT2020_10    = 14,    ///< ITU-R BT2020 for 10 bit system
111*4882a593Smuzhiyun     MPP_FRAME_TRC_BT2020_12    = 15,    ///< ITU-R BT2020 for 12 bit system
112*4882a593Smuzhiyun     MPP_FRAME_TRC_SMPTEST2084  = 16,    ///< SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems
113*4882a593Smuzhiyun     MPP_FRAME_TRC_SMPTEST428_1 = 17,    ///< SMPTE ST 428-1
114*4882a593Smuzhiyun     MPP_FRAME_TRC_ARIB_STD_B67 = 18,    ///< ARIB STD-B67, known as "Hybrid log-gamma"
115*4882a593Smuzhiyun     MPP_FRAME_TRC_NB,                   ///< Not part of ABI
116*4882a593Smuzhiyun } MppFrameColorTransferCharacteristic;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun /*
119*4882a593Smuzhiyun  * YUV colorspace type.
120*4882a593Smuzhiyun  */
121*4882a593Smuzhiyun typedef enum {
122*4882a593Smuzhiyun     MPP_FRAME_SPC_RGB         = 0,      ///< order of coefficients is actually GBR, also IEC 61966-2-1 (sRGB)
123*4882a593Smuzhiyun     MPP_FRAME_SPC_BT709       = 1,      ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
124*4882a593Smuzhiyun     MPP_FRAME_SPC_UNSPECIFIED = 2,
125*4882a593Smuzhiyun     MPP_FRAME_SPC_RESERVED    = 3,
126*4882a593Smuzhiyun     MPP_FRAME_SPC_FCC         = 4,      ///< FCC Title 47 Code of Federal Regulations 73.682 (a)(20)
127*4882a593Smuzhiyun     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
128*4882a593Smuzhiyun     MPP_FRAME_SPC_SMPTE170M   = 6,      ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
129*4882a593Smuzhiyun     MPP_FRAME_SPC_SMPTE240M   = 7,
130*4882a593Smuzhiyun     MPP_FRAME_SPC_YCOCG       = 8,      ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
131*4882a593Smuzhiyun     MPP_FRAME_SPC_BT2020_NCL  = 9,      ///< ITU-R BT2020 non-constant luminance system
132*4882a593Smuzhiyun     MPP_FRAME_SPC_BT2020_CL   = 10,     ///< ITU-R BT2020 constant luminance system
133*4882a593Smuzhiyun     MPP_FRAME_SPC_SMPTE2085   = 11,     ///< SMPTE 2085, Y'D'zD'x
134*4882a593Smuzhiyun     MPP_FRAME_SPC_CHROMA_DERIVED_NCL = 12,  ///< Chromaticity-derived non-constant luminance system
135*4882a593Smuzhiyun     MPP_FRAME_SPC_CHROMA_DERIVED_CL = 13,   ///< Chromaticity-derived constant luminance system
136*4882a593Smuzhiyun     MPP_FRAME_SPC_ICTCP       = 14,     ///< ITU-R BT.2100-0, ICtCp
137*4882a593Smuzhiyun     MPP_FRAME_SPC_NB,                   ///< Not part of ABI
138*4882a593Smuzhiyun } MppFrameColorSpace;
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun /*
141*4882a593Smuzhiyun  * Location of chroma samples.
142*4882a593Smuzhiyun  *
143*4882a593Smuzhiyun  * Illustration showing the location of the first (top left) chroma sample of the
144*4882a593Smuzhiyun  * image, the left shows only luma, the right
145*4882a593Smuzhiyun  * shows the location of the chroma sample, the 2 could be imagined to overlay
146*4882a593Smuzhiyun  * each other but are drawn separately due to limitations of ASCII
147*4882a593Smuzhiyun  *
148*4882a593Smuzhiyun  *                1st 2nd       1st 2nd horizontal luma sample positions
149*4882a593Smuzhiyun  *                 v   v         v   v
150*4882a593Smuzhiyun  *                 ______        ______
151*4882a593Smuzhiyun  *1st luma line > |X   X ...    |3 4 X ...     X are luma samples,
152*4882a593Smuzhiyun  *                |             |1 2           1-6 are possible chroma positions
153*4882a593Smuzhiyun  *2nd luma line > |X   X ...    |5 6 X ...     0 is undefined/unknown position
154*4882a593Smuzhiyun  */
155*4882a593Smuzhiyun typedef enum {
156*4882a593Smuzhiyun     MPP_CHROMA_LOC_UNSPECIFIED = 0,
157*4882a593Smuzhiyun     MPP_CHROMA_LOC_LEFT        = 1,     ///< mpeg2/4 4:2:0, h264 default for 4:2:0
158*4882a593Smuzhiyun     MPP_CHROMA_LOC_CENTER      = 2,     ///< mpeg1 4:2:0, jpeg 4:2:0, h263 4:2:0
159*4882a593Smuzhiyun     MPP_CHROMA_LOC_TOPLEFT     = 3,     ///< ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2
160*4882a593Smuzhiyun     MPP_CHROMA_LOC_TOP         = 4,
161*4882a593Smuzhiyun     MPP_CHROMA_LOC_BOTTOMLEFT  = 5,
162*4882a593Smuzhiyun     MPP_CHROMA_LOC_BOTTOM      = 6,
163*4882a593Smuzhiyun     MPP_CHROMA_LOC_NB,                  ///< Not part of ABI
164*4882a593Smuzhiyun } MppFrameChromaLocation;
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun #define MPP_FRAME_FMT_MASK          (0x000fffff)
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun #define MPP_FRAME_FMT_COLOR_MASK    (0x000f0000)
169*4882a593Smuzhiyun #define MPP_FRAME_FMT_YUV           (0x00000000)
170*4882a593Smuzhiyun #define MPP_FRAME_FMT_RGB           (0x00010000)
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun #define MPP_FRAME_FBC_MASK          (0x00f00000)
173*4882a593Smuzhiyun #define MPP_FRAME_FBC_NONE          (0x00000000)
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun #define MPP_FRAME_HDR_MASK          (0x0c000000)
176*4882a593Smuzhiyun #define MPP_FRAME_HDR_NONE          (0x00000000)
177*4882a593Smuzhiyun #define MPP_FRAME_HDR               (0x04000000)
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun /*
180*4882a593Smuzhiyun  * AFBC_V1 is for ISP output.
181*4882a593Smuzhiyun  * It has default payload offset to be calculated * from width and height:
182*4882a593Smuzhiyun  * Payload offset = MPP_ALIGN(MPP_ALIGN(width, 16) * MPP_ALIGN(height, 16) / 16, SZ_4K)
183*4882a593Smuzhiyun  */
184*4882a593Smuzhiyun #define MPP_FRAME_FBC_AFBC_V1       (0x00100000)
185*4882a593Smuzhiyun /*
186*4882a593Smuzhiyun  * AFBC_V2 is for video decoder output.
187*4882a593Smuzhiyun  * It stores payload offset in first 32-bit in header address
188*4882a593Smuzhiyun  * Payload offset is always set to zero.
189*4882a593Smuzhiyun  */
190*4882a593Smuzhiyun #define MPP_FRAME_FBC_AFBC_V2       (0x00200000)
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun #define MPP_FRAME_FMT_LE_MASK       (0x01000000)
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_YUV(fmt)   (((fmt & MPP_FRAME_FMT_COLOR_MASK) == MPP_FRAME_FMT_YUV) && \
195*4882a593Smuzhiyun                                      ((fmt & MPP_FRAME_FMT_MASK) < MPP_FMT_YUV_BUTT))
196*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_YUV_10BIT(fmt) ((fmt & MPP_FRAME_FMT_MASK) == MPP_FMT_YUV420SP_10BIT || \
197*4882a593Smuzhiyun                                         (fmt & MPP_FRAME_FMT_MASK) == MPP_FMT_YUV422SP_10BIT)
198*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_RGB(fmt)   (((fmt & MPP_FRAME_FMT_COLOR_MASK) == MPP_FRAME_FMT_RGB) && \
199*4882a593Smuzhiyun                                      ((fmt & MPP_FRAME_FMT_MASK) < MPP_FMT_RGB_BUTT))
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun /*
202*4882a593Smuzhiyun  * For MPP_FRAME_FBC_AFBC_V1 the 16byte aligned stride is used.
203*4882a593Smuzhiyun  */
204*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_FBC(fmt)   (fmt & MPP_FRAME_FBC_MASK)
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_HDR(fmt)   (fmt & MPP_FRAME_HDR_MASK)
207*4882a593Smuzhiyun 
208*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_LE(fmt)    ((fmt & MPP_FRAME_FMT_LE_MASK) == MPP_FRAME_FMT_LE_MASK)
209*4882a593Smuzhiyun #define MPP_FRAME_FMT_IS_BE(fmt)    ((fmt & MPP_FRAME_FMT_LE_MASK) == 0)
210*4882a593Smuzhiyun 
211*4882a593Smuzhiyun /* mpp color format index definition */
212*4882a593Smuzhiyun typedef enum {
213*4882a593Smuzhiyun     MPP_FMT_YUV420SP        = (MPP_FRAME_FMT_YUV + 0),  /* YYYY... UV... (NV12)     */
214*4882a593Smuzhiyun     /*
215*4882a593Smuzhiyun      * A rockchip specific pixel format, without gap between pixel aganist
216*4882a593Smuzhiyun      * the P010_10LE/P010_10BE
217*4882a593Smuzhiyun      */
218*4882a593Smuzhiyun     MPP_FMT_YUV420SP_10BIT  = (MPP_FRAME_FMT_YUV + 1),
219*4882a593Smuzhiyun     MPP_FMT_YUV422SP        = (MPP_FRAME_FMT_YUV + 2),  /* YYYY... UVUV... (NV16)   */
220*4882a593Smuzhiyun     MPP_FMT_YUV422SP_10BIT  = (MPP_FRAME_FMT_YUV + 3),  ///< Not part of ABI
221*4882a593Smuzhiyun     MPP_FMT_YUV420P         = (MPP_FRAME_FMT_YUV + 4),  /* YYYY... U...V...  (I420) */
222*4882a593Smuzhiyun     MPP_FMT_YUV420SP_VU     = (MPP_FRAME_FMT_YUV + 5),  /* YYYY... VUVUVU... (NV21) */
223*4882a593Smuzhiyun     MPP_FMT_YUV422P         = (MPP_FRAME_FMT_YUV + 6),  /* YYYY... UU...VV...(422P) */
224*4882a593Smuzhiyun     MPP_FMT_YUV422SP_VU     = (MPP_FRAME_FMT_YUV + 7),  /* YYYY... VUVUVU... (NV61) */
225*4882a593Smuzhiyun     MPP_FMT_YUV422_YUYV     = (MPP_FRAME_FMT_YUV + 8),  /* YUYVYUYV... (YUY2)       */
226*4882a593Smuzhiyun     MPP_FMT_YUV422_YVYU     = (MPP_FRAME_FMT_YUV + 9),  /* YVYUYVYU... (YVY2)       */
227*4882a593Smuzhiyun     MPP_FMT_YUV422_UYVY     = (MPP_FRAME_FMT_YUV + 10), /* UYVYUYVY... (UYVY)       */
228*4882a593Smuzhiyun     MPP_FMT_YUV422_VYUY     = (MPP_FRAME_FMT_YUV + 11), /* VYUYVYUY... (VYUY)       */
229*4882a593Smuzhiyun     MPP_FMT_YUV400          = (MPP_FRAME_FMT_YUV + 12), /* YYYY...                  */
230*4882a593Smuzhiyun     MPP_FMT_YUV440SP        = (MPP_FRAME_FMT_YUV + 13), /* YYYY... UVUV...          */
231*4882a593Smuzhiyun     MPP_FMT_YUV411SP        = (MPP_FRAME_FMT_YUV + 14), /* YYYY... UV...            */
232*4882a593Smuzhiyun     MPP_FMT_YUV444SP        = (MPP_FRAME_FMT_YUV + 15), /* YYYY... UVUVUVUV...      */
233*4882a593Smuzhiyun     MPP_FMT_YUV444P         = (MPP_FRAME_FMT_YUV + 16), /* YYYY... UUUU... VVVV...  */
234*4882a593Smuzhiyun     MPP_FMT_YUV_BUTT,
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun     MPP_FMT_RGB565          = (MPP_FRAME_FMT_RGB + 0),  /* 16-bit RGB               */
237*4882a593Smuzhiyun     MPP_FMT_BGR565          = (MPP_FRAME_FMT_RGB + 1),  /* 16-bit RGB               */
238*4882a593Smuzhiyun     MPP_FMT_RGB555          = (MPP_FRAME_FMT_RGB + 2),  /* 15-bit RGB               */
239*4882a593Smuzhiyun     MPP_FMT_BGR555          = (MPP_FRAME_FMT_RGB + 3),  /* 15-bit RGB               */
240*4882a593Smuzhiyun     MPP_FMT_RGB444          = (MPP_FRAME_FMT_RGB + 4),  /* 12-bit RGB               */
241*4882a593Smuzhiyun     MPP_FMT_BGR444          = (MPP_FRAME_FMT_RGB + 5),  /* 12-bit RGB               */
242*4882a593Smuzhiyun     MPP_FMT_RGB888          = (MPP_FRAME_FMT_RGB + 6),  /* 24-bit RGB               */
243*4882a593Smuzhiyun     MPP_FMT_BGR888          = (MPP_FRAME_FMT_RGB + 7),  /* 24-bit RGB               */
244*4882a593Smuzhiyun     MPP_FMT_RGB101010       = (MPP_FRAME_FMT_RGB + 8),  /* 30-bit RGB               */
245*4882a593Smuzhiyun     MPP_FMT_BGR101010       = (MPP_FRAME_FMT_RGB + 9),  /* 30-bit RGB               */
246*4882a593Smuzhiyun     MPP_FMT_ARGB8888        = (MPP_FRAME_FMT_RGB + 10), /* 32-bit RGB               */
247*4882a593Smuzhiyun     MPP_FMT_ABGR8888        = (MPP_FRAME_FMT_RGB + 11), /* 32-bit RGB               */
248*4882a593Smuzhiyun     MPP_FMT_BGRA8888        = (MPP_FRAME_FMT_RGB + 12), /* 32-bit RGB               */
249*4882a593Smuzhiyun     MPP_FMT_RGBA8888        = (MPP_FRAME_FMT_RGB + 13), /* 32-bit RGB               */
250*4882a593Smuzhiyun     MPP_FMT_RGB_BUTT,
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun     MPP_FMT_BUTT,
253*4882a593Smuzhiyun } MppFrameFormat;
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun /**
256*4882a593Smuzhiyun  * Rational number (pair of numerator and denominator).
257*4882a593Smuzhiyun  */
258*4882a593Smuzhiyun typedef struct MppFrameRational {
259*4882a593Smuzhiyun     RK_S32 num; ///< Numerator
260*4882a593Smuzhiyun     RK_S32 den; ///< Denominator
261*4882a593Smuzhiyun } MppFrameRational;
262*4882a593Smuzhiyun 
263*4882a593Smuzhiyun typedef struct MppFrameMasteringDisplayMetadata {
264*4882a593Smuzhiyun     RK_U16 display_primaries[3][2];
265*4882a593Smuzhiyun     RK_U16 white_point[2];
266*4882a593Smuzhiyun     RK_U32 max_luminance;
267*4882a593Smuzhiyun     RK_U32 min_luminance;
268*4882a593Smuzhiyun } MppFrameMasteringDisplayMetadata;
269*4882a593Smuzhiyun 
270*4882a593Smuzhiyun typedef struct MppFrameContentLightMetadata {
271*4882a593Smuzhiyun     RK_U16 MaxCLL;
272*4882a593Smuzhiyun     RK_U16 MaxFALL;
273*4882a593Smuzhiyun } MppFrameContentLightMetadata;
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun typedef struct MppFrameHdrDynamicMeta {
276*4882a593Smuzhiyun     RK_U32 hdr_fmt;
277*4882a593Smuzhiyun     RK_U32 size;
278*4882a593Smuzhiyun     RK_U8 data[];
279*4882a593Smuzhiyun } MppFrameHdrDynamicMeta;
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun typedef enum MppFrameError {
282*4882a593Smuzhiyun     /* General error not specified */
283*4882a593Smuzhiyun     MPP_FRAME_ERR_UNKNOW           = 0x0001,
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun     /* Critical error for decoder not support error */
286*4882a593Smuzhiyun     MPP_FRAME_ERR_UNSUPPORT        = 0x0002,
287*4882a593Smuzhiyun 
288*4882a593Smuzhiyun     /*
289*4882a593Smuzhiyun      * Fatal error for decoder can not parse a valid frame for hardware.
290*4882a593Smuzhiyun      * the pixel data is all invalid.
291*4882a593Smuzhiyun      */
292*4882a593Smuzhiyun     MPP_FRAME_ERR_DEC_INVALID      = 0x0010,
293*4882a593Smuzhiyun 
294*4882a593Smuzhiyun     /*
295*4882a593Smuzhiyun      * Normal error for decoder found hardware error on decoding.
296*4882a593Smuzhiyun      */
297*4882a593Smuzhiyun     MPP_FRAME_ERR_DEC_HW_ERR       = 0x0100,
298*4882a593Smuzhiyun 
299*4882a593Smuzhiyun     /*
300*4882a593Smuzhiyun      * Normal error for decoder found missing reference frame on decoding.
301*4882a593Smuzhiyun      */
302*4882a593Smuzhiyun     MPP_FRAME_ERR_DEC_MISS_REF     = 0x0200,
303*4882a593Smuzhiyun } MppFrameError;
304*4882a593Smuzhiyun 
305*4882a593Smuzhiyun #ifdef __cplusplus
306*4882a593Smuzhiyun extern "C" {
307*4882a593Smuzhiyun #endif
308*4882a593Smuzhiyun 
309*4882a593Smuzhiyun /*
310*4882a593Smuzhiyun  * MppFrame interface
311*4882a593Smuzhiyun  */
312*4882a593Smuzhiyun MPP_RET mpp_frame_init(MppFrame *frame);
313*4882a593Smuzhiyun MPP_RET mpp_frame_deinit(MppFrame *frame);
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun /*
316*4882a593Smuzhiyun  * normal parameter
317*4882a593Smuzhiyun  *
318*4882a593Smuzhiyun  *    offset_x
319*4882a593Smuzhiyun  *   <-------->
320*4882a593Smuzhiyun  *
321*4882a593Smuzhiyun  *   <---------------+      hor_stride      +--------------->
322*4882a593Smuzhiyun  *
323*4882a593Smuzhiyun  *   +------------------------------------------------------+   ^   ^
324*4882a593Smuzhiyun  *   |                                                      |   |   |
325*4882a593Smuzhiyun  *   |                                                      |   |   | offset_y
326*4882a593Smuzhiyun  *   |                                                      |   |   |
327*4882a593Smuzhiyun  *   |        +--------------------------------+  ^         |   |   v
328*4882a593Smuzhiyun  *   |        |                                |  |         |   |
329*4882a593Smuzhiyun  *   |        |                                |  +         |   +
330*4882a593Smuzhiyun  *   |        |                                |            |
331*4882a593Smuzhiyun  *   |        |        valid data area         | height     | ver_stride
332*4882a593Smuzhiyun  *   |        |                                |            |
333*4882a593Smuzhiyun  *   |        |                                |  +         |   +
334*4882a593Smuzhiyun  *   |        |                                |  |         |   |
335*4882a593Smuzhiyun  *   |        +--------------------------------+  v         |   |
336*4882a593Smuzhiyun  *   |                                                      |   |
337*4882a593Smuzhiyun  *   |        <----------+   width   +--------->            |   |
338*4882a593Smuzhiyun  *   |                                                      |   |
339*4882a593Smuzhiyun  *   +------------------------------------------------------+   v
340*4882a593Smuzhiyun  *
341*4882a593Smuzhiyun  */
342*4882a593Smuzhiyun RK_U32  mpp_frame_get_width(const MppFrame frame);
343*4882a593Smuzhiyun void    mpp_frame_set_width(MppFrame frame, RK_U32 width);
344*4882a593Smuzhiyun RK_U32  mpp_frame_get_height(const MppFrame frame);
345*4882a593Smuzhiyun void    mpp_frame_set_height(MppFrame frame, RK_U32 height);
346*4882a593Smuzhiyun RK_U32  mpp_frame_get_hor_stride(const MppFrame frame);
347*4882a593Smuzhiyun void    mpp_frame_set_hor_stride(MppFrame frame, RK_U32 hor_stride);
348*4882a593Smuzhiyun RK_U32  mpp_frame_get_ver_stride(const MppFrame frame);
349*4882a593Smuzhiyun void    mpp_frame_set_ver_stride(MppFrame frame, RK_U32 ver_stride);
350*4882a593Smuzhiyun void    mpp_frame_set_hor_stride_pixel(MppFrame frame, RK_U32 hor_stride_pixel);
351*4882a593Smuzhiyun RK_U32  mpp_frame_get_hor_stride_pixel(const MppFrame frame);
352*4882a593Smuzhiyun void    mpp_frame_set_fbc_hdr_stride(MppFrame frame, RK_U32 fbc_hdr_stride);
353*4882a593Smuzhiyun RK_U32  mpp_frame_get_fbc_hdr_stride(const MppFrame frame);
354*4882a593Smuzhiyun 
355*4882a593Smuzhiyun RK_U32  mpp_frame_get_offset_x(const MppFrame frame);
356*4882a593Smuzhiyun void    mpp_frame_set_offset_x(MppFrame frame, RK_U32 offset_x);
357*4882a593Smuzhiyun RK_U32  mpp_frame_get_offset_y(const MppFrame frame);
358*4882a593Smuzhiyun void    mpp_frame_set_offset_y(MppFrame frame, RK_U32 offset_y);
359*4882a593Smuzhiyun RK_U32  mpp_frame_get_mode(const MppFrame frame);
360*4882a593Smuzhiyun void    mpp_frame_set_mode(MppFrame frame, RK_U32 mode);
361*4882a593Smuzhiyun RK_U32  mpp_frame_get_discard(const MppFrame frame);
362*4882a593Smuzhiyun void    mpp_frame_set_discard(MppFrame frame, RK_U32 discard);
363*4882a593Smuzhiyun RK_U32  mpp_frame_get_viewid(const MppFrame frame);
364*4882a593Smuzhiyun void    mpp_frame_set_viewid(MppFrame frame, RK_U32 viewid);
365*4882a593Smuzhiyun RK_U32  mpp_frame_get_poc(const MppFrame frame);
366*4882a593Smuzhiyun void    mpp_frame_set_poc(MppFrame frame, RK_U32 poc);
367*4882a593Smuzhiyun RK_S64  mpp_frame_get_pts(const MppFrame frame);
368*4882a593Smuzhiyun void    mpp_frame_set_pts(MppFrame frame, RK_S64 pts);
369*4882a593Smuzhiyun RK_S64  mpp_frame_get_dts(const MppFrame frame);
370*4882a593Smuzhiyun void    mpp_frame_set_dts(MppFrame frame, RK_S64 dts);
371*4882a593Smuzhiyun RK_U32  mpp_frame_get_errinfo(const MppFrame frame);
372*4882a593Smuzhiyun void    mpp_frame_set_errinfo(MppFrame frame, RK_U32 errinfo);
373*4882a593Smuzhiyun size_t  mpp_frame_get_buf_size(const MppFrame frame);
374*4882a593Smuzhiyun void    mpp_frame_set_buf_size(MppFrame frame, size_t buf_size);
375*4882a593Smuzhiyun void    mpp_frame_set_thumbnail_en(MppFrame frame, RK_U32 thumbnail_en);
376*4882a593Smuzhiyun RK_U32  mpp_frame_get_thumbnail_en(const MppFrame frame);
377*4882a593Smuzhiyun 
378*4882a593Smuzhiyun /*
379*4882a593Smuzhiyun  * flow control parmeter
380*4882a593Smuzhiyun  */
381*4882a593Smuzhiyun RK_U32  mpp_frame_get_eos(const MppFrame frame);
382*4882a593Smuzhiyun void    mpp_frame_set_eos(MppFrame frame, RK_U32 eos);
383*4882a593Smuzhiyun RK_U32  mpp_frame_get_info_change(const MppFrame frame);
384*4882a593Smuzhiyun void    mpp_frame_set_info_change(MppFrame frame, RK_U32 info_change);
385*4882a593Smuzhiyun 
386*4882a593Smuzhiyun /*
387*4882a593Smuzhiyun  * buffer parameter
388*4882a593Smuzhiyun  */
389*4882a593Smuzhiyun MppBuffer mpp_frame_get_buffer(const MppFrame frame);
390*4882a593Smuzhiyun void    mpp_frame_set_buffer(MppFrame frame, MppBuffer buffer);
391*4882a593Smuzhiyun 
392*4882a593Smuzhiyun /*
393*4882a593Smuzhiyun  * meta data parameter
394*4882a593Smuzhiyun  */
395*4882a593Smuzhiyun RK_S32  mpp_frame_has_meta(const MppFrame frame);
396*4882a593Smuzhiyun MppMeta mpp_frame_get_meta(const MppFrame frame);
397*4882a593Smuzhiyun void    mpp_frame_set_meta(MppFrame frame, MppMeta meta);
398*4882a593Smuzhiyun 
399*4882a593Smuzhiyun /*
400*4882a593Smuzhiyun  * color related parameter
401*4882a593Smuzhiyun  */
402*4882a593Smuzhiyun MppFrameColorRange mpp_frame_get_color_range(const MppFrame frame);
403*4882a593Smuzhiyun void    mpp_frame_set_color_range(MppFrame frame, MppFrameColorRange color_range);
404*4882a593Smuzhiyun MppFrameColorPrimaries mpp_frame_get_color_primaries(const MppFrame frame);
405*4882a593Smuzhiyun void    mpp_frame_set_color_primaries(MppFrame frame, MppFrameColorPrimaries color_primaries);
406*4882a593Smuzhiyun MppFrameColorTransferCharacteristic mpp_frame_get_color_trc(const MppFrame frame);
407*4882a593Smuzhiyun void    mpp_frame_set_color_trc(MppFrame frame, MppFrameColorTransferCharacteristic color_trc);
408*4882a593Smuzhiyun MppFrameColorSpace mpp_frame_get_colorspace(const MppFrame frame);
409*4882a593Smuzhiyun void    mpp_frame_set_colorspace(MppFrame frame, MppFrameColorSpace colorspace);
410*4882a593Smuzhiyun MppFrameChromaLocation mpp_frame_get_chroma_location(const MppFrame frame);
411*4882a593Smuzhiyun void    mpp_frame_set_chroma_location(MppFrame frame, MppFrameChromaLocation chroma_location);
412*4882a593Smuzhiyun MppFrameFormat mpp_frame_get_fmt(MppFrame frame);
413*4882a593Smuzhiyun void    mpp_frame_set_fmt(MppFrame frame, MppFrameFormat fmt);
414*4882a593Smuzhiyun MppFrameRational mpp_frame_get_sar(const MppFrame frame);
415*4882a593Smuzhiyun void    mpp_frame_set_sar(MppFrame frame, MppFrameRational sar);
416*4882a593Smuzhiyun MppFrameMasteringDisplayMetadata mpp_frame_get_mastering_display(const MppFrame frame);
417*4882a593Smuzhiyun void    mpp_frame_set_mastering_display(MppFrame frame, MppFrameMasteringDisplayMetadata mastering_display);
418*4882a593Smuzhiyun MppFrameContentLightMetadata mpp_frame_get_content_light(const MppFrame frame);
419*4882a593Smuzhiyun void    mpp_frame_set_content_light(MppFrame frame, MppFrameContentLightMetadata content_light);
420*4882a593Smuzhiyun MppFrameHdrDynamicMeta* mpp_frame_get_hdr_dynamic_meta(const MppFrame frame);
421*4882a593Smuzhiyun void    mpp_frame_set_hdr_dynamic_meta(MppFrame frame, MppFrameHdrDynamicMeta *vivi_data);
422*4882a593Smuzhiyun 
423*4882a593Smuzhiyun /*
424*4882a593Smuzhiyun  * HDR parameter
425*4882a593Smuzhiyun  */
426*4882a593Smuzhiyun 
427*4882a593Smuzhiyun #ifdef __cplusplus
428*4882a593Smuzhiyun }
429*4882a593Smuzhiyun #endif
430*4882a593Smuzhiyun 
431*4882a593Smuzhiyun #endif /*__MPP_FRAME_H__*/
432