README: update for ffmpeg-rockchip

Signed-off-by: nyanmisaka <nst799610810@gmail.com>

README.md

@@ -1,3 +1,95 @@
+ffmpeg-rockchip
+=============
+This project aims to provide full hardware transcoding pipeline in FFmpeg CLI for Rockchip platforms that support MPP ([Media Process Platform](https://github.com/rockchip-linux/mpp)) and RGA ([2D Raster Graphic Acceleration](https://github.com/airockchip/librga)). This includes hardware decoders, encoders and filters. A typical target platform is RK3588/3588s based devices.
+
+## Hightlights
+* MPP decoders support up to 8K 10-bit H.264, HEVC, VP9 and AV1 decoding
+* MPP decoders support producing AFBC (ARM Frame Buffer Compression) image
+* MPP decoders support de-interlace using IEP (Image Enhancement Processor)
+* MPP decoders support allocator half-internal and pure-external modes
+* MPP encoders support up to 8K H.264 and HEVC encoding
+* MPP encoders support async encoding, AKA frame-parallel
+* MPP encoders support consuming AFBC image
+* RGA filters support image scaling and pixel format conversion
+* RGA filters support image cropping
+* RGA filters support image transposing
+* RGA filters support blending two images
+* RGA filters support async operation
+* RGA filters support producing and consuming AFBC image
+* Zero-copy DMA in above stages
+
+## How to use
+The documentation is available on the [Wiki](https://github.com/nyanmisaka/ffmpeg-rockchip/wiki) page of this project.
+
+
+## Codecs and filters
+### Decoders/Hwaccel
+```
+ V..... av1_rkmpp            Rockchip MPP (Media Process Platform) AV1 decoder (codec av1)
+ V..... h263_rkmpp           Rockchip MPP (Media Process Platform) H263 decoder (codec h263)
+ V..... h264_rkmpp           Rockchip MPP (Media Process Platform) H264 decoder (codec h264)
+ V..... hevc_rkmpp           Rockchip MPP (Media Process Platform) HEVC decoder (codec hevc)
+ V..... mpeg1_rkmpp          Rockchip MPP (Media Process Platform) MPEG1VIDEO decoder (codec mpeg1video)
+ V..... mpeg2_rkmpp          Rockchip MPP (Media Process Platform) MPEG2VIDEO decoder (codec mpeg2video)
+ V..... mpeg4_rkmpp          Rockchip MPP (Media Process Platform) MPEG4 decoder (codec mpeg4)
+ V..... vp8_rkmpp            Rockchip MPP (Media Process Platform) VP8 decoder (codec vp8)
+ V..... vp9_rkmpp            Rockchip MPP (Media Process Platform) VP9 decoder (codec vp9)
+```
+
+### Encoders
+```
+ V..... h264_rkmpp           Rockchip MPP (Media Process Platform) H264 encoder (codec h264)
+ V..... hevc_rkmpp           Rockchip MPP (Media Process Platform) HEVC encoder (codec hevc)
+```
+
+### Filters
+```
+ ... overlay_rkrga     VV->V      Rockchip RGA (2D Raster Graphic Acceleration) video compositor
+ ... scale_rkrga       V->V       Rockchip RGA (2D Raster Graphic Acceleration) video resizer and format converter
+ ... vpp_rkrga         V->V       Rockchip RGA (2D Raster Graphic Acceleration) video post-process (scale/crop/transpose)
+```
+
+## Important
+* Rockchip BSP/vendor kernel is necessary, 5.10 and 6.1 are two tested versions.
+* For the supported maximum resolution and FPS you can refer to the datasheet or TRM.
+* User MUST be granted permission to access these device files.
+```
+# DRM allocator
+/dev/dri
+
+# DMA_HEAP allocator
+/dev/dma_heap
+
+# RGA filters
+/dev/rga
+
+# MPP codecs
+/dev/mpp_service
+
+# Optional, for compatibility with older kernels and socs
+/dev/iep
+/dev/mpp-service
+/dev/vpu_service
+/dev/vpu-service
+/dev/hevc_service
+/dev/hevc-service
+/dev/rkvdec
+/dev/rkvenc
+/dev/vepu
+/dev/h265e
+```
+
+## Todo
+* Support MPP MJPEG/JPEG decoder and encoder
+* Support MPP VP8 video encoder
+* ...
+
+## Acknowledgments
+
+@[hbiyik](https://github.com/hbiyik) @[HermanChen](https://github.com/HermanChen) @[rigaya](https://github.com/rigaya)
+
+---
+
 FFmpeg README
 =============