Add crf ratecontrol support

CMakeLists.txt

@@ -66,7 +66,7 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON)
 if(WIN32)
     set(CMAKE_ASM_NASM_FLAGS "${CMAKE_ASM_NASM_FLAGS} -DWIN64")
 else()
-    set(CMAKE_ASM_NASM_FLAGS "${CMAKE_ASM_NASM_FLAGS} -DUNIX64")
+    set(CMAKE_ASM_NASM_FLAGS "${CMAKE_ASM_NASM_FLAGS} -DUNIX64 -DPIC")
 endif()
 
 if(UNIX)

Config/Sample.cfg

@@ -76,13 +76,20 @@ SearchAreaHeight                : 7                     # Number of search posit
 ConstrainedIntra                : 0                     # Enable the use of Constrained Intra which results in sending two PPSs (0: OFF, 1: ON)
 
 # ====================== Rate Control ===============================
-RateControlMode                 : 0                     # Rate control mode (0: OFF(CQP), 1: VBR)
+RateControlMode                 : 0                     # Rate control mode (0: OFF(CQP), 1: VBR, 2: CRF)
 TargetBitRate                   : 7000000               # Target Bit Rate (in bits per second)
+lowLevelVbv                     : 0                     # Enables loeLevelVBV Algorithm (0: OFF, 1: ON)
+vbvMaxrate                      : 0                     # VBV MaxRate (in bits per second)
+vbvBufsize                      : 0                     # VBV Bufsize (in bits per second)
+vbvBufInit                      : 90                    # Sets how full the VBV buffer to be - [0 - 100]
+vbvBufEnd                       : 0                     # VBV BufEnd [0 - 100]
+vbvEndFrameAdjust               : 0                     # VBV EndFrameAdjust [0 - 100] 
+hrdFlag                         : 0                     # hrdflag (When hrdFlag is set to 1 it requires vbvMaxrate and vbvBufsize to be greater than 0)(0: disable , 1: enable)
 MaxQpAllowed                    : 48                    # maximum allowed QP when rate control is on - [0-51]
 MinQpAllowed                    : 10                    # minimum allowed QP when rate control is on - [0-51]
 LookAheadDistance               : 17                    # Enable Look Ahead [0-250]
 SceneChangeDetection            : 1                     # Enable Scene Change Detection (0: OFF, 1: ON)
-
+ConstantRateFactor              : 28                    # CRF value allowed for rate control use - [0-51]
 # ====================== Tune ===============================
 Tune                            : 1                     # Tune (0=SQ - visually optimized mode, 1=OQ - PSNR / SSIM optimized mode, 2=VMAF - VMAF optimized mode) 
 

Docs/svt-hevc_encoder_user_guide.md

@@ -294,8 +294,16 @@ The encoder parameters present in the Sample.cfg file are listed in this table b
 | **SearchAreaWidth** | -search-w | [1 - 256] | Depends on input resolution | Search Area in Width |
 | **SearchAreaHeight** | -search-h | [1 - 256] | Depends on input resolution | Search Area in Height |
 | **ConstrainedIntra** | -constrd-intra | [0,1] | 0 | Allow the use of Constrained Intra, when enabled, this features yields to sending two PPSs in the HEVC Elementary streams <br>0 = OFF, 1 = ON |
-| **RateControlMode** | -rc | [0,1] | 0 | 0 : CQP , 1 : VBR |
+| **RateControlMode** | -rc | [0,1] | 0 | 0 : CQP , 1 : VBR , 2 : CRF |
+| **ConstantRateFactor** | -crf | [0 - 51] | 28 | CRF value allowed for rate control use, only apllicable when RateControlMode is set to 2 |
 | **TargetBitRate** | -tbr | Any Number | 7000000 | Target bitrate in bits / second. Only used when RateControlMode is set to 1 |
