uvg266/src/cli.c

767 lines
40 KiB
C
Raw Normal View History

/*****************************************************************************
2021-11-23 06:46:06 +00:00
* This file is part of uvg266 VVC encoder.
*
* Copyright (c) 2021, Tampere University, ITU/ISO/IEC, project contributors
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* * Neither the name of the Tampere University or ITU/ISO/IEC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
****************************************************************************/
/*
* \file
*
*/
#include "cli.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <ctype.h>
static const char short_options[] = "i:o:d:n:q:p:r:";
static const struct option long_options[] = {
{ "input", required_argument, NULL, 'i' },
{ "output", required_argument, NULL, 'o' },
{ "debug", required_argument, NULL, 'd' },
{ "frames", required_argument, NULL, 'n' },
{ "qp", required_argument, NULL, 'q' },
{ "period", required_argument, NULL, 'p' },
{ "ref", required_argument, NULL, 'r' },
{ "vps-period", required_argument, NULL, 0 },
{ "input-res", required_argument, NULL, 0 },
{ "input-fps", required_argument, NULL, 0 },
{ "lmcs", no_argument, NULL, 0 },
{ "deblock", required_argument, NULL, 0 },
{ "no-deblock", no_argument, NULL, 0 },
{ "sao", required_argument, NULL, 0 },
{ "no-sao", no_argument, NULL, 0 },
{ "alf", required_argument, NULL, 0 },
2019-07-04 07:20:18 +00:00
{ "no-alf", no_argument, NULL, 0 },
{ "rdoq", no_argument, NULL, 0 },
{ "no-rdoq", no_argument, NULL, 0 },
{ "signhide", no_argument, NULL, 0 },
{ "no-signhide", no_argument, NULL, 0 },
{ "rd", required_argument, NULL, 0 },
{ "full-intra-search", no_argument, NULL, 0 },
{ "no-full-intra-search", no_argument, NULL, 0 },
{ "transform-skip", no_argument, NULL, 0 },
{ "no-transform-skip", no_argument, NULL, 0 },
{ "tr-skip-max-size", required_argument, NULL, 0 },
2020-12-18 15:40:47 +00:00
{ "mts", required_argument, NULL, 0 },
{ "no-mts", no_argument, NULL, 0 },
{ "tr-depth-intra", required_argument, NULL, 0 },
{ "me", required_argument, NULL, 0 },
{ "subme", required_argument, NULL, 0 },
{ "source-scan-type", required_argument, NULL, 0 },
{ "sar", required_argument, NULL, 0 },
{ "overscan", required_argument, NULL, 0 },
{ "videoformat", required_argument, NULL, 0 },
{ "range", required_argument, NULL, 0 },
{ "colorprim", required_argument, NULL, 0 },
{ "transfer", required_argument, NULL, 0 },
{ "colormatrix", required_argument, NULL, 0 },
{ "chromaloc", required_argument, NULL, 0 },
{ "aud", no_argument, NULL, 0 },
{ "no-aud", no_argument, NULL, 0 },
{ "cqmfile", required_argument, NULL, 0 },
{ "seek", required_argument, NULL, 0 },
{ "tiles", required_argument, NULL, 0 },
{ "tiles-width-split", required_argument, NULL, 0 },
{ "tiles-height-split", required_argument, NULL, 0 },
{ "wpp", no_argument, NULL, 0 },
{ "no-wpp", no_argument, NULL, 0 },
{ "owf", required_argument, NULL, 0 },
{ "slices", required_argument, NULL, 0 },
{ "threads", required_argument, NULL, 0 },
{ "cpuid", optional_argument, NULL, 0 },
{ "no-cpuid", no_argument, NULL, 0 },
{ "pu-depth-inter", required_argument, NULL, 0 },
{ "pu-depth-intra", required_argument, NULL, 0 },
{ "info", no_argument, NULL, 0 },
{ "no-info", no_argument, NULL, 0 },
{ "gop", required_argument, NULL, 0 },
{ "bipred", no_argument, NULL, 0 },
{ "no-bipred", no_argument, NULL, 0 },
{ "bitrate", required_argument, NULL, 0 },
{ "preset", required_argument, NULL, 0 },
{ "mv-rdo", no_argument, NULL, 0 },
{ "no-mv-rdo", no_argument, NULL, 0 },
{ "psnr", no_argument, NULL, 0 },
{ "no-psnr", no_argument, NULL, 0 },
{ "version", no_argument, NULL, 0 },
{ "help", no_argument, NULL, 0 },
{ "loop-input", no_argument, NULL, 0 },
2016-02-24 10:10:51 +00:00
{ "mv-constraint", required_argument, NULL, 0 },
{ "hash", required_argument, NULL, 0 },
{"cu-split-termination",required_argument, NULL, 0 },
2016-06-07 07:55:26 +00:00
{ "crypto", required_argument, NULL, 0 },
2017-08-28 15:15:13 +00:00
{ "key", required_argument, NULL, 0 },
{ "me-early-termination",required_argument, NULL, 0 },
{ "intra-rdo-et", no_argument, NULL, 0 },
{ "no-intra-rdo-et", no_argument, NULL, 0 },
2016-05-26 07:38:45 +00:00
{ "lossless", no_argument, NULL, 0 },
{ "no-lossless", no_argument, NULL, 0 },
{ "tmvp", no_argument, NULL, 0 },
{ "no-tmvp", no_argument, NULL, 0 },
2016-08-17 07:07:40 +00:00
{ "rdoq-skip", no_argument, NULL, 0 },
2016-09-11 08:40:16 +00:00
{ "no-rdoq-skip", no_argument, NULL, 0 },
{ "input-bitdepth", required_argument, NULL, 0 },
{ "input-format", required_argument, NULL, 0 },
{ "implicit-rdpcm", no_argument, NULL, 0 },
{ "no-implicit-rdpcm", no_argument, NULL, 0 },
{ "roi", required_argument, NULL, 0 },
{ "erp-aqp", no_argument, NULL, 0 },
{ "no-erp-aqp", no_argument, NULL, 0 },
2017-11-03 11:04:05 +00:00
{ "level", required_argument, NULL, 0 },
{ "force-level", required_argument, NULL, 0 },
2017-11-20 14:05:28 +00:00
{ "high-tier", no_argument, NULL, 0 },
{ "me-steps", required_argument, NULL, 0 },
{ "roi-file", required_argument, NULL, 0 },
{ "fast-residual-cost", required_argument, NULL, 0 },
2018-08-21 13:37:55 +00:00
{ "set-qp-in-cu", no_argument, NULL, 0 },
2018-10-02 06:55:30 +00:00
{ "open-gop", no_argument, NULL, 0 },
{ "no-open-gop", no_argument, NULL, 0 },
{ "vaq", required_argument, NULL, 0 },
2020-02-04 12:14:39 +00:00
{ "no-vaq", no_argument, NULL, 0 },
{ "scaling-list", required_argument, NULL, 0 },
{ "max-merge", required_argument, NULL, 0 },
2019-07-06 18:34:29 +00:00
{ "early-skip", no_argument, NULL, 0 },
{ "no-early-skip", no_argument, NULL, 0 },
{ "ml-pu-depth-intra", no_argument, NULL, 0 },
{ "partial-coding", required_argument, NULL, 0 },
2020-02-04 19:06:21 +00:00
{ "zero-coeff-rdo", no_argument, NULL, 0 },
{ "no-zero-coeff-rdo", no_argument, NULL, 0 },
{ "intra-qp-offset", required_argument, NULL, 0 },
{ "rc-algorithm", required_argument, NULL, 0 },
{ "intra-bits", no_argument, NULL, 0 },
{ "no-intra-bits", no_argument, NULL, 0 },
2019-12-06 07:51:04 +00:00
{ "clip-neighbour", no_argument, NULL, 0 },
{ "no-clip-neighbour", no_argument, NULL, 0 },
2020-09-07 11:04:48 +00:00
{ "input-file-format", required_argument, NULL, 0 },
{ "stats-file-prefix", required_argument, NULL, 0 },
{ "fast-coeff-table", required_argument, NULL, 0 },
{ "fastrd-sampling", no_argument, NULL, 0 },
{ "fastrd-accuracy-check", no_argument, NULL, 0 },
{ "fastrd-outdir", required_argument, NULL, 0 },
2021-04-23 07:19:43 +00:00
{ "chroma-qp-in", required_argument, NULL, 0 },
{ "chroma-qp-out", required_argument, NULL, 0 },
{ "mrl", no_argument, NULL, 0 },
{ "no-mrl", no_argument, NULL, 0 },
2021-12-15 14:25:08 +00:00
{ "mip", no_argument, NULL, 0 },
{ "no-mip", no_argument, NULL, 0 },
2021-08-16 12:39:14 +00:00
{ "jccr", no_argument, NULL, 0 },
{ "no-jccr", no_argument, NULL, 0 },
{ "amvr", no_argument, NULL, 0 },
{ "no-amvr", no_argument, NULL, 0 },
2021-11-17 09:33:57 +00:00
{ "cclm", no_argument, NULL, 0 },
{ "no-cclm", no_argument, NULL, 0 },
{ "combine-intra-cus", no_argument, NULL, 0 },
{ "no-combine-intra-cus", no_argument, NULL, 0 },
2022-03-17 12:48:08 +00:00
{ "force-inter", no_argument, NULL, 0 },
{ "no-force-inter", no_argument, NULL, 0 },
{0, 0, 0, 0}
};
/**
* \brief Try to detect resolution from file name automatically
*
* \param file_name file name to get dimensions from
* \param out_width detected width
* \param out_height detected height
* \return 1 if the resolution is set, 0 on fail
*/
static int select_input_res_auto(const char *file_name, int32_t *out_width, int32_t *out_height)
{
if (!file_name) return 0;
// Find the last delimiter char ( / or \ ). Hope the other kind is not used in the name.
// If delim is not found, set pointer to the beginning.
2015-07-31 15:44:36 +00:00
unsigned char* sub_str = (unsigned char*)MAX(strrchr(file_name, '/'), strrchr(file_name, '\\'));
if (!sub_str) sub_str = (unsigned char*)file_name;
int success = 0;
// Try if the substring starts with "<int>x<int>" without either of them being 0
do {
2015-07-31 15:44:36 +00:00
success = (sscanf((char*)sub_str, "%dx%d%*s", out_width, out_height) == 2);
success &= (*out_width > 0 && *out_height > 0);
// Move to the next char until a digit is found or the string ends
do{
++sub_str;
} while (*sub_str != 0 && !isdigit(*sub_str));
// Continue until "<int>x<int>" is found or the string ends
} while (*sub_str != 0 && !success);
return success;
}
2020-09-07 11:04:48 +00:00
/**
* \brief Try to detect file format from file name automatically
*
* \param file_name file name to get format from
* \return 0 (auto) if no format is detected, or id of the format
*/
static int detect_file_format(const char *file_name) {
if (!file_name) return 0;
// Find the last dot in the file name.
// If delim is not found, return 0
2020-09-07 12:39:31 +00:00
char* sub_str = (char*)strrchr(file_name, '.');
2020-09-07 11:04:48 +00:00
if (!sub_str) return 0;
if (strlen(sub_str) != 4) return 0;
char ending_lower_case[4];
for(int i = 0; i < 4; i++){
ending_lower_case[i] = tolower(sub_str[i]);
}
2020-09-07 11:04:48 +00:00
2022-04-28 11:18:09 +00:00
// UVG_FILE_FORMAT
if (strncmp(ending_lower_case, ".y4m", 4) == 0) return 1;
else if (strncmp(ending_lower_case, ".yuv", 4) == 0) return 2;
2020-09-07 11:04:48 +00:00
return 0;
}
/**
* \brief Parse command line arguments.
* \param argc Number of arguments
* \param argv Argument list
* \return Pointer to the parsed options, or NULL on failure.
*/
2022-04-28 11:18:09 +00:00
cmdline_opts_t* cmdline_opts_parse(const uvg_api *const api, int argc, char *argv[])
{
int ok = 1;
cmdline_opts_t *opts = calloc(1, sizeof(cmdline_opts_t));
if (!opts) {
ok = 0;
goto done;
}
opts->config = api->config_alloc();
if (!opts->config || !api->config_init(opts->config)) {
ok = 0;
goto done;
}
// Parse command line options
for (optind = 0;;) {
int long_options_index = -1;
int c = getopt_long(argc, argv, short_options, long_options, &long_options_index);
if (c == -1)
break;
if (long_options_index < 0) {
int i;
for (i = 0; long_options[i].name; i++)
if (long_options[i].val == c) {
long_options_index = i;
break;
}
if (long_options_index < 0) {
// getopt_long already printed an error message
ok = 0;
goto done;
}
}
const char* name = long_options[long_options_index].name;
if (!strcmp(name, "input")) {
if (opts->input) {
fprintf(stderr, "Input error: More than one input file given.\n");
ok = 0;
goto done;
}
opts->input = strdup(optarg);
} else if (!strcmp(name, "output")) {
if (opts->output) {
fprintf(stderr, "Input error: More than one output file given.\n");
ok = 0;
goto done;
}
opts->output = strdup(optarg);
} else if (!strcmp(name, "debug")) {
if (opts->debug) {
fprintf(stderr, "Input error: More than one debug output file given.\n");
ok = 0;
goto done;
}
opts->debug = strdup(optarg);
} else if (!strcmp(name, "seek")) {
opts->seek = atoi(optarg);
} else if (!strcmp(name, "frames")) {
opts->frames = atoi(optarg);
} else if (!strcmp(name, "version")) {
opts->version = true;
goto done;
} else if (!strcmp(name, "help")) {
opts->help = true;
goto done;
} else if (!strcmp(name, "loop-input")) {
opts->loop_input = true;
} else if (!api->config_parse(opts->config, name, optarg)) {
fprintf(stderr, "invalid argument: %s=%s\n", name, optarg);
ok = 0;
goto done;
}
}
// Check for extra arguments.
if (argc - optind > 0) {
fprintf(stderr, "Input error: Extra argument found: \"%s\"\n", argv[optind]);
ok = 0;
goto done;
}
// Check that the required files were defined
if (opts->input == NULL || opts->output == NULL) {
ok = 0;
goto done;
}
if (opts->config->vps_period < 0) {
// Disabling parameter sets is only possible when using Kvazaar as
// a library.
fprintf(stderr, "Input error: vps_period must be non-negative\n");
ok = 0;
goto done;
}
2020-09-07 11:04:48 +00:00
// Check the file name for format
2022-04-28 11:18:09 +00:00
if (opts->config->file_format == UVG_FORMAT_AUTO) {
2020-09-07 11:04:48 +00:00
opts->config->file_format = detect_file_format(opts->input);
}
// Set resolution automatically if necessary
2022-04-28 11:18:09 +00:00
if ((opts->config->file_format == UVG_FORMAT_AUTO || opts->config->file_format == UVG_FORMAT_YUV)
&& opts->config->width == 0 && opts->config->height == 0) {
ok = select_input_res_auto(opts->input, &opts->config->width, &opts->config->height);
goto done;
}
done:
if (!ok) {
cmdline_opts_free(api, opts);
opts = NULL;
}
return opts;
}
/**
* \brief Deallocate a cmdline_opts_t structure.
*/
2022-04-28 11:18:09 +00:00
void cmdline_opts_free(const uvg_api *const api, cmdline_opts_t *opts)
{
if (opts) {
FREE_POINTER(opts->input);
FREE_POINTER(opts->output);
FREE_POINTER(opts->debug);
api->config_destroy(opts->config);
opts->config = NULL;
}
FREE_POINTER(opts);
}
void print_usage(void)
{
fprintf(stdout,
"usage: -i and --input-res to set input, -o to set output\n"
" --help for more information\n");
}
void print_version(bool to_stderr)
{
fprintf(to_stderr ? stderr : stdout,
"uvg266 " VERSION_STRING " [" UVG_COMPILER_STRING "] " UVG_COMPILE_DATE "\n");
}
void print_help(void)
{
fprintf(stdout,
"Usage:\n"
"uvg266 -i <input> --input-res <width>x<height> -o <output>\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Required:\n"
" -i, --input <filename> : Input file\n"
" --input-res <res> : Input resolution [auto]\n"
" - auto: Detect from file name.\n"
" - <int>x<int>: width times height\n"
" -o, --output <filename> : Output file\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Presets:\n"
" --preset <preset> : Set options to a preset [medium]\n"
" - ultrafast, superfast, veryfast, faster,\n"
" fast, medium, slow, slower, veryslow\n"
" placebo\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Input:\n"
" -n, --frames <integer> : Number of frames to code [all]\n"
" --seek <integer> : First frame to code [0]\n"
" --input-fps <num>[/<denom>] : Frame rate of the input video [25]\n"
" --source-scan-type <string> : Source scan type [progressive]\n"
" - progressive: Progressive scan\n"
" - tff: Top field first\n"
" - bff: Bottom field first\n"
" --input-format <string> : P420 or P400 [P420]\n"
" --input-bitdepth <int> : 8-16 [8]\n"
" --loop-input : Re-read input file forever.\n"
" --input-file-format <string> : Input file format [auto]\n"
2020-09-07 11:04:48 +00:00
" - auto: Check the file ending for format\n"
" - y4m (skips frame headers)\n"
" - yuv\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Options:\n"
" --help : Print this help message and exit.\n"
" --version : Print version information and exit.\n"
" --(no-)aud : Use access unit delimiters. [disabled]\n"
" --debug <filename> : Output internal reconstruction.\n"
" --(no-)cpuid : Enable runtime CPU optimizations. [enabled]\n"
" --hash <string> : Decoded picture hash [checksum]\n"
" - none: 0 bytes\n"
" - checksum: 18 bytes\n"
" - md5: 56 bytes\n"
" --(no-)psnr : Calculate PSNR for frames. [enabled]\n"
" --(no-)info : Add encoder info SEI. [enabled]\n"
" --stats-file-prefix : A prefix used for stats files that include\n"
" bits, lambda, distortion, and qp for each ctu.\n"
" These are meant for debugging and are not\n"
" written unless the prefix is defined.\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Video structure:\n"
" -q, --qp <integer> : Quantization parameter [22]\n"
" -p, --period <integer> : Period of intra pictures [64]\n"
" - 0: Only first picture is intra.\n"
" - 1: All pictures are intra.\n"
" - N: Every Nth picture is intra.\n"
" --vps-period <integer> : How often the video parameter set is re-sent [0]\n"
" - 0: Only send VPS with the first frame.\n"
" - N: Send VPS with every Nth intra frame.\n"
" -r, --ref <integer> : Number of reference frames, in range 1..15 [4]\n"
2020-02-15 20:21:25 +00:00
" --gop <string> : GOP structure [lp-g4d3t1]\n"
" - 0: Disabled\n"
" - 8: B-frame pyramid of length 8\n"
" - 16: B-frame pyramid of length 16\n"
" - lp-<string>: Low-delay P/B-frame GOP\n"
" (e.g. lp-g8d4t2, see README)\n"
2020-03-31 10:19:05 +00:00
" --intra-qp-offset <int>: QP offset for intra frames [-51..51] [auto]\n"
" - N: Set QP offset to N.\n"
" - auto: Select offset automatically based\n"
2020-03-31 12:27:48 +00:00
" on GOP length.\n"
2018-10-02 06:55:30 +00:00
" --(no-)open-gop : Use open GOP configuration. [enabled]\n"
" --cqmfile <filename> : Read custom quantization matrices from a file.\n"
" --scaling-list <string>: Set scaling list mode. [off]\n"
" - off: Disable scaling lists.\n"
" - custom: use custom list (with --cqmfile).\n"
" - default: Use default lists.\n"
" --bitrate <integer> : Target bitrate [0]\n"
" - 0: Disable rate control.\n"
" - N: Target N bits per second.\n"
" --rc-algorithm <string>: Select used rc-algorithm. [lambda]\n"
" - lambda: rate control from:\n"
" DOI: 10.1109/TIP.2014.2336550 \n"
" - oba: DOI: 10.1109/TCSVT.2016.2589878\n"
" --(no-)intra-bits : Use Hadamard cost based allocation for intra\n"
" frames. Default on for gop 8 and off for lp-gop\n"
" --(no-)clip-neighbour : On oba based rate control whether to clip \n"
" lambda values to same frame's ctus or previous'.\n"
" Default on for RA GOPS and disabled for LP.\n"
" --(no-)lossless : Use lossless coding. [disabled]\n"
" --mv-constraint <string> : Constrain movement vectors. [none]\n"
" - none: No constraint\n"
" - frametile: Constrain within the tile.\n"
" - frametilemargin: Constrain even more.\n"
" --roi <filename> : Use a delta QP map for region of interest.\n"
" Reads an array of delta QP values from a file.\n"
" Text and binary files are supported and detected\n"
" from the file extension (.txt/.bin). If a known\n"
" extension is not found, the file is treated as\n"
" a text file. The file can include one or many\n"
" ROI frames each in the following format:\n"
" width and height of the QP delta map followed\n"
" by width * height delta QP values in raster\n"
" order. In binary format, width and height are\n"
" 32-bit integers whereas the delta QP values are\n"
" signed 8-bit values. The map can be of any size\n"
" and will be scaled to the video size. The file\n"
" reading will loop if end of the file is reached.\n"
" See roi.txt in the examples folder.\n"
2018-08-21 13:37:55 +00:00
" --set-qp-in-cu : Set QP at CU level keeping pic_init_qp_minus26.\n"
" in PPS and slice_qp_delta in slize header zero.\n"
" --(no-)erp-aqp : Use adaptive QP for 360 degree video with\n"
" equirectangular projection. [disabled]\n"
" --level <number> : Use the given HEVC level in the output and give\n"
" an error if level limits are exceeded. [6.2]\n"
" - 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6,\n"
" 6.1, 6.2\n"
" --force-level <number> : Same as --level but warnings instead of errors.\n"
" --high-tier : Used with --level. Use high tier bitrate limits\n"
" instead of the main tier limits during encoding.\n"
" High tier requires level 4 or higher.\n"
" --(no-)vaq <integer> : Enable variance adaptive quantization with given\n"
" strength, in range 1..20. Recommended: 5.\n"
" [disabled]\n"
2021-04-23 07:19:43 +00:00
" --chroma-qp-in : List of input values used for mapping the luma\n"
" QP into chroma qp. [17,27,32,44]\n"
" --chroma-qp-out : List of output values used for mapping the luma\n"
" QP into chroma qp. These two lists have to be\n"
" same length, start with same value, and can\n"
" contain maximum 16 or 36 - starting value\n"
" elements. [17,27,32,44]\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Compression tools:\n"
" --(no-)deblock <beta:tc> : Deblocking filter. [0:0]\n"
" - beta: Between -6 and 6\n"
" - tc: Between -6 and 6\n"
" --sao <string> : Sample Adaptive Offset [full]\n"
" - off: SAO disabled\n"
" - band: Band offset only\n"
" - edge: Edge offset only\n"
" - full: Full SAO\n"
" --alf <string> : Adaptive Loop Filter [off]\n"
" - off: ALF disabled\n"
2022-06-13 08:29:20 +00:00
" - no-cc: ALF enabled without cross component\n"
" refinement\n"
" - full: Full ALF\n"
" --(no-)rdoq : Rate-distortion optimized quantization [enabled]\n"
" --(no-)rdoq-skip : Skip RDOQ for 4x4 blocks. [disabled]\n"
" --(no-)signhide : Sign hiding [disabled]\n"
" --rd <integer> : Intra mode search complexity [0]\n"
" - 0: Skip intra if inter is good enough.\n"
" - 1: Rough intra mode search with SATD.\n"
" - 2: Refine intra mode search with SSE.\n"
" - 3: Enable intra chroma mode search.\n"
" - 4: Try all intra modes.\n"
" --(no-)mv-rdo : Rate-distortion optimized motion vector costs\n"
" [disabled]\n"
2020-02-04 19:06:21 +00:00
" --(no-)zero-coeff-rdo : If a CU is set inter, check if forcing zero\n"
2020-02-15 20:29:08 +00:00
" residual improves the RD cost. [enabled]\n"
" --(no-)full-intra-search : Try all intra modes during rough search.\n"
" [disabled]\n"
" --(no-)transform-skip : Try transform skip [disabled]\n"
" --tr-skip-max-size : Max log2 size of transform skip 2..5 [2]\n"
" --me <string> : Integer motion estimation algorithm [hexbs]\n"
" - hexbs: Hexagon Based Search\n"
" - tz: Test Zone Search\n"
" - full: Full Search\n"
" - full8, full16, full32, full64\n"
2017-12-12 12:45:01 +00:00
" - dia: Diamond Search\n"
" --me-steps <integer> : Motion estimation search step limit. Only\n"
" affects 'hexbs' and 'dia'. [-1]\n"
" --subme <integer> : Fractional pixel motion estimation level [4]\n"
" - 0: Integer motion estimation only\n"
" - 1: + 1/2-pixel horizontal and vertical\n"
" - 2: + 1/2-pixel diagonal\n"
" - 3: + 1/4-pixel horizontal and vertical\n"
" - 4: + 1/4-pixel diagonal\n"
" --pu-depth-inter <int>-<int> : Inter prediction units sizes [0-3]\n"
" - 0, 1, 2, 3: from 64x64 to 8x8\n"
2020-03-20 11:07:48 +00:00
" - Accepts a list of values separated by ','\n"
" for setting separate depths per GOP layer\n"
" (values can be omitted to use the first\n"
2020-03-20 11:27:07 +00:00
" value for the respective layer).\n"
" --pu-depth-intra <int>-<int> : Intra prediction units sizes [1-4]\n"
" - 0, 1, 2, 3, 4: from 64x64 to 4x4\n"
2020-03-20 11:07:48 +00:00
" - Accepts a list of values separated by ','\n"
" for setting separate depths per GOP layer\n"
" (values can be omitted to use the first\n"
2020-03-20 11:27:07 +00:00
" value for the respective layer).\n"
" --ml-pu-depth-intra : Predict the pu-depth-intra using machine\n"
" learning trees, overrides the\n"
" --pu-depth-intra parameter. [disabled]\n"
" --(no-)combine-intra-cus: Whether the encoder tries to code a cu\n"
" on lower depth even when search is not\n"
" performed on said depth. Should only\n"
" be disabled if cus absolutely must not\n"
" be larger than limited by the search.\n"
2022-06-13 08:29:20 +00:00
" [enabled]\n"
2022-03-17 12:48:08 +00:00
" --force-inter : Force the encoder to use inter always.\n"
" This is mostly for debugging and is not\n"
" guaranteed to produce sensible bitstream or\n"
2022-06-13 08:29:20 +00:00
" work at all. [disabled]\n"
" --tr-depth-intra <int> : Transform split depth for intra blocks [0]\n"
" --(no-)bipred : Bi-prediction [disabled]\n"
" --cu-split-termination <string> : CU split search termination [zero]\n"
" - off: Don't terminate early.\n"
" - zero: Terminate when residual is zero.\n"
" --me-early-termination <string> : Motion estimation termination [on]\n"
" - off: Don't terminate early.\n"
" - on: Terminate early.\n"
" - sensitive: Terminate even earlier.\n"
" --fast-residual-cost <int> : Skip CABAC cost for residual coefficients\n"
" when QP is below the limit. [0]\n"
2020-10-06 18:17:36 +00:00
" --fast-coeff-table <string> : Read custom weights for residual\n"
" coefficients from a file instead of using\n"
" defaults [default]\n"
2020-12-01 20:52:30 +00:00
" --fast-rd-sampling : Enable learning data sampling for fast coefficient\n"
" table generation\n"
" --fastrd-accuracy-check : Evaluate the accuracy of fast coefficient\n"
" prediction\n"
" --fastrd-outdir : Directory to which to output sampled data or accuracy\n"
" data, into <fastrd-outdir>/0.txt to 50.txt, one file\n"
" for each QP that blocks were estimated on\n"
" --(no-)intra-rdo-et : Check intra modes in rdo stage only until\n"
" a zero coefficient CU is found. [disabled]\n"
2019-07-06 18:34:29 +00:00
" --(no-)early-skip : Try to find skip cu from merge candidates.\n"
" Perform no further search if skip is found.\n"
2022-06-13 08:29:20 +00:00
" For rd = 0..1: Try the first candidate.\n"
" For rd = 2.. : Try the best candidate based\n"
" on luma satd cost. [enabled]\n"
2021-11-23 06:46:06 +00:00
" --max-merge <integer> : Maximum number of merge candidates, 1..6 [6]\n"
" --(no-)implicit-rdpcm : Implicit residual DPCM. Currently only supported\n"
" with lossless coding. [disabled]\n"
" --(no-)tmvp : Temporal motion vector prediction [enabled]\n"
" --(no-)mrl : Enable use of multiple reference lines in intra\n"
" predictions.\n"
" --(no-)mip : Enable matrix weighted intra prediction.\n"
" --mts <string> : Multiple Transform Selection [off].\n"
" (Currently only implemented for intra\n"
" and has effect only when rd >= 2)\n"
" - off: MTS disabled\n"
" - intra: MTS applied only for intra blocks.\n"
" - inter: MTS applied only for inter blocks.\n"
2022-06-13 08:29:20 +00:00
" - both: MTS applied for both intra and inter\n"
" blocks.\n"
" - implicit: uses implicit MTS. Applies DST7\n"
" instead of DCT2 to certain intra\n
" blocks.\n"
" --(no-)jccr : Joint coding of chroma residual.\n"
2022-06-13 08:29:20 +00:00
" Requires rdo >= 2. [disabled]\n"
2021-11-17 09:33:57 +00:00
" --(no-)cclm : Cross component linear model. \n"
" Extra chroma prediction modes that are formed\n"
" via linear transformation from the luma\n"
2022-06-13 08:29:20 +00:00
" prediction. Requires rdo >= 3. [disabled\n"
" --(no-)amvr : Adaptive Motion Vector Resolution.\n"
2022-06-13 08:29:20 +00:00
" Code some MVs with reduced resolution [disabled]\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Parallel processing:\n"
" --threads <integer> : Number of threads to use [auto]\n"
" - 0: Process everything with main thread.\n"
" - N: Use N threads for encoding.\n"
" - auto: Select automatically.\n"
" --owf <integer> : Frame-level parallelism [auto]\n"
" - N: Process N+1 frames at a time.\n"
" - auto: Select automatically.\n"
" --(no-)wpp : Wavefront parallel processing. [enabled]\n"
" Enabling tiles automatically disables WPP.\n"
" To enable WPP with tiles, re-enable it after\n"
" enabling tiles. Enabling wpp with tiles is,\n"
" however, an experimental feature since it is\n"
" not supported in any HEVC profile.\n"
" --tiles <int>x<int> : Split picture into width x height uniform tiles.\n"
" --tiles-width-split <string>|u<int> :\n"
" - <string>: A comma-separated list of tile\n"
" column pixel coordinates.\n"
" - u<int>: Number of tile columns of uniform\n"
" width.\n"
" --tiles-height-split <string>|u<int> :\n"
2022-06-13 08:29:20 +00:00
" - <string>: A comma-separated list of tile\n"
" row column pixel coordinates.\n"
" - u<int>: Number of tile rows of uniform\n"
" height.\n"
" --slices <string> : Control how slices are used.\n"
" - tiles: Put tiles in independent slices.\n"
" - wpp: Put rows in dependent slices.\n"
" - tiles+wpp: Do both.\n"
" --partial-coding <x-offset>!<y-offset>!<slice-width>!<slice-height>\n"
" : Encode partial frame.\n"
" Parts must be merged to form a valid bitstream.\n"
" X and Y are CTU offsets.\n"
" Slice width and height must be divisible by CTU\n"
" in pixels unless it is the last CTU row/column.\n"
" This parameter is used by kvaShare.\n"
"\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Video Usability Information:\n"
" --sar <width:height> : Specify sample aspect ratio\n"
" --overscan <string> : Specify crop overscan setting [undef]\n"
" - undef, show, crop\n"
" --videoformat <string> : Specify video format [undef]\n"
2017-12-07 08:47:44 +00:00
" - undef, component, pal, ntsc, secam, mac\n"
" --range <string> : Specify color range [tv]\n"
" - tv, pc\n"
" --colorprim <string> : Specify color primaries [undef]\n"
" - undef, bt709, bt470m, bt470bg,\n"
" smpte170m, smpte240m, film, bt2020\n"
" --transfer <string> : Specify transfer characteristics [undef]\n"
" - undef, bt709, bt470m, bt470bg,\n"
" smpte170m, smpte240m, linear, log100,\n"
" log316, iec61966-2-4, bt1361e,\n"
" iec61966-2-1, bt2020-10, bt2020-12\n"
" --colormatrix <string> : Specify color matrix setting [undef]\n"
" - undef, bt709, fcc, bt470bg, smpte170m,\n"
" smpte240m, GBR, YCgCo, bt2020nc, bt2020c\n"
" --chromaloc <integer> : Specify chroma sample location (0 to 5) [0]\n"
2017-12-07 08:47:44 +00:00
/* Word wrap to this width to stay under 80 characters (including ") *************/
);
}
2022-04-28 11:18:09 +00:00
void print_frame_info(const uvg_frame_info *const info,
const double frame_psnr[3],
2017-07-19 07:38:37 +00:00
const uint32_t bytes,
2019-11-04 15:08:07 +00:00
const bool print_psnr,
const double avg_qp)
{
fprintf(stderr, "POC %4d QP %2d AVG QP %.1f (%c-frame) %10d bits",
info->poc,
info->qp,
avg_qp,
"BPI"[info->slice_type % 3],
2017-07-19 07:38:37 +00:00
bytes << 3);
2017-07-19 07:38:37 +00:00
if (print_psnr) {
fprintf(stderr, " PSNR Y %2.4f U %2.4f V %2.4f",
frame_psnr[0], frame_psnr[1], frame_psnr[2]);
}
2022-04-28 11:18:09 +00:00
if (info->slice_type != UVG_SLICE_I) {
// Print reference picture lists
fprintf(stderr, " [L0 ");
for (int j = 0; j < info->ref_list_len[0]; j++) {
fprintf(stderr, "%d ", info->ref_list[0][j]);
}
fprintf(stderr, "] [L1 ");
for (int j = 0; j < info->ref_list_len[1]; j++) {
fprintf(stderr, "%d ", info->ref_list[1][j]);
}
fprintf(stderr, "]");
}
fprintf(stderr, "\n");
}