README.md
1# README
2
3## 前言
4
5**概述**
6
7Rockchip多媒体处理平台(rockit)对外应用接口说明。
8
9---
10
11## 目录
12
13[TOC]
14
15---
16## Rockit对外接口说明
17Rockit对外提供TGI(TaskGraph Interface)和MPI(Media Process Interface)两套接口，用于应用程序开发，两套接口可单独使用，也可结合使用。
18
19### TGI
20- 基于TGI接口可以通过配置文件方式构建应用Pipeline，详见tgi/doc/目录文档说明。
21- 适用于UVC、UAC等较为固定Pipeline应用场景。
22- 已应用于RV1109/1126 RK356X UVC、UAC类产品。
23
24### MPI
25
26- MPI接口是模块化接口，包括VI/VO/VDEC/VENC/VPSS/VGS/TDE/SYS/MB/AI/AO/ADEC/AENC等模块，详见mpi/doc/目录文档说明。
27- MPI支持单模块使用，也支持多模块组合使用，可采用模块间绑定或者手动取/送流方式，灵活构建应用Pipeline。
28
29- 已应用于RV1109/1126 IPC、RK356X NVR类产品，并在后续RK3588等新芯片上持续支持。
30
31## Rockit对外接口特点
32
33| | TGI | MPI |
34| -------- | ---------------------- | -------------------- |
35| 灵活性 | Pipeline构建后较为固定 | 灵活，模块可灵活拼接 |
36| 使用场景 | UVC、UAC | NVR、IPC |
37
38## Rockit接口编译配置
39
40SDK默认仅开启TGI接口头文件、动态库安装，可根据产品应用需求，通过修改external/rockit目录下CMakeLists.txt，将USE_ROCKIT_MPI置为ON，打开MPI接口编译安装。
41
42```c
43option(USE_ROCKIT_TGI "enable rockit tgi" ON)
44if (${USE_ROCKIT_TGI})
45 message("Build rockit tgi")
46 add_subdirectory(tgi)
47endif()
48
49option(USE_ROCKIT_MPI "enable rockit mpi" OFF)
50if (${USE_ROCKIT_MPI})
51 message("Build rockit mpi")
52 add_subdirectory(mpi)
53endif()
54```
55
56