+| **lowLevelVbv** | -low-level-vbv | [0,1] | 0 | Enable lowLevelVBV algorithm. 0 = OFF, 1 = ON  |
+| **vbvMaxrate** | -vbv-maxrate | Any Number | 0 | VBVMaxrate in bits / second. Only used when RateControlMode is set to 1 |
+| **vbvBufsize** | -vbv-bufsize | Any Number | 0 | VBV BufferSize in bits / second. Only used when RateControlMode is set to 1 |
+| **vbvBufInit** | -vbv-init | [0 - 100] | 90 | Sets how full the VBV buffer to be|
+| **vbvBufEnd** | -vbv-end | [0 - 100] | 0 | Sets how VBV Buffer ends|
+| **vbvEndFrameAdjust** | -vbv-end-fr-adj | [0 - 100] | 0 | Sets vbvEndFrameAdjust|
+| **hrdFlag** | -hrd | [0,1] | 0 | HRD Flag, 0 = OFF, 1 = ON |When hrdFlag is set to 1 it requires vbvMaxrate and vbvBufsize to be greater than 0 |
 | **MaxQpAllowed** | -max-qp | [0 - 51] | 48 | Maximum QP value allowed for rate control use. Only used when RateControlMode is set to 1. Has to be >= MinQpAllowed |
 | **MinQpAllowed** | -min-qp | [0 - 50] | 10 | Minimum QP value allowed for rate control use. Only used when RateControlMode is set to 1. Has to be < MaxQpAllowed |
 | **LookAheadDistance** | -lad | [0 - 250] | Depending on BRC mode | When RateControlMode is set to 1 it&#39;s best to set this parameter to be equal to the Intra period value (such is the default set by the encoder), When CQP is chosen, then a (2 \* minigopsize +1) look ahead is recommended. |
@@ -427,6 +435,21 @@ Similarly, in order to run a 2-stream 8kp50 simultaneous encode on a Xeon Platin
 
 >taskset 0xFFFFFFF0000000FFFFFFF0000000./SvtHevcEncApp -encMode 12 -tune 0  -w 7680  -h 4320 -bit-depth 10 -compressed-ten-bit-format 1 -i in.yuv  -rc 1 –tbr 20000000 -fps 50  -b out1.bin   -n 5000 –nb 500  &amp;
 
+<br>
+Similarly, in order to enable VBV and run a 2-stream 8kp50 simultaneous encode on a Xeon Platinum 8180 system the following command lines should be used:
+
+#### *Running Windows\* Server 2016:*
+
+>start /node 0 SvtHevcEncApp.exe -encMode 12 -tune 0 -w 3840 -h 2160 -bit-depth 10 -compressed-ten-bit-format 1 -i in.yuv  -rc 1 –tbr 10000000 -vbv-maxrate 10000000  -vbv-bufsize 10000000 -fps 50  -b out1.bin   -n 5000 –nb 500
+
+>start /node 1 SvtHevcEncApp.exe -encMode 12 -tune 0  -w 3840 -h 2160 -bit-depth 10 -compressed-ten-bit-format 1 -i in.yuv  -rc 1 –tbr 10000000 -vbv-maxrate 10000000 -vbv-bufsize 10000000 -fps 50  -b out3.bin   -n 5000 –nb 500
+
+#### *Running Ubuntu\* 18.04:*
+
+>taskset 0x0000000FFFFFFF0000000FFFFFFF ./SvtHevcEncApp -encMode 12 -tune 0  -w 3840 -h 2160 -bit-depth 10 -compressed-ten-bit-format 1 -i in.yuv  -rc 1 –tbr 10000000 -vbv-maxrate 10000000  -vbv-bufsize 10000000 -fps 50  -b out3.bin   -n 5000 –nb 500 &amp;
+
+>taskset 0xFFFFFFF0000000FFFFFFF0000000 ./SvtHevcEncApp -encMode 12 -tune 0  -w 3840 -h 2160 -bit-depth 10 -compressed-ten-bit-format 1 -i in.yuv  -rc 1 –tbr 10000000 -vbv-maxrate 10000000  -vbv-bufsize 10000000 -fps 50  -b out3.bin   -n 5000 –nb 500  &amp;
+
 <br>
 Where 0x0000000FFFFFFF0000000FFFFFFF and 0xFFFFFFF0000000FFFFFFF0000000 are masks for sockets 0 and 1 respectively on a dual 8180 system.
 

Source/API/EbApi.h

