1/*
2 * Copyright (c) 2021 Rockchip Electronics Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16#ifndef __VPU_API_H__
17#define __VPU_API_H__
18
19#include "rk_type.h"
20
21/**
22 * @brief rockchip media process interface
23 */
24
25#define VPU_API_NOPTS_VALUE (0x8000000000000000LL)
26
27/*
28 * bit definition of ColorType in structure VPU_FRAME
29 */
30#define VPU_OUTPUT_FORMAT_TYPE_MASK (0x0000ffff)
31#define VPU_OUTPUT_FORMAT_ARGB8888 (0x00000000)
32#define VPU_OUTPUT_FORMAT_ABGR8888 (0x00000001)
33#define VPU_OUTPUT_FORMAT_RGB888 (0x00000002)
34#define VPU_OUTPUT_FORMAT_RGB565 (0x00000003)
35#define VPU_OUTPUT_FORMAT_RGB555 (0x00000004)
36#define VPU_OUTPUT_FORMAT_YUV420_SEMIPLANAR (0x00000005)
37#define VPU_OUTPUT_FORMAT_YUV420_PLANAR (0x00000006)
38#define VPU_OUTPUT_FORMAT_YUV422 (0x00000007)
39#define VPU_OUTPUT_FORMAT_YUV444 (0x00000008)
40#define VPU_OUTPUT_FORMAT_YCH420 (0x00000009)
41#define VPU_OUTPUT_FORMAT_BIT_MASK (0x000f0000)
42#define VPU_OUTPUT_FORMAT_BIT_8 (0x00000000)
43#define VPU_OUTPUT_FORMAT_BIT_10 (0x00010000)
44#define VPU_OUTPUT_FORMAT_BIT_12 (0x00020000)
45#define VPU_OUTPUT_FORMAT_BIT_14 (0x00030000)
46#define VPU_OUTPUT_FORMAT_BIT_16 (0x00040000)
47#define VPU_OUTPUT_FORMAT_COLORSPACE_MASK (0x00f00000)
48#define VPU_OUTPUT_FORMAT_COLORSPACE_BT709 (0x00100000)
49#define VPU_OUTPUT_FORMAT_COLORSPACE_BT2020 (0x00200000)
50#define VPU_OUTPUT_FORMAT_DYNCRANGE_MASK (0x0f000000)
51#define VPU_OUTPUT_FORMAT_DYNCRANGE_SDR (0x00000000)
52#define VPU_OUTPUT_FORMAT_DYNCRANGE_HDR10 (0x01000000)
53#define VPU_OUTPUT_FORMAT_DYNCRANGE_HDR_HLG (0x02000000)
54#define VPU_OUTPUT_FORMAT_DYNCRANGE_HDR_DOLBY (0x03000000)
55
56/**
57 * @brief input picture type
58 */
59typedef enum {
60    ENC_INPUT_YUV420_PLANAR = 0,           /**< YYYY... UUUU... VVVV */
61    ENC_INPUT_YUV420_SEMIPLANAR = 1,       /**< YYYY... UVUVUV...    */
62    ENC_INPUT_YUV422_INTERLEAVED_YUYV = 2, /**< YUYVYUYV...          */
63    ENC_INPUT_YUV422_INTERLEAVED_UYVY = 3, /**< UYVYUYVY...          */
64    ENC_INPUT_RGB565 = 4,                  /**< 16-bit RGB           */
65    ENC_INPUT_BGR565 = 5,                  /**< 16-bit RGB           */
66    ENC_INPUT_RGB555 = 6,                  /**< 15-bit RGB           */
67    ENC_INPUT_BGR555 = 7,                  /**< 15-bit RGB           */
68    ENC_INPUT_RGB444 = 8,                  /**< 12-bit RGB           */
69    ENC_INPUT_BGR444 = 9,                  /**< 12-bit RGB           */
70    ENC_INPUT_RGB888 = 10,                 /**< 24-bit RGB           */
71    ENC_INPUT_BGR888 = 11,                 /**< 24-bit RGB           */
72    ENC_INPUT_RGB101010 = 12,              /**< 30-bit RGB           */
73    ENC_INPUT_BGR101010 = 13               /**< 30-bit RGB           */
74} EncInputPictureType;
75
76typedef enum VPU_API_CMD {
77    VPU_API_ENC_SETCFG,
78    VPU_API_ENC_GETCFG,
79    VPU_API_ENC_SETFORMAT,
80    VPU_API_ENC_SETIDRFRAME,
81
82    VPU_API_ENABLE_DEINTERLACE,
83    VPU_API_SET_VPUMEM_CONTEXT,
84    VPU_API_USE_PRESENT_TIME_ORDER,
85    VPU_API_SET_DEFAULT_WIDTH_HEIGH,
86    VPU_API_SET_INFO_CHANGE,
87    VPU_API_USE_FAST_MODE,
88    VPU_API_DEC_GET_STREAM_COUNT,
89    VPU_API_GET_VPUMEM_USED_COUNT,
90    VPU_API_GET_FRAME_INFO,
91    VPU_API_SET_OUTPUT_BLOCK,
92    VPU_API_GET_EOS_STATUS,
93    VPU_API_SET_OUTPUT_MODE,
94
95    VPU_API_DEC_GET_DPB_SIZE = 0X100, // add by zhanghanmeng
96
97    /* get sps/pps header */
98    VPU_API_GET_EXTRA_INFO = 0x200,
99
100    VPU_API_SET_IMMEDIATE_OUT = 0x1000,
101    VPU_API_SET_PARSER_SPLIT_MODE, /* NOTE: should control before init */
102
103    VPU_API_ENC_VEPU22_START = 0x2000,
104    VPU_API_ENC_SET_VEPU22_CFG,
105    VPU_API_ENC_GET_VEPU22_CFG,
106    VPU_API_ENC_SET_VEPU22_CTU_QP,
107    VPU_API_ENC_SET_VEPU22_ROI,
108
109    /* mlvec dynamic configure */
110    VPU_API_ENC_MLVEC_CFG = 0x4000,
111    VPU_API_ENC_SET_MAX_TID,
112    VPU_API_ENC_SET_MARK_LTR,
113    VPU_API_ENC_SET_USE_LTR,
114    VPU_API_ENC_SET_FRAME_QP,
115    VPU_API_ENC_SET_BASE_LAYER_PID,
116} VPU_API_CMD;
117
118typedef struct {
119    unsigned int TimeLow;
120    unsigned int TimeHigh;
121} TIME_STAMP;
122
123typedef struct {
124    unsigned int CodecType;
125    unsigned int ImgWidth;
126    unsigned int ImgHeight;
127    unsigned int ImgHorStride;
128    unsigned int ImgVerStride;
129    unsigned int BufSize;
130} VPU_GENERIC;
131
132typedef struct VPUMem {
133    unsigned int phy_addr;
134    unsigned int *vir_addr;
135    unsigned int size;
136    unsigned int *offset;
137} VPUMemLinear_t;
138
139typedef struct tVPU_FRAME {
140    unsigned int FrameBusAddr[2]; // 0: Y address; 1: UV address;
141    unsigned int FrameWidth;      // buffer horizontal stride
142    unsigned int FrameHeight;     // buffer vertical   stride
143    unsigned int OutputWidth;     // deprecated
144    unsigned int OutputHeight;    // deprecated
145    unsigned int DisplayWidth;    // valid width  for display
146    unsigned int DisplayHeight;   // valid height for display
147    unsigned int CodingType;
148    unsigned int FrameType; // frame; top_field_first; bot_field_first
149    unsigned int ColorType;
150    unsigned int DecodeFrmNum;
151    TIME_STAMP ShowTime;
152    unsigned int ErrorInfo; // error information
153    unsigned int employ_cnt;
154    VPUMemLinear_t vpumem;
155    struct tVPU_FRAME *next_frame;
156    union {
157        struct {
158            unsigned int Res0[2];
159            struct {
160                unsigned int ColorPrimaries : 8;
161                unsigned int ColorTransfer : 8;
162                unsigned int ColorCoeffs : 8;
163                unsigned int ColorRange : 1;
164                unsigned int Res1 : 7;
165            };
166
167            unsigned int Res2;
168        };
169
170        unsigned int Res[4];
171    };
172} VPU_FRAME;
173
174typedef struct VideoPacket {
175    RK_S64 pts; /* with unit of us */
176    RK_S64 dts; /* with unit of us */
177    unsigned char *data;
178    signed int size;
179    unsigned int capability;
180    unsigned int nFlags;
181} VideoPacket_t;
182
183typedef struct DecoderOut {
184    unsigned char *data;
185    unsigned int size;
186    RK_S64 timeUs;
187    signed int nFlags;
188} DecoderOut_t;
189
190typedef struct ParserOut {
191    unsigned char *data;
192    unsigned int size;
193    RK_S64 timeUs;
194    unsigned int nFlags;
195    unsigned int width;
196    unsigned int height;
197} ParserOut_t;
198
199typedef struct EncInputStream {
200    unsigned char *buf;
201    signed int size;
202    unsigned int bufPhyAddr;
203    RK_S64 timeUs;
204    unsigned int nFlags;
205} EncInputStream_t;
206
207typedef struct EncoderOut {
208    unsigned char *data;
209    signed int size;
210    RK_S64 timeUs;
211    signed int keyFrame;
212} EncoderOut_t;
213
214/*
215 * @brief Enumeration used to define the possible video compression codings.
216 * @note  This essentially refers to file extensions. If the coding is
217 *        being used to specify the ENCODE type, then additional work
218 *        must be done to configure the exact flavor of the compression
219 *        to be used.  For decode cases where the user application can
220 *        not differentiate between MPEG-4 and H.264 bit streams, it is
221 *        up to the codec to handle this.
222 *
223 *        sync with the omx_video.h
224 */
225typedef enum OMX_RK_VIDEO_CODINGTYPE {
226    OMX_RK_VIDEO_CodingUnused,           /**< Value when coding is N/A */
227    OMX_RK_VIDEO_CodingAutoDetect,       /**< Autodetection of coding type */
228    OMX_RK_VIDEO_CodingMPEG2,            /**< AKA: H.262 */
229    OMX_RK_VIDEO_CodingH263,             /**< H.263 */
230    OMX_RK_VIDEO_CodingMPEG4,            /**< MPEG-4 */
231    OMX_RK_VIDEO_CodingWMV,              /**< Windows Media Video (WMV1,WMV2,WMV3)*/
232    OMX_RK_VIDEO_CodingRV,               /**< all versions of Real Video */
233    OMX_RK_VIDEO_CodingAVC,              /**< H.264/AVC */
234    OMX_RK_VIDEO_CodingMJPEG,            /**< Motion JPEG */
235    OMX_RK_VIDEO_CodingVP8,              /**< VP8 */
236    OMX_RK_VIDEO_CodingVP9,              /**< VP9 */
237    OMX_RK_VIDEO_CodingVC1 = 0x01000000, /**< Windows Media Video (WMV1,WMV2,WMV3)*/
238    OMX_RK_VIDEO_CodingFLV1,             /**< Sorenson H.263 */
239    OMX_RK_VIDEO_CodingDIVX3,            /**< DIVX3 */
240    OMX_RK_VIDEO_CodingVP6,
241    OMX_RK_VIDEO_CodingHEVC, /**< H.265/HEVC */
242    OMX_RK_VIDEO_CodingAVS,  /**< AVS+ */
243    OMX_RK_VIDEO_CodingKhronosExtensions = 0x6F000000,
244    OMX_RK_VIDEO_CodingVendorStartUnused = 0x7F000000,
245    OMX_RK_VIDEO_CodingMax = 0x7FFFFFFF
246} OMX_RK_VIDEO_CODINGTYPE;
247
248typedef enum CODEC_TYPE {
249    CODEC_NONE,
250    CODEC_DECODER,
251    CODEC_ENCODER,
252    CODEC_BUTT,
253} CODEC_TYPE;
254
255typedef enum VPU_API_ERR {
256    VPU_API_OK = 0,
257    VPU_API_ERR_UNKNOW = -1,
258    VPU_API_ERR_BASE = -1000,
259    VPU_API_ERR_LIST_STREAM = VPU_API_ERR_BASE - 1,
260    VPU_API_ERR_INIT = VPU_API_ERR_BASE - 2,
261    VPU_API_ERR_VPU_CODEC_INIT = VPU_API_ERR_BASE - 3,
262    VPU_API_ERR_STREAM = VPU_API_ERR_BASE - 4,
263    VPU_API_ERR_FATAL_THREAD = VPU_API_ERR_BASE - 5,
264    VPU_API_EOS_STREAM_REACHED = VPU_API_ERR_BASE - 11,
265
266    VPU_API_ERR_BUTT,
267} VPU_API_ERR;
268
269typedef enum VPU_FRAME_ERR {
270    VPU_FRAME_ERR_UNKNOW = 0x0001,
271    VPU_FRAME_ERR_UNSUPPORT = 0x0002,
272} VPU_FRAME_ERR;
273
274typedef struct EncParameter {
275    signed int width;
276    signed int height;
277    signed int rc_mode; /* 0 - CQP mode; 1 - CBR mode; 2 - FIXQP mode */
278    signed int bitRate; /* target bitrate */
279    signed int framerate;
280    signed int qp;
281    signed int enableCabac;
282    signed int cabacInitIdc;
283    signed int format;
284    signed int intraPicRate;
285    signed int framerateout;
286    signed int profileIdc;
287    signed int levelIdc;
288    signed int reserved[3];
289} EncParameter_t;
290
291typedef struct EXtraCfg {
292    signed int vc1extra_size;
293    signed int vp6codeid;
294    signed int tsformat;
295    unsigned int ori_vpu; /* use origin vpu framework */
296    /* below used in decode */
297    unsigned int mpp_mode;   /* use mpp framework */
298    unsigned int bit_depth;  /* 8 or 10 bit */
299    unsigned int yuv_format; /* 0:420 1:422 2:444 */
300    unsigned int reserved[16];
301} EXtraCfg_t;
302
303/**
304 * @brief vpu function interface
305 */
306typedef struct VpuCodecContext {
307    void *vpuApiObj;
308
309    CODEC_TYPE codecType;
310    OMX_RK_VIDEO_CODINGTYPE videoCoding;
311
312    unsigned int width;
313    unsigned int height;
314    void *extradata;
315    signed int extradata_size;
316
317    unsigned char enableparsing;
318
319    signed int no_thread;
320    EXtraCfg_t extra_cfg;
321
322    void *private_data;
323
324    /*
325     ** 1: error state(not working)  0: working
326     */
327    signed int decoder_err;
328
329    /**
330     * Allocate and initialize an VpuCodecContext.
331     *
332     * @param ctx The context of vpu api, allocated in this function.
333     * @param extraData The extra data of codec, some codecs need / can
334     *        use extradata like Huffman tables, also live VC1 codec can
335     *        use extradata to initialize itself.
336     * @param extra_size The size of extra data.
337     *
338     * @return 0 for init success, others for failure.
339     * @note check whether ctx has been allocated success after you do init.
340     */
341    signed int (*init)(struct VpuCodecContext *ctx, unsigned char *extraData, unsigned int extra_size);
342    /**
343     * @brief both send video stream packet to decoder and get video frame from
344     *        decoder at the same time
345     * @param ctx The context of vpu codec
346     * @param pkt[in] Stream to be decoded
347     * @param aDecOut[out] Decoding frame
348     * @return 0 for decode success, others for failure.
349     */
350    signed int (*decode)(struct VpuCodecContext *ctx, VideoPacket_t *pkt, DecoderOut_t *aDecOut);
351    /**
352     * @brief both send video frame to encoder and get encoded video stream from
353     *        encoder at the same time.
354     * @param ctx The context of vpu codec
355     * @param aEncInStrm[in] Frame to be encoded
356     * @param aEncOut[out] Encoding stream
357     * @return 0 for encode success, others for failure.
358     */
359    signed int (*encode)(struct VpuCodecContext *ctx, EncInputStream_t *aEncInStrm, EncoderOut_t *aEncOut);
360    /**
361     * @brief flush codec while do fast forward playing.
362     * @param ctx The context of vpu codec
363     * @return 0 for flush success, others for failure.
364     */
365    signed int (*flush)(struct VpuCodecContext *ctx);
366    signed int (*control)(struct VpuCodecContext *ctx, VPU_API_CMD cmdType, void *param);
367    /**
368     * @brief send video stream packet to decoder only, async interface
369     * @param ctx The context of vpu codec
370     * @param pkt Stream to be decoded
371     * @return 0 for success, others for failure.
372     */
373    signed int (*decode_sendstream)(struct VpuCodecContext *ctx, VideoPacket_t *pkt);
374    /**
375     * @brief get video frame from decoder only, async interface
376     * @param ctx The context of vpu codec
377     * @param aDecOut Decoding frame
378     * @return 0 for success, others for failure.
379     */
380    signed int (*decode_getframe)(struct VpuCodecContext *ctx, DecoderOut_t *aDecOut);
381    /**
382     * @brief send video frame to encoder only, async interface
383     * @param ctx The context of vpu codec
384     * @param aEncInStrm Frame to be encoded
385     * @return 0 for success, others for failure.
386     */
387    signed int (*encoder_sendframe)(struct VpuCodecContext *ctx, EncInputStream_t *aEncInStrm);
388    /**
389     * @brief get encoded video packet from encoder only, async interface
390     * @param ctx The context of vpu codec
391     * @param aEncOut Encoding stream
392     * @return 0 for success, others for failure.
393     */
394    signed int (*encoder_getstream)(struct VpuCodecContext *ctx, EncoderOut_t *aEncOut);
395} VpuCodecContext_t;
396
397/* allocated vpu codec context */
398#ifdef __cplusplus
399extern "C" {
400#endif
401
402/**
403 * @brief open context of vpu
404 * @param ctx pointer of vpu codec context
405 */
406signed int vpu_open_context(struct VpuCodecContext **ctx);
407/**
408 * @brief close context of vpu
409 * @param ctx pointer of vpu codec context
410 */
411signed int vpu_close_context(struct VpuCodecContext **ctx);
412
413#ifdef __cplusplus
414}
415#endif
416
417/*
418 * vpu_mem api
419 */
420#define vpu_display_mem_pool_FIELDS                                                                                    \
421    signed int (*commit_hdl)(vpu_display_mem_pool * p, signed int hdl, signed int size);                               \
422    void *(*get_free)(vpu_display_mem_pool * p);                                                                       \
423    signed int (*inc_used)(vpu_display_mem_pool * p, void *hdl);                                                       \
424    signed int (*put_used)(vpu_display_mem_pool * p, void *hdl);                                                       \
425    signed int (*reset)(vpu_display_mem_pool * p);                                                                     \
426    signed int (*get_unused_num)(vpu_display_mem_pool * p);                                                            \
427    signed int buff_size;                                                                                              \
428    float version;                                                                                                     \
429    signed int res[18]
430
431typedef struct vpu_display_mem_pool vpu_display_mem_pool;
432
433struct vpu_display_mem_pool {
434    vpu_display_mem_pool_FIELDS;
435};
436
437#ifdef __cplusplus
438extern "C" {
439#endif
440
441/*
442 * vpu memory handle interface
443 */
444signed int VPUMemJudgeIommu(void);
445signed int VPUMallocLinear(VPUMemLinear_t *p, unsigned int size);
446signed int VPUFreeLinear(VPUMemLinear_t *p);
447signed int VPUMemDuplicate(VPUMemLinear_t *dst, VPUMemLinear_t *src);
448signed int VPUMemLink(VPUMemLinear_t *p);
449signed int VPUMemFlush(VPUMemLinear_t *p);
450signed int VPUMemClean(VPUMemLinear_t *p);
451signed int VPUMemInvalidate(VPUMemLinear_t *p);
452signed int VPUMemGetFD(VPUMemLinear_t *p);
453signed int VPUMallocLinearFromRender(VPUMemLinear_t *p, unsigned int size, void *ctx);
454
455/*
456 * vpu memory allocator and manager interface
457 */
458vpu_display_mem_pool *open_vpu_memory_pool(void);
459void close_vpu_memory_pool(vpu_display_mem_pool *p);
460int create_vpu_memory_pool_allocator(vpu_display_mem_pool **ipool, int num, int size);
461void release_vpu_memory_pool_allocator(vpu_display_mem_pool *ipool);
462
463#ifdef __cplusplus
464}
465#endif
466
467#endif
468