Merge pull request #8 from openapv/add-feature-list-in-readme

Add feature list of OpenAPV in readme and support floating number frame rate (fps)

Author: openapv

README.md

@@ -3,10 +3,23 @@
 
 [![Build & test](https://github.com/cpncf/apv/actions/workflows/build.yml/badge.svg)](https://github.com/cpncf/apv/actions/workflows/build.yml)
 
-OpenAPV provides the reference implementation of the APV codec which can be used to record professional-grade video and associated metadata without quality degradation.
+OpenAPV provides the reference implementation of the [APV codec](#apv-codec) which can be used to record professional-grade video and associated metadata without quality degradation. OpenAPV is free and open source software provided by [LICENSE](#license).
+
+The OpenAPV supports the following features:
+
+- fully compliant with 422-10 and 400-10 profile of [APV codec](#apv-codec)
+- Low complexity by optimization for ARM NEON and x86(64bit) SEE/AVX CPU
+- Supports tile-based multi-threading
+- Supports Various metadata including HDR10/10+ and user-defined format
+- Constant QP (CQP), average bitrate (ABR), and constant rate factor (CRF) are supported
+
 
 ## APV codec
-The APV codec is a professional video codec, which was developed in response to the need for professional level high quality video recording and post production. The primary purpose of the APV codec is for use in professional video recording and editing workflows for various types of content. The APV codec supports the following features:
+The APV codec is a professional video codec, which was developed in response to the need for professional level high quality video recording and post production. The primary purpose of the APV codec is for use in professional video recording and editing workflows for various types of content. 
+
+APV codec utilizes technologies known to be over 20 years to achieve a royalty free codec. APV builds a video codec using only conventional coding technologies, which consist of traditional methods published between the early 1980s and the end of the 1990s.
+
+The APV codec standard has the following features:
 
 - Perceptually lossless video quality, which is close to raw video quality
 - Low complexity and high throughput intra frame only coding without pixel domain prediction
@@ -20,6 +33,7 @@ The APV codec is a professional video codec, which was developed in response to
 ### Related specification
 - APV Codec (bitstream): [https://datatracker.ietf.org/doc/draft-lim-apv/](https://datatracker.ietf.org/doc/draft-lim-apv/)
   - Scope of OpenAPV project
+- APV ISO based media file format: [APV-ISOBMFF](/readme/apv_isobmff.md)
 - APV RTP payload format: [https://datatracker.ietf.org/doc/draft-lim-rtp-apv/](https://datatracker.ietf.org/doc/draft-lim-rtp-apv/)
 
 ## How to build
@@ -81,3 +95,4 @@ cpack -G TGZ
 ## License
 
 See [LICENSE](LICENSE) file for details.
+

app/oapv_app_args.h

@@ -69,6 +69,7 @@ struct _ARGS_PARSER
     int (*get_help)(ARGS_PARSER * args, int idx, char * help);
     int (*get_str)(ARGS_PARSER * args, char * keyl, char * str, int *flag);
     int (*get_int)(ARGS_PARSER * args, char * keyl, int * val, int *flag);
+    int (*set_str)(ARGS_PARSER * args, char * keyl, char * str);
     int (*set_int)(ARGS_PARSER * args, char * keyl, int val);
     int (*set_flag)(ARGS_PARSER * args, char * keyl, int flag);
     int (*check_mandatory)(ARGS_PARSER * args, char ** err_arg);
@@ -392,6 +393,23 @@ static int args_get(ARGS_PARSER * args, char * keyl, void ** val, int * flag)
     }
 }
 
+static int args_set_str(ARGS_PARSER * args, char * keyl, char * str)
+{
+    int idx;
+
+    idx = args_search_long_key(args->opts, keyl);
+    if(idx >= 0)
+    {
+        sprintf((char*)(args->opts[idx].val), "%s", str);
+        args->opts[idx].flag = 1;
+        return 0;
+    }
+    else
+    {
+        return -1;
+    }
+}
+
 static int args_set_int(ARGS_PARSER * args, char * keyl, int val)
 {
     int idx;
@@ -579,6 +597,7 @@ static ARGS_PARSER * args_create(const ARGS_OPT * opt_table, int num_opt)
     args->get_help = args_get_help;
     args->get_str = args_get_str;
     args->get_int = args_get_int;
+    args->set_str = args_set_str;
     args->set_int = args_set_int;
     args->set_flag = args_set_flag;
     args->check_mandatory = args_check_mandatory;

app/oapv_app_enc.c

@@ -81,8 +81,8 @@ static const ARGS_OPT enc_args_opts[] = {
         "QP value (0~51)"
     },
     {
-        'z',  "fps", ARGS_VAL_TYPE_INTEGER | ARGS_VAL_TYPE_MANDATORY, 0, NULL,
-        "frame rate (frame per second)"
+        'z',  "fps", ARGS_VAL_TYPE_STRING | ARGS_VAL_TYPE_MANDATORY, 0, NULL,
+        "frame rate (frame per second))"
     },
     {
         'm',  "threads", ARGS_VAL_TYPE_INTEGER, 0, NULL,
@@ -202,6 +202,7 @@ typedef struct {
     char           level[32];
     int            band;
     char           bitrate[64];
+    char           fps[256];
     char           q_matrix_y[512];
     char           q_matrix_u[512];
     char           q_matrix_v[512];
@@ -241,6 +242,8 @@ static ARGS_VAR* args_init_vars(ARGS_PARSER* args, oapve_param_t* param)
     args_set_variable_by_key_long(opts, "band", &vars->band);
     vars->band = 2; /* default */
     args_set_variable_by_key_long(opts, "bitrate", vars->bitrate);
+    args_set_variable_by_key_long(opts, "fps", vars->fps);
+    strncpy(vars->fps, "60", sizeof(vars->fps) - 1);
     args_set_variable_by_key_long(opts, "q-matrix-y", vars->q_matrix_y);
     strncpy(vars->q_matrix_y, "", sizeof(vars->q_matrix_y) - 1);
     args_set_variable_by_key_long(opts, "q-matrix-u", vars->q_matrix_u);
@@ -255,7 +258,6 @@ static ARGS_VAR* args_init_vars(ARGS_PARSER* args, oapve_param_t* param)
     ARGS_SET_PARAM_VAR_KEY(opts, param, w);
     ARGS_SET_PARAM_VAR_KEY(opts, param, h);
     ARGS_SET_PARAM_VAR_KEY_LONG(opts, param, qp);
-    ARGS_SET_PARAM_VAR_KEY_LONG(opts, param, fps);
     ARGS_SET_PARAM_VAR_KEY_LONG(opts, param, preset);
     ARGS_SET_PARAM_VAR_KEY_LONG(opts, param, rc_type);
     ARGS_SET_PARAM_VAR_KEY_LONG(opts, param, use_filler);
@@ -349,7 +351,7 @@ static void print_config(ARGS_VAR* vars, oapve_param_t* param)
     logv2("\tprofile                  = %s\n", vars->profile);
     logv2("\twidth                    = %d\n", param->w);
     logv2("\theight                   = %d\n", param->h);
-    logv2("\tFPS                      = %d\n", param->fps);
+    logv2("\tFPS                      = %.2f\n", (float)param->fps_num / param->fps_den);
     logv2("\tQP                       = %d\n", param->qp);
     logv2("\tframes                   = %d\n", vars->frames);
     logv2("\trate-control type        = %s\n", (param->rc_type == OAPV_RC_ABR) ? "ABR" : "CQP");
@@ -507,6 +509,24 @@ static int update_param(ARGS_VAR* vars, oapve_param_t* param)
     /* update band idc */
     param->band_idc = vars->band;
 
+    /* update fps */
+    if (strpbrk(vars->fps, "/") != NULL)
+    {
+        sscanf(vars->fps, "%d/%d", &param->fps_num, &param->fps_den);
+    }
+    else if (strpbrk(vars->fps, ".") != NULL)
+    {
+        float tmp_fps = 0;
+        sscanf(vars->fps, "%f", &tmp_fps);
+        param->fps_num = tmp_fps * 10000;
+        param->fps_den = 10000;
+    }
+    else
+    {
+        sscanf(vars->fps, "%d", &param->fps_num);
+        param->fps_den = 1;
+    }
+
     return 0;
 }
 
@@ -793,12 +813,14 @@ int main(int argc, const char** argv)
             ret = oapve_encode(id, &ifrms, mid, &bitb, &stat, &rfrms);
 
             for(int i = 0; i < num_frames; i++) {
-                if(args_var->input_depth != 10) {
-                    imgb_cpy(imgb_w, rfrms.frm[i].imgb);
-                    imgb_o = imgb_w;
-                }
-                else {
-                    imgb_o = rfrms.frm[i].imgb;
+                if(is_rec){
+                    if(args_var->input_depth != 10) {
+                        imgb_cpy(imgb_w, rfrms.frm[i].imgb);
+                        imgb_o = imgb_w;
+                    }
+                    else {
+                        imgb_o = rfrms.frm[i].imgb;
+                    }
                 }
 
                 clk_end = oapv_clk_from(clk_beg);
@@ -846,7 +868,7 @@ int main(int argc, const char** argv)
                     total_time          = total_time % 60;
                     int    s            = total_time;
                     double curr_bitrate = bitrate;
-                    curr_bitrate *= (param->fps * 8);
+                    curr_bitrate *= (((float)param->fps_num / param->fps_den) * 8);
                     curr_bitrate /= (encod_frames + 1);
                     curr_bitrate /= 1000;
                     logv2("[ %d / %d frames ] [ %.2f frame/sec ] [ %.4f kbps ] [ %2dh %2dm %2ds ] \r", encod_frames, max_frames, ((float)(encod_frames + 1) * 1000) / ((float)oapv_clk_msec(clk_tot)), curr_bitrate, h, m, s);
@@ -886,7 +908,7 @@ int main(int argc, const char** argv)
         logv3("  PSNR T(dB)       : %-5.4f\n", psnr_avg[3]);
     }
     logv3("  Total bits(bits) : %.0f\n", bitrate * 8);
-    bitrate *= (param->fps * 8);
+    bitrate *= (((float)param->fps_num / param->fps_den) * 8);
     bitrate /= pic_cnt;
     bitrate /= 1000;
 

app/oapv_app_y4m.h

@@ -35,7 +35,8 @@ typedef struct _Y4M_PARAMS
 {
     int w;
     int h;
-    int fps;
+    int fps_num;
+    int fps_den;
     int color_format;
     int bit_depth;
 }Y4M_INFO;
@@ -97,7 +98,8 @@ static int y4m_parse_tags(Y4M_INFO * y4m, char * tags)
         case 'F':
         {
             if (sscanf(p + 1, "%d:%d", &fps_n, &fps_d) != 2) return OAPV_ERR;
-             y4m->fps = (int)((fps_n /(double)fps_d) + 0.5);
+             y4m->fps_num = fps_n;
+             y4m->fps_den = fps_d;
             break;
         }
         case 'I':
@@ -217,7 +219,9 @@ static void y4m_update_param(ARGS_PARSER * args, Y4M_INFO * y4m)
 {
     args->set_int(args, "width", y4m->w);
     args->set_int(args, "height", y4m->h);
-    args->set_int(args, "fps", y4m->fps);
+    char tmp_fps[256];
+    sprintf(tmp_fps, "%d/%d", y4m->fps_num, y4m->fps_den);
+    args->set_str(args, "fps", tmp_fps);
     args->set_int(args, "input-depth", y4m->bit_depth);
 }
 

inc/oapv.h

@@ -127,7 +127,8 @@ extern "C"
  *****************************************************************************/
 #define OAPV_CFG_SET_QP                 (201)
 #define OAPV_CFG_SET_BPS                (202)
-#define OAPV_CFG_SET_FPS                (204)
+#define OAPV_CFG_SET_FPS_NUM            (204)
+#define OAPV_CFG_SET_FPS_DEN            (205)
 #define OAPV_CFG_SET_QP_MIN             (208)
 #define OAPV_CFG_SET_QP_MAX             (209)
 #define OAPV_CFG_SET_USE_FRM_HASH       (301)
@@ -136,7 +137,8 @@ extern "C"
 #define OAPV_CFG_GET_QP                 (602)
 #define OAPV_CFG_GET_RCT                (603)
 #define OAPV_CFG_GET_BPS                (604)
-#define OAPV_CFG_GET_FPS                (605)
+#define OAPV_CFG_GET_FPS_NUM            (605)
+#define OAPV_CFG_GET_FPS_DEN            (606)
 #define OAPV_CFG_GET_WIDTH              (701)
 #define OAPV_CFG_GET_HEIGHT             (702)
 
@@ -366,9 +368,10 @@ struct oapve_param {
     int w;
     /* height of input frame */
     int h;
-    /* frame rate (Hz) */
-    int fps;
-    /* Rate control type */
+    /* frame rate (Hz) numerator, denominator */
+    int fps_num;
+    int fps_den;
+    /* rate control type */
     int rc_type;
     /* quantization parameter */
     int qp;