@@ -418,6 +418,11 @@ typedef struct EB_H265_ENC_CONFIGURATION
      *
      * Default is 10. */
     uint32_t                minQpAllowed;
+    /* CRF value allowed for rate control use, only apllicable when rate
+     * control mode is set to 2.
+     *
+     * Default is 28. */
+    uint32_t                crf;
 
 
     // bitstream options
@@ -508,15 +513,52 @@ typedef struct EB_H265_ENC_CONFIGURATION
     uint8_t                 fpsInVps;
 
 
-    // Application Specific parameters
+    // VBV Parameters
+    /* Sets the maximum rate the VBV buffer should be assumed to refill at
+     * 
+     * Default is 0. */
+    uint32_t                vbvMaxrate;
 
+    /* Sets the size of the VBV buffer in bits. 
+     *
+     * Default is 0. */
+    uint32_t                vbvBufsize;
+	/* Sets how full the VBV buffer must be before playback starts. If picture
+	 * number is 0, then the initial fill is vbv-init * vbvBufferSize.
+	 * Otherwise, it is interpreted as the initial fill in bits.
+	 *
+	 * Default is 90. */
+	uint64_t                vbvBufInit;
+	/* Sets how full the VBV buffer must be end.
+	 *
+	 * Default is 0. */
+	uint64_t                vbvBufEnd;
+	/* Sets  vbvEndFrameAdjust.
+	 *
+	 * Default is 0. */
+	uint64_t                vbvEndFrameAdjust;
+	/* Enables the buffering period SEI and picture timing SEI to signal the HRD
+	* parameters.
+	*
+	* 0 = disable.
+	* 1 = enable.
+	*
+	* Default is 0. */
+    uint32_t                hrdFlag;
+
     /* ID assigned to each channel when multiple instances are running within the
      * same application. */
     uint32_t                channelId;
 
     /* Active channel count. */
     uint32_t                activeChannelCount;
-
+	/* Enables lowLevelVBV Algorithm
+    *
+	* 0 = disable.
+	* 1 = enable.
+	*
+	* Default is 0. */
+    uint8_t                 lowLevelVbv;
 
     // Threads management
 
@@ -535,6 +577,7 @@ typedef struct EB_H265_ENC_CONFIGURATION
      * Default is -1. */
     int32_t                 targetSocket;
 
