From e31f34a7499e29f2eed2bd010b40e4b5542fc24e Mon Sep 17 00:00:00 2001
From: "sliver.chen" <sliver.chen@rock-chips.com>
Date: Thu, 7 Sep 2017 17:43:27 +0800
Subject: [PATCH] [test]: add README.md for mpi unit test

Change-Id: Ia540cd26cf33f3205cbf3629b3fc2ac3a080cc7d
Signed-off-by: sliver.chen <sliver.chen@rock-chips.com>
---
 mpp/hal/rkenc/h264e/hal_h264e_rkv.c |  4 ++--
 test/README.md                      | 29 +++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 test/README.md

diff --git a/mpp/hal/rkenc/h264e/hal_h264e_rkv.c b/mpp/hal/rkenc/h264e/hal_h264e_rkv.c
index 400e2518..841bab90 100644
--- a/mpp/hal/rkenc/h264e/hal_h264e_rkv.c
+++ b/mpp/hal/rkenc/h264e/hal_h264e_rkv.c
@@ -2225,7 +2225,7 @@ h264e_rkv_update_hw_cfg(H264eHalContext *ctx, HalEncTask *task,
                   ctx->inter_qs, hw_cfg->qp);
 
     /* limit QP by qp_step */
-    if(ctx->frame_cnt > 1){
+    if (ctx->frame_cnt > 1) {
         hw_cfg->qp_min = mpp_clip(hw_cfg->qp_min,
                                   hw_cfg->qp_prev - codec->qp_max_step,
                                   hw_cfg->qp_prev - codec->qp_max_step / 2);
@@ -2235,7 +2235,7 @@ h264e_rkv_update_hw_cfg(H264eHalContext *ctx, HalEncTask *task,
         hw_cfg->qp = mpp_clip(hw_cfg->qp,
                               hw_cfg->qp_prev - codec->qp_max_step,
                               hw_cfg->qp_prev + codec->qp_max_step);
-    }else{
+    } else {
         hw_cfg->qp_min = codec->qp_min;
         hw_cfg->qp_max = codec->qp_max;
     }
diff --git a/test/README.md b/test/README.md
new file mode 100644
index 00000000..d4f16450
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,29 @@
+# Unit test description
+
+## There are some unit test for testing mpp functions in this catalog.
+
+### mpi_enc_test:
+use sync interface(poll,dequeue and enqueue), encode raw yuv to compress video.
+
+### mpi_dec_test:
+use sync interface and async interface(decode_put_packet and decode_get_frame),
+decode compress video to raw yuv.
+
+### mpi_rc_test:
+encode use detailed bitrate control config.
+
+### mpi_rc2_test:
+encode use detailed bitrate control config,and cfg param come from mpi_rc.cfg.
+
+### mpi_test:
+simple description of mpi calling method, just for reference
+
+### mpp_event_trigger:
+event trigger test.
+
+### mpp_parse_cfg:
+mpp parser cfg test.
+
+### vpu_api_test
+encode or decode use legacy interface, in order to compatible with the previous
+vpu interface.