.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH BENCHMARK_XL "1" "June 2023" "benchmark_xl 0.9.0~git20230623.689da0f" "User Commands"
.SH NAME
benchmark_xl - benchmark_xl
.SH SYNOPSIS
.B benchmark_xl
[\fI\,OPTIONS\/\fR...]
.SH DESCRIPTION
benchmark_xl v0.9.0 [AVX2,SSE4,SSSE3,Unknown]
.HP
\fB\-\-input=\fR<string>
.IP
File or file pattern matching input files.
.HP
\fB\-\-codec=\fR<string>
.IP
Comma separated list of image codec descriptions to benchmark.
.HP
\fB\-\-print_details\fR
.HP
\fB\-\-noprint_details\fR
.IP
Prints size and distortion for each image. Not safe for concurrent benchmark runs.
.HP
\fB\-\-print_details_csv\fR
.HP
\fB\-\-noprint_details_csv\fR
.IP
When print_details is used, print as CSV.
.HP
\fB\-\-extra_metrics=\fR<string>
.IP
Extra metrics to be computed. Only displayed with \fB\-\-print_details\fR or \fB\-\-print_details_csv\fR. Comma\-separated list of NAME:COMMAND pairs; COMMAND is invoked with the original image as the first argument, the decompressed image as a second argument, and the name of the file where to write the metric value (as a single floating point number) as the third argument.
.HP
\fB\-\-print_more_stats\fR
.HP
\fB\-\-noprint_more_stats\fR
.IP
Prints codec\-specific stats. Not safe for concurrent benchmark runs.
.HP
\fB\-\-print_distance_percentiles\fR
.HP
\fB\-\-noprint_distance_percentiles\fR
.IP
Prints distance percentiles for the corpus. Not safe for concurrent benchmark runs.
.HP
\fB\-\-silent_errors\fR
.HP
\fB\-\-nosilent_errors\fR
.IP
If true, doesn't print error messages on compression or decompression errors. Errors counts are still visible in the 'Errors' column of the result table. Please note that depending depending on the JXL build settings, error messages and asserts from within the codec may be printed irrespective of this flag anyway, use release build to ensure no messages.
.HP
\fB\-\-save_compressed\fR
.HP
\fB\-\-nosave_compressed\fR
.IP
Saves the compressed files for each input image and each codec.
.HP
\fB\-\-save_decompressed\fR
.HP
\fB\-\-nosave_decompressed\fR
.IP
Saves the decompressed files as PNG for each input image and each codec.
.HP
\fB\-\-output_extension=\fR<string>
.IP
Extension (starting with dot) to use for saving output images.
.HP
\fB\-\-output_description=\fR<string>
.TP
Color encoding (see ParseDescription; e.g. RGB_D65_SRG_Rel_709) for saving output images,
defaults to sRGB.
.HP
\fB\-\-intensity_target=\fR<scalar>
.IP
Intended viewing intensity target in nits. Defaults to 255 for SDR images, 4000 for HDR images (when the input image uses PQ or HLG transfer function)
.HP
\fB\-\-dec\-hints=\fR<string>
.IP
Color encoding hints for the input images to encoder. Comma separated key=value pairs. The key color_space indicates ColorEncoding (see ParseDescription; e.g. RGB_D65_SRG_Rel_709) for input images without color encoding (such as PNM)
.HP
\fB\-\-override_bitdepth=\fR<unsigned>
.IP
If nonzero, store the given bit depth in the JPEG XL file metadata (1\-32), instead of using the bit depth from the original input image.
.HP
\fB\-\-mul_output=\fR<scalar>
.IP
If nonzero, multiplies linear sRGB by this and clamps to 255
.HP
\fB\-\-save_heatmap\fR
.HP
\fB\-\-nosave_heatmap\fR
.IP
Saves the heatmap images.
.HP
\fB\-\-heatmap_good=\fR<scalar>
.IP
If greater than zero, use this as the good threshold for creating heatmap images.
.HP
\fB\-\-heatmap_bad=\fR<scalar>
.IP
If greater than zero, use this as the bad threshold for creating heatmap images.
.HP
\fB\-\-write_html_report\fR
.HP
\fB\-\-nowrite_html_report\fR
.IP
Creates an html report with original and compressed images.
.HP
\fB\-\-html_report_self_contained\fR
.HP
\fB\-\-nohtml_report_self_contained\fR
.IP
Base64\-encode the images in the HTML report rather than use external file names. May cause very large HTML data size.
.HP
\fB\-\-html_report_use_decompressed\fR
.HP
\fB\-\-nohtml_report_use_decompressed\fR
.IP
Show the compressed image as decompressed to \fB\-\-output_extension\fR.
.HP
\fB\-\-html_report_add_heatmap\fR
.HP
\fB\-\-nohtml_report_add_heatmap\fR
.IP
Add heatmaps to the image comparisons.
.HP
\fB\-\-markdown\fR
.HP
\fB\-\-nomarkdown\fR
.IP
Adds formatting around ASCII table to render correctly in Markdown based interfaces
.HP
\fB\-\-more_columns\fR
.HP
\fB\-\-nomore_columns\fR
.IP
Print extra columns in the table
.HP
\fB\-\-originals_url=\fR<string>
.IP
Url prefix to serve original images from in the html report.
.HP
\fB\-\-output_dir=\fR<string>
.IP
If not empty, save compressed and decompressed images here.
.HP
\fB\-\-num_threads=\fR<integer>
.IP
The number of threads for concurrent benchmarking. Defaults to 1 thread per CPU core (if negative).
.HP
\fB\-\-inner_threads=\fR<integer>
.IP
The number of extra threads per task. Defaults to occupy cores (if negative).
.HP
\fB\-\-encode_reps=\fR<unsigned>
.IP
How many times to encode (>1 for more precise measurements). Defaults to 1.
.HP
\fB\-\-decode_reps=\fR<unsigned>
.IP
How many times to decode (>1 for more precise measurements). Defaults to 1.
.HP
\fB\-\-sample_tmp_dir=\fR<string>
.IP
Directory to put samples from input images.
.HP
\fB\-\-num_samples=\fR<integer>
.IP
How many sample areas to take.
.HP
\fB\-\-sample_dimensions=\fR<integer>
.IP
How big areas to sample from the input.
.HP
\fB\-\-error_pnorm=\fR<scalar>
.IP
smallest p norm for pooling butteraugli values
.HP
\fB\-\-show_progress\fR
.HP
\fB\-\-noshow_progress\fR
.IP
Show activity dots per completed file during benchmark.
.HP
\fB\-\-skip_butteraugli\fR
.HP
\fB\-\-noskip_butteraugli\fR
.IP
If true, doesn't compute distance metrics, only compression and decompression speed and size. Distance numbers shown in the table are invalid.
.HP
\fB\-\-decode_only\fR
.HP
\fB\-\-nodecode_only\fR
.IP
If true, only decodes, and the input files must be compressed with a compatible format for the given codec(s). Only measures decompression speed and sizes, and can only use a single set of compatible decoders. Distance numbers and compression speeds shown in the table are invalid.
.HP
\fB\-\-custom_codec_extension=\fR<string>
.IP
Converts input and output of codec to this file type (default: png).
.HP
\fB\-\-custom_codec_colorspace=\fR<string>
.IP
If not empty, converts input and output of codec to this colorspace.
.HP
\fB\-\-custom_codec_quiet\fR
.HP
\fB\-\-nocustom_codec_quiet\fR
.IP
Whether stdin and stdout of custom codec should be shown.
.HP
\fB\-\-hf_asymmetry=\fR<scalar>
.IP
Multiplier for weighting HF artefacts more than features being smoothed out. 1.0 means no HF asymmetry. 0.3 is a good value to start exploring for asymmetry.
.HP
\fB\-\-xmul=\fR<scalar>
.IP
Multiplier for the difference in X channel in Butteraugli.
.HP
\fB\-\-quant_bias=\fR<scalar>
.IP
Bias border pixels during quantization by this ratio.
.HP
\fB\-\-use_ac_strategy\fR
.HP
\fB\-\-nouse_ac_strategy\fR
.IP
If true, AC strategy will be used.
.HP
\fB\-\-qprogressive\fR
.HP
\fB\-\-noqprogressive\fR
.IP
Enable quantized progressive mode for AC.
.HP
\fB\-\-progressive\fR
.HP
\fB\-\-noprogressive\fR
.IP
Enable progressive mode for AC.
.HP
\fB\-\-progressive_dc=\fR<integer>
.IP
Enable progressive mode for DC.
.HP
\fB\-\-noise\fR=\fI\,0\/\fR|1
.IP
Enable(1)/disable(0) noise generation.
.HP
\fB\-\-dots\fR=\fI\,0\/\fR|1
.IP
Enable(1)/disable(0) dots generation.
.HP
\fB\-\-patches\fR=\fI\,0\/\fR|1
.IP
Enable(1)/disable(0) patch dictionary.
.HP
\fB\-\-log_search_state\fR
.HP
\fB\-\-nolog_search_state\fR
.IP
Print out debug info for tortoise mode AQ loop.
.HP
\fB\-\-debug_image_dir=\fR<string>
.IP
If not empty, saves debug images for each input image and each codec that provides it to this directory.
.HP
\fB\-\-qtables=\fR<string>
.IP
Custom base quantization tables.
.HP
\fB\-\-search_q_start=\fR<scalar>
.IP
Starting quality for quality\-to\-target search
.HP
\fB\-\-search_q_min=\fR<scalar>
.IP
Minimum quality for quality\-to\-target search
.HP
\fB\-\-search_q_max=\fR<scalar>
.IP
Maximum quality for quality\-to\-target search
.HP
\fB\-\-search_d_min=\fR<scalar>
.IP
Minimum distance for quality\-to\-target search
.HP
\fB\-\-search_d_max=\fR<scalar>
.IP
Maximum distance for quality\-to\-target search
.HP
\fB\-\-search_tolerance=\fR<scalar>
.IP
Percentage value, if quality\-to\-target search result relative error is within this, search stops.
.HP
\fB\-\-search_q_precision=\fR<scalar>
.IP
If last quality change in quality\-to\-target search is within this value, search stops.
.HP
\fB\-\-search_first_iter_slope=\fR<scalar>
.IP
Slope of first extrapolation step in quality\-to\-target search.
.HP
\fB\-\-search_max_iters=\fR<integer>
.IP
Maximum search steps in quality\-to\-target search.
.HP
\fB\-\-avif_chroma_subsampling\fR=\fI\,444\/\fR/422/420/400
.IP
default AVIF chroma subsampling (default: 444).
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Prints this help message. All options are shown above.
.SH AUTHOR
This manual page was written by Mathieu Malaterre <malat@debian.org> for the
Debian GNU/Linux system (but may be used by others).