+
     /* Flag to enable threads to real time priority. Running with sudo privilege
      * utilizes full resource. Only applicable to Linux.
      *

Source/App/CMakeLists.txt

@@ -32,7 +32,7 @@ target_link_libraries(SvtHevcEncApp
 
 if(UNIX)
 	target_link_libraries(SvtHevcEncApp
-        pthread)
+        pthread m)
     if(NOT APPLE)
         target_link_libraries(SvtHevcEncApp
             rt)

Source/App/EbAppConfig.c

@@ -84,6 +84,14 @@
 #define NALU_FILE_TOKEN                 "-nalu-file"
 #define RATE_CONTROL_ENABLE_TOKEN       "-rc"
 #define TARGET_BIT_RATE_TOKEN           "-tbr"
+#define CRF_TOKEN                       "-crf"
+#define VBV_MAX_RATE_TOKEN              "-vbv-maxrate"
+#define VBV_BUFFER_SIZE_TOKEN           "-vbv-bufsize"
+#define VBV_BUFFER_INIT_TOKEN           "-vbv-init"
+#define VBV_BUFFER_END_TOKEN            "-vbv-end"
+#define VBV_END_FRAME_ADJUST_TOKEN      "-vbv-end-fr-adj"
+#define ENABLE_LOW_LEVEL_VBV_TOKEN      "-low-level-vbv"
+#define HRD_TOKEN                       "-hrd"
 #define MAX_QP_TOKEN                    "-max-qp"
 #define MIN_QP_TOKEN                    "-min-qp"
 #define TEMPORAL_ID					    "-temporal-id" // no Eval
@@ -181,6 +189,7 @@ static void SetFrameRate                        (const char *value, EbConfig_t *
         cfg->frameRate = cfg->frameRate << 16;
     }
 }
+
 static void SetFrameRateNumerator               (const char *value, EbConfig_t *cfg) {cfg->frameRateNumerator               = strtoul(value, NULL, 0);};
 static void SetFrameRateDenominator             (const char *value, EbConfig_t *cfg) {cfg->frameRateDenominator             = strtoul(value, NULL, 0);};
 static void SetEncoderBitDepth                  (const char *value, EbConfig_t *cfg) {cfg->encoderBitDepth                  = strtoul(value, NULL, 0);}
@@ -193,6 +202,7 @@ static void SetCfgIntraRefreshType              (const char *value, EbConfig_t *
 static void SetHierarchicalLevels               (const char *value, EbConfig_t *cfg) {cfg->hierarchicalLevels               = strtol(value, NULL, 0); };
 static void SetCfgPredStructure                 (const char *value, EbConfig_t *cfg) {cfg->predStructure                    = strtol(value, NULL, 0); };
 static void SetCfgQp                            (const char *value, EbConfig_t *cfg) {cfg->qp                               = strtoul(value, NULL, 0);};
+static void SetCfgCrf                           (const char *value, EbConfig_t *cfg) {cfg->crf                              = strtoul(value, NULL, 0); };
 static void SetCfgUseQpFile                     (const char *value, EbConfig_t *cfg) {cfg->useQpFile                        = (EB_BOOL)strtol(value, NULL, 0); };
 static void SetCfgTileColumnCount               (const char *value, EbConfig_t *cfg) { cfg->tileColumnCount                 = (EB_BOOL)strtol(value, NULL, 0); };
 static void SetCfgTileRowCount                  (const char *value, EbConfig_t *cfg) { cfg->tileRowCount                    = (EB_BOOL)strtol(value, NULL, 0); };
@@ -213,6 +223,13 @@ static void SetEnableConstrainedIntra           (const char *value, EbConfig_t *
 static void SetCfgTune                          (const char *value, EbConfig_t *cfg) {cfg->tune                             = (uint8_t)strtoul(value, NULL, 0); };
 static void SetBitRateReduction                 (const char *value, EbConfig_t *cfg) {cfg->bitRateReduction                 = (EB_BOOL)strtol(value, NULL, 0); };
 static void SetImproveSharpness                 (const char *value, EbConfig_t *cfg) {cfg->improveSharpness                 = (EB_BOOL)strtol(value,  NULL, 0);};
+static void SetVbvMaxrate                       (const char *value, EbConfig_t *cfg) { cfg->vbvMaxRate                      = strtoul(value, NULL, 0); };
+static void SetVbvBufsize                       (const char *value, EbConfig_t *cfg) { cfg->vbvBufsize                      = strtoul(value, NULL, 0); };
+static void SetVbvBufInit                       (const char *value, EbConfig_t *cfg) { cfg->vbvBufInit                      = strtoul(value, NULL, 0); };
+static void SetVbvEndFrameAdjust                (const char *value, EbConfig_t *cfg) { cfg->vbvEndFrameAdjust               = strtoul(value, NULL, 0); };
+static void SetVbvBufEnd                        (const char *value, EbConfig_t *cfg) { cfg->vbvBufEnd                       = strtoul(value, NULL, 0); };
+static void SetLowLevelVbv                      (const char *value, EbConfig_t *cfg) { cfg->lowLevelVbv                     = (EB_BOOL)strtol(value, NULL, 0); };
+static void SetHrdFlag                          (const char *value, EbConfig_t *cfg) { cfg->hrdFlag                         = strtoul(value, NULL, 0); };
 static void SetVideoUsabilityInfo               (const char *value, EbConfig_t *cfg) {cfg->videoUsabilityInfo               = strtol(value,  NULL, 0);};
 static void SetHighDynamicRangeInput            (const char *value, EbConfig_t *cfg) {cfg->highDynamicRangeInput            = strtol(value,  NULL, 0);};
 static void SetAccessUnitDelimiter              (const char *value, EbConfig_t *cfg) {cfg->accessUnitDelimiter              = strtol(value,  NULL, 0);};
@@ -313,6 +330,14 @@ config_entry_t config_entry[] = {
     { SINGLE_INPUT, FRAME_RATE_TOKEN, "FrameRate", SetFrameRate },
     { SINGLE_INPUT, FRAME_RATE_NUMERATOR_TOKEN, "FrameRateNumerator", SetFrameRateNumerator },
     { SINGLE_INPUT, FRAME_RATE_DENOMINATOR_TOKEN, "FrameRateDenominator", SetFrameRateDenominator },
+
+    { SINGLE_INPUT, ENCODER_BIT_DEPTH, "EncoderBitDepth", SetEncoderBitDepth },
+    { SINGLE_INPUT, ENCODER_COLOR_FORMAT, "EncoderColorFormat", SetEncoderColorFormat},
+    { SINGLE_INPUT, INPUT_COMPRESSED_TEN_BIT_FORMAT, "CompressedTenBitFormat", SetcompressedTenBitFormat },
+    { SINGLE_INPUT, HIERARCHICAL_LEVELS_TOKEN, "HierarchicalLevels", SetHierarchicalLevels },
+
+    { SINGLE_INPUT, PRED_STRUCT_TOKEN, "PredStructure", SetCfgPredStructure },
+
     { SINGLE_INPUT, INJECTOR_TOKEN, "Injector", SetInjector },
     { SINGLE_INPUT, INJECTOR_FRAMERATE_TOKEN, "InjectorFrameRate", SetInjectorFrameRate },
 
@@ -330,6 +355,22 @@ config_entry_t config_entry[] = {
     // Quantization
     { SINGLE_INPUT, QP_TOKEN, "QP", SetCfgQp },
 
+
+    { SINGLE_INPUT, USE_QP_FILE_TOKEN, "UseQpFile", SetCfgUseQpFile },
+    { SINGLE_INPUT, RATE_CONTROL_ENABLE_TOKEN, "RateControlMode", SetRateControlMode },
+    { SINGLE_INPUT, LOOK_AHEAD_DIST_TOKEN, "LookAheadDistance",                             SetLookAheadDistance},
+    { SINGLE_INPUT, TARGET_BIT_RATE_TOKEN, "TargetBitRate", SetTargetBitRate },
+    { SINGLE_INPUT, MAX_QP_TOKEN, "MaxQpAllowed", SetMaxQpAllowed },
+    { SINGLE_INPUT, MIN_QP_TOKEN, "MinQpAllowed", SetMinQpAllowed },
+    { SINGLE_INPUT, VBV_MAX_RATE_TOKEN, "vbvMaxRate", SetVbvMaxrate },
+    { SINGLE_INPUT, VBV_BUFFER_SIZE_TOKEN, "vbvBufsize", SetVbvBufsize },
+    { SINGLE_INPUT, HRD_TOKEN, "hrd", SetHrdFlag },
+    { SINGLE_INPUT, VBV_BUFFER_INIT_TOKEN, "vbvBufInit", SetVbvBufInit},
+    { SINGLE_INPUT, VBV_BUFFER_END_TOKEN, "vbvBufEnd", SetVbvBufEnd},
+    { SINGLE_INPUT, VBV_END_FRAME_ADJUST_TOKEN, "vbvEndFrameAdjustToken", SetVbvEndFrameAdjust},
+
+    { SINGLE_INPUT, ENABLE_LOW_LEVEL_VBV_TOKEN,"lowLevelVbv",SetLowLevelVbv},
+
     // Deblock Filter
     { SINGLE_INPUT, LOOP_FILTER_DISABLE_TOKEN, "LoopFilterDisable", SetDisableDlfFlag },
 
@@ -348,6 +389,7 @@ config_entry_t config_entry[] = {
     { SINGLE_INPUT, CONSTRAINED_INTRA_ENABLE_TOKEN, "ConstrainedIntra", SetEnableConstrainedIntra },
 
     // Rate Control
+	{ SINGLE_INPUT, CRF_TOKEN, "CRF", SetCfgCrf },
     { SINGLE_INPUT, RATE_CONTROL_ENABLE_TOKEN, "RateControlMode", SetRateControlMode },
     { SINGLE_INPUT, TARGET_BIT_RATE_TOKEN, "TargetBitRate", SetTargetBitRate },
     { SINGLE_INPUT, MAX_QP_TOKEN, "MaxQpAllowed", SetMaxQpAllowed },
@@ -430,11 +472,18 @@ void EbConfigCtor(EbConfig_t *configPtr)
     configPtr->maxQpAllowed                         = 48;
     configPtr->minQpAllowed                         = 10;
     configPtr->baseLayerSwitchMode                  = 0;
-	  configPtr->encMode								              = 9;
+    configPtr->crf                                  = 28;
+    configPtr->vbvMaxRate                           = 0;
+    configPtr->vbvBufsize                           = 0;
+    configPtr->vbvBufInit                           = 90;
+    configPtr->vbvBufEnd                            = 0;
+    configPtr->vbvEndFrameAdjust                    = 0;
+    configPtr->hrdFlag                              =  0;
+    configPtr->lowLevelVbv                          = 0;
     configPtr->intraPeriod                          = -2;
     configPtr->intraRefreshType                     = 1;
-	  configPtr->hierarchicalLevels					          = 3;
-	  configPtr->predStructure						            = 2;
+    configPtr->hierarchicalLevels					= 3;
+    configPtr->predStructure						= 2;
     configPtr->disableDlfFlag                       = EB_FALSE;
     configPtr->enableSaoFlag                        = EB_TRUE;
     configPtr->useDefaultMeHme                      = EB_TRUE;
@@ -450,7 +499,7 @@ void EbConfigCtor(EbConfig_t *configPtr)
     configPtr->bufferingPeriodSEI                   = 0;
     configPtr->pictureTimingSEI                     = 0;
 
-    configPtr->bitRateReduction					    = EB_TRUE;
+    configPtr->bitRateReduction	                    = EB_TRUE;
     configPtr->improveSharpness                     = EB_TRUE;
     configPtr->registeredUserDataSeiFlag            = EB_FALSE;
     configPtr->unregisteredUserDataSeiFlag          = EB_FALSE;
@@ -481,7 +530,7 @@ void EbConfigCtor(EbConfig_t *configPtr)
     configPtr->unrestrictedMotionVector             = EB_TRUE;
 
     // Encoding Presets
-    configPtr->encMode								    = 9;
+    configPtr->encMode							        = 9;
     //configPtr->latencyMode                              = 0; // Deprecated
     configPtr->speedControlFlag                         = 0;
 
@@ -513,9 +562,9 @@ void EbConfigCtor(EbConfig_t *configPtr)
     configPtr->separateFields                           = EB_FALSE;
 
     // Coding Structure
-    configPtr->hierarchicalLevels					    = 3;
+    configPtr->hierarchicalLevels                       = 3;
     configPtr->baseLayerSwitchMode                      = 0;
-    configPtr->predStructure						    = 2;
+    configPtr->predStructure                            = 2;
     configPtr->intraPeriod                              = -2;
     configPtr->intraRefreshType                         = 1;
 
@@ -548,7 +597,7 @@ void EbConfigCtor(EbConfig_t *configPtr)
     configPtr->tune                                     = 1;
 
     // Adaptive QP Params
-    configPtr->bitRateReduction					        = EB_TRUE;
+    configPtr->bitRateReduction	                        = EB_TRUE;
     configPtr->improveSharpness                         = EB_TRUE;
 
     // Optional Features

Source/App/EbAppConfig.h

@@ -325,7 +325,12 @@ typedef struct EbConfig_s
     uint32_t                 targetBitRate;
     uint32_t                 maxQpAllowed;
     uint32_t                 minQpAllowed;
-
+    uint32_t                 crf;
+    uint32_t                 vbvMaxRate;
+    uint32_t                 vbvBufsize;
+    uint64_t                 vbvBufInit;
+    uint64_t                 vbvBufEnd;
+    uint64_t                 vbvEndFrameAdjust;
     /****************************************
     * TUNE
     ****************************************/
@@ -348,6 +353,8 @@ typedef struct EbConfig_s
     uint32_t                 enableTemporalId;
     EB_BOOL                switchThreadsToRtPriority;
     EB_BOOL                fpsInVps;
+    uint32_t                 hrdFlag;
+    EB_BOOL                  lowLevelVbv;
     EB_BOOL                unrestrictedMotionVector;
 
     /****************************************