.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. .TH AOMENC "1" "August 2023" "aomenc 3.7.0~rc3" "User Commands" .SH NAME aomenc \- AOMedia Project AV1 Encoder .SH SYNOPSIS .B aomenc \fI\, -o dst_filename src_filename\/\fR .SH OPTIONS .TP \fB\-\-help\fR Show usage options and exit .TP \fB\-c\fR , \fB\-\-cfg=\fR Config file to use .TP \fB\-D\fR, \fB\-\-debug\fR Debug mode (makes output deterministic) .TP \fB\-o\fR , \fB\-\-output=\fR Output filename .TP \fB\-\-codec=\fR Codec to use .TP \fB\-p\fR , \fB\-\-passes=\fR Number of passes (1/2/3) .TP \fB\-\-pass=\fR Pass to execute (1/2/3) .TP \fB\-\-fpf=\fR First pass statistics file name .TP \fB\-\-limit=\fR Stop encoding after n input frames .TP \fB\-\-skip=\fR Skip the first n input frames .TP \fB\-\-good\fR Use Good Quality Deadline .TP \fB\-\-rt\fR Use Realtime Quality Deadline .TP \fB\-\-allintra\fR Use all intra mode .TP \fB\-q\fR, \fB\-\-quiet\fR Do not print encode progress .TP \fB\-v\fR, \fB\-\-verbose\fR Show encoder parameters .TP \fB\-\-psnr=\fR Show PSNR in status line (0: Disable PSNR status line display, 1: PSNR calculated using input bit\-depth (default), 2: PSNR calculated using stream bit\-depth); takes default option when arguments are not specified .TP \fB\-\-webm\fR Output WebM (default when WebM IO is enabled) .TP \fB\-\-ivf\fR Output IVF .TP \fB\-\-obu\fR Output OBU .TP \fB\-\-q\-hist=\fR Show quantizer histogram (n\-buckets) .TP \fB\-\-rate\-hist=\fR Show rate histogram (n\-buckets) .TP \fB\-\-disable\-warnings\fR Disable warnings about potentially incorrect encode settings .TP \fB\-y\fR, \fB\-\-disable\-warning\-prompt\fR Display warnings, but do not prompt user to continue .TP \fB\-\-test\-decode=\fR Test encode/decode mismatch .IP off, fatal, warn .SS "Encoder Global Options:" .TP \fB\-\-nv12\fR Input file is NV12 .TP \fB\-\-yv12\fR Input file is YV12 .TP \fB\-\-i420\fR Input file is I420 (default) .TP \fB\-\-i422\fR Input file is I422 .TP \fB\-\-i444\fR Input file is I444 .TP \fB\-u\fR , \fB\-\-usage=\fR Usage profile number to use (0: good, 1: rt, 2: allintra) .TP \fB\-t\fR , \fB\-\-threads=\fR Max number of threads to use .TP \fB\-\-profile=\fR Bitstream profile number to use .TP \fB\-w\fR , \fB\-\-width=\fR Frame width .TP \fB\-h\fR , \fB\-\-height=\fR Frame height .TP \fB\-\-forced_max_frame_width=\fR Maximum frame width value to force .TP \fB\-\-forced_max_frame_height=\fR Maximum frame height value to force .TP \fB\-\-stereo\-mode=\fR Stereo 3D video format .IP mono, left\-right, bottom\-top, top\-bottom, right\-left .TP \fB\-\-timebase=\fR Output timestamp precision (fractional seconds) .TP \fB\-\-fps=\fR Stream frame rate (rate/scale) .TP \fB\-\-global\-error\-resilient=\fR Enable global error resiliency features .TP \fB\-b\fR , \fB\-\-bit\-depth=\fR Bit depth for codec 8, 10, 12 .TP \fB\-\-input\-bit\-depth=\fR Bit depth of input .TP \fB\-\-lag\-in\-frames=\fR Max number of frames to lag .TP \fB\-\-large\-scale\-tile=\fR Large scale tile coding (0: off (default), 1: on (ivf output only)) .TP \fB\-\-monochrome\fR Monochrome video (no chroma planes) .TP \fB\-\-full\-still\-picture\-hdr\fR Use full header for still picture .TP \fB\-\-use\-16bit\-internal\fR Force use of 16\-bit pipeline .TP \fB\-\-annexb=\fR Save as Annex\-B .SS "Rate Control Options:" .TP \fB\-\-drop\-frame=\fR Temporal resampling threshold (buf %) .TP \fB\-\-resize\-mode=\fR Frame resize mode (0: off (default), 1: fixed, 2: random, 3: dynamic) .TP \fB\-\-resize\-denominator=\fR Frame resize denominator .TP \fB\-\-resize\-kf\-denominator=\fR Frame resize keyframe denominator .TP \fB\-\-superres\-mode=\fR Frame super\-resolution mode (0: disabled (default), 1: fixed, 2: random, 3: qthresh, 4: auto) .TP \fB\-\-superres\-denominator=\fR Frame super\-resolution denominator .TP \fB\-\-superres\-kf\-denominator=\fR Frame super\-resolution keyframe denominator .TP \fB\-\-superres\-qthresh=\fR Frame super\-resolution qindex threshold .IP \fB\-\-superres\-kf\-qthresh=\fR Frame super\-resolution keyframe qindex threshold \fB\-\-end\-usage=\fR Rate control mode .IP vbr, cbr, cq, q .TP \fB\-\-target\-bitrate=\fR Bitrate (kbps) .TP \fB\-\-min\-q=\fR Minimum (best) quantizer .TP \fB\-\-max\-q=\fR Maximum (worst) quantizer .TP \fB\-\-undershoot\-pct=\fR Datarate undershoot (min) target (%) .TP \fB\-\-overshoot\-pct=\fR Datarate overshoot (max) target (%) .TP \fB\-\-buf\-sz=\fR Client buffer size (ms) .TP \fB\-\-buf\-initial\-sz=\fR Client initial buffer size (ms) .TP \fB\-\-buf\-optimal\-sz=\fR Client optimal buffer size (ms) .TP \fB\-\-bias\-pct=\fR CBR/VBR bias (0=CBR, 100=VBR) .TP \fB\-\-minsection\-pct=\fR GOP min bitrate (% of target) .TP \fB\-\-maxsection\-pct=\fR GOP max bitrate (% of target) .SS "Keyframe Placement Options:" .TP \fB\-\-enable\-fwd\-kf=\fR Enable forward reference keyframes .TP \fB\-\-kf\-min\-dist=\fR Minimum keyframe interval (frames) .TP \fB\-\-kf\-max\-dist=\fR Maximum keyframe interval (frames) .TP \fB\-\-disable\-kf\fR Disable keyframe placement .TP \fB\-\-sframe\-dist=\fR S\-Frame interval (frames) .TP \fB\-\-sframe\-mode=\fR S\-Frame insertion mode (1..2) .SS "AV1 Specific Options:" .TP \fB\-\-cpu\-used=\fR Speed setting (0..6 in good mode, 5..10 in realtime mode, 0..9 in all intra mode) .TP \fB\-\-auto\-alt\-ref=\fR Enable automatic alt reference frames .TP \fB\-\-sharpness=\fR Bias towards block sharpness in rate\-distortion optimization of transform coefficients (0..7), default is 0 .TP \fB\-\-static\-thresh=\fR Motion detection threshold .TP \fB\-\-row\-mt=\fR Enable row based multi\-threading (0: off, 1: on (default)) .TP \fB\-\-fp\-mt=\fR Enable frame parallel multi\-threading (0: off (default), 1: on) .TP \fB\-\-tile\-columns=\fR Number of tile columns to use, log2 .TP \fB\-\-tile\-rows=\fR Number of tile rows to use, log2 .TP \fB\-\-enable\-tpl\-model=\fR RDO based on frame temporal dependency (0: off, 1: backward source based); required for deltaq mode .TP \fB\-\-enable\-keyframe\-filtering=\fR Apply temporal filtering on key frame (0: no filter, 1: filter without overlay (default), 2: filter with overlay \- experimental, may break random access in players) .TP \fB\-\-arnr\-maxframes=\fR AltRef max frames (0..15) .TP \fB\-\-arnr\-strength=\fR AltRef filter strength (0..6) .TP \fB\-\-tune=\fR Distortion metric tuned with .IP psnr, ssim, vmaf_with_preprocessing, vmaf_without_preprocessing, vmaf, vmaf_neg, butteraugli, vmaf_saliency_map .TP \fB\-\-cq\-level=\fR Constant/Constrained Quality level .TP \fB\-\-max\-intra\-rate=\fR Max I\-frame bitrate (pct) .TP \fB\-\-max\-inter\-rate=\fR Max P\-frame bitrate (pct) .TP \fB\-\-gf\-cbr\-boost=\fR Boost for Golden Frame in CBR mode (pct) .TP \fB\-\-lossless=\fR Lossless mode (0: false (default), 1: true) .TP \fB\-\-enable\-cdef=\fR Enable the constrained directional enhancement filter (0: false, 1: true (default), 2: disable for non\-reference frames) .TP \fB\-\-enable\-restoration=\fR Enable the loop restoration filter (0: false (default in realtime mode), 1: true (default in non\-realtime mode)) .TP \fB\-\-enable\-rect\-partitions=\fR Enable rectangular partitions (0: false, 1: true (default)) .TP \fB\-\-enable\-ab\-partitions=\fR Enable ab partitions (0: false, 1: true (default)) .TP \fB\-\-enable\-1to4\-partitions=\fR Enable 1:4 and 4:1 partitions (0: false, 1: true (default)) .TP \fB\-\-min\-partition\-size=\fR Set min partition size (4:4x4, 8:8x8, 16:16x16, 32:32x32, 64:64x64, 128:128x128); with 4k+ resolutions or higher speed settings, min partition size will have a minimum of 8 .TP \fB\-\-max\-partition\-size=\fR Set max partition size (4:4x4, 8:8x8, 16:16x16, 32:32x32, 64:64x64, 128:128x128) .TP \fB\-\-enable\-dual\-filter=\fR Enable dual filter (0: false, 1: true (default)) .TP \fB\-\-enable\-chroma\-deltaq=\fR Enable chroma delta quant (0: false (default), 1: true) .TP \fB\-\-enable\-intra\-edge\-filter=\fR Enable intra edge filtering (0: false, 1: true (default)) .TP \fB\-\-enable\-order\-hint=\fR Enable order hint (0: false, 1: true (default)) .TP \fB\-\-enable\-tx64=\fR Enable 64\-pt transform (0: false, 1: true (default)) .TP \fB\-\-enable\-flip\-idtx=\fR Enable extended transform type (0: false, 1: true (default)) including FLIPADST_DCT, DCT_FLIPADST, FLIPADST_FLIPADST, ADST_FLIPADST, FLIPADST_ADST, IDTX, V_DCT, H_DCT, V_ADST, H_ADST, V_FLIPADST, H_FLIPADST .TP \fB\-\-enable\-rect\-tx=\fR Enable rectangular transform (0: false, 1: true (default)) .TP \fB\-\-enable\-dist\-wtd\-comp=\fR Enable distance\-weighted compound (0: false, 1: true (default)) .TP \fB\-\-enable\-masked\-comp=\fR Enable masked (wedge/diff\-wtd) compound (0: false, 1: true (default)) .TP \fB\-\-enable\-onesided\-comp=\fR Enable one sided compound (0: false, 1: true (default)) .TP \fB\-\-enable\-interintra\-comp=\fR Enable interintra compound (0: false, 1: true (default)) .TP \fB\-\-enable\-smooth\-interintra=\fR Enable smooth interintra mode (0: false, 1: true (default)) .TP \fB\-\-enable\-diff\-wtd\-comp=\fR Enable difference\-weighted compound (0: false, 1: true (default)) .TP \fB\-\-enable\-interinter\-wedge=\fR Enable interinter wedge compound (0: false, 1: true (default)) .TP \fB\-\-enable\-interintra\-wedge=\fR Enable interintra wedge compound (0: false, 1: true (default)) .TP \fB\-\-enable\-global\-motion=\fR Enable global motion (0: false, 1: true (default)) .TP \fB\-\-enable\-warped\-motion=\fR Enable local warped motion (0: false, 1: true (default)) .IP \fB\-\-enable\-filter\-intra=\fR Enable filter intra prediction mode (0: false, 1: true (default)) \fB\-\-enable\-smooth\-intra=\fR Enable smooth intra prediction modes (0: false, 1: true (default)) \fB\-\-enable\-paeth\-intra=\fR Enable Paeth intra prediction mode (0: false, 1: true (default)) \fB\-\-enable\-cfl\-intra=\fR Enable chroma from luma intra prediction mode (0: false, 1: true (default)) \fB\-\-enable\-diagonal\-intra=\fR .IP Enable diagonal (D45 to D203) intra prediction modes, which are a subset of directional modes; has no effect if enable\-directional\-intra is 0 (0: false, 1: true (default)) .TP \fB\-\-force\-video\-mode=\fR Force video mode even for a single frame (0: false (default), 1: true) .TP \fB\-\-enable\-obmc=\fR Enable OBMC (0: false, 1: true (default)) .TP \fB\-\-enable\-overlay=\fR Enable coding overlay frames (0: false, 1: true (default)) .TP \fB\-\-enable\-palette=\fR Enable palette prediction mode (0: false, 1: true (default)) .TP \fB\-\-enable\-intrabc=\fR Enable intra block copy prediction mode (0: false, 1: true (default)) .TP \fB\-\-enable\-angle\-delta=\fR Enable intra angle delta (0: false, 1: true (default)) .TP \fB\-\-disable\-trellis\-quant=\fR Disable trellis optimization of quantized coefficients (0: false 1: true 2: true for rd search 3: true for estimate yrd search (default)) .TP \fB\-\-enable\-qm=\fR Enable quantisation matrices (0: false (default), 1: true) .TP \fB\-\-qm\-min=\fR Min quant matrix flatness (0..15), default is 8 .TP \fB\-\-qm\-max=\fR Max quant matrix flatness (0..15), default is 15 .IP \fB\-\-reduced\-tx\-type\-set=\fR Use reduced set of transform types \fB\-\-use\-intra\-dct\-only=\fR Use DCT only for INTRA modes \fB\-\-use\-inter\-dct\-only=\fR Use DCT only for INTER modes \fB\-\-use\-intra\-default\-tx\-only=\fR .IP Use Default\-transform only for INTRA modes .TP \fB\-\-quant\-b\-adapt=\fR Use adaptive quantize_b .IP \fB\-\-coeff\-cost\-upd\-freq=\fR Update freq for coeff costs. 0: SB, 1: SB Row per Tile, 2: Tile, 3: Off \fB\-\-mode\-cost\-upd\-freq=\fR Update freq for mode costs. 0: SB, 1: SB Row per Tile, 2: Tile, 3: Off \fB\-\-mv\-cost\-upd\-freq=\fR Update freq for mv costs. 0: SB, 1: SB Row per Tile, 2: Tile, 3: Off \fB\-\-frame\-parallel=\fR Enable frame parallel decodability features (0: false (default), 1: true) \fB\-\-error\-resilient=\fR Enable error resilient features (0: false (default), 1: true) \fB\-\-aq\-mode=\fR Adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3: cyclic refresh) \fB\-\-deltaq\-mode=\fR Delta qindex mode (0: off, 1: deltaq objective (default), 2: deltaq placeholder, 3: key frame visual quality, 4: user rating based visual quality optimization); requires \fB\-\-enable\-tpl\-model\fR=\fI\,1\/\fR \fB\-\-deltaq\-strength=\fR Deltaq strength for \fB\-\-deltaq\-mode\fR=\fI\,4\/\fR (%) \fB\-\-delta\-lf\-mode=\fR Enable delta\-lf\-mode (0: off (default), 1: on) \fB\-\-frame\-boost=\fR Enable frame periodic boost (0: off (default), 1: on) \fB\-\-noise\-sensitivity=\fR Noise sensitivity (frames to blur) \fB\-\-tune\-content=\fR Tune content type .IP default, screen, film .TP \fB\-\-cdf\-update\-mode=\fR CDF update mode for entropy coding (0: no CDF update, 1: update CDF on all frames (default), 2: selectively update CDF on some frames) .TP \fB\-\-color\-primaries=\fR Color primaries (CICP) of input content: .IP bt709, unspecified, bt601, bt470m, bt470bg, smpte240, film, bt2020, xyz, smpte431, smpte432, ebu3213 .TP \fB\-\-transfer\-characteristics=\fR Transfer characteristics (CICP) of input content: .IP unspecified, bt709, bt470m, bt470bg, bt601, smpte240, lin, log100, log100sq10, iec61966, bt1361, srgb, bt2020\-10bit, bt2020\-12bit, smpte2084, hlg, smpte428 .TP \fB\-\-matrix\-coefficients=\fR Matrix coefficients (CICP) of input content: identity, bt709, unspecified, fcc73, bt470bg, bt601, smpte240, ycgco, bt2020ncl, bt2020cl, smpte2085, chromncl, chromcl, ictcp .TP \fB\-\-chroma\-sample\-position=\fR The chroma sample position when chroma 4:2:0 is signaled: .IP unknown, vertical, colocated .TP \fB\-\-min\-gf\-interval=\fR Min gf/arf frame interval (default 0, indicating in\-built behavior) .TP \fB\-\-max\-gf\-interval=\fR Max gf/arf frame interval (default 0, indicating in\-built behavior) .TP \fB\-\-gf\-min\-pyr\-height=\fR Min height for GF group pyramid structure (0 (default) to 5) .TP \fB\-\-gf\-max\-pyr\-height=\fR Maximum height for GF group pyramid structure (0 to 5 (default)) .TP \fB\-\-sb\-size=\fR Superblock size to use .IP dynamic, 64, 128 .TP \fB\-\-num\-tile\-groups=\fR Maximum number of tile groups, default is 1 .TP \fB\-\-mtu\-size=\fR MTU size for a tile group, default is 0 (no MTU targeting), overrides maximum number of tile groups .TP \fB\-\-timing\-info=\fR Signal timing info in the bitstream (model only works for no hidden frames, no super\-res yet): .IP unspecified, constant, model .TP \fB\-\-film\-grain\-test=\fR Film grain test vectors (0: none (default), 1: test\-1 2: test\-2, ... 16: test\-16) .TP \fB\-\-film\-grain\-table=\fR Path to file containing film grain parameters .IP \fB\-\-denoise\-noise\-level=\fR Amount of noise (from 0 = don't denoise, to 50) \fB\-\-denoise\-block\-size=\fR Denoise block size (default = 32) \fB\-\-enable\-dnl\-denoising=\fR .IP Apply denoising to the frame being encoded when denoise\-noise\-level is enabled (0: false, 1: true (default)) .TP \fB\-\-max\-reference\-frames=\fR Maximum number of reference frames allowed per frame (3 to 7 (default)) .TP \fB\-\-reduced\-reference\-set=\fR Use reduced set of single and compound references (0: off (default), 1: on) .TP \fB\-\-enable\-ref\-frame\-mvs=\fR Enable temporal mv prediction (default is 1) .TP \fB\-\-target\-seq\-level\-idx=\fR Target sequence level index. Possible values are in the form of "ABxy". AB: Operating point (OP) index, xy: Target level index for the OP. E.g. "0" means target level index 0 (2.0) for the 0th OP, "1019" means target level index 19 (6.3) for the 10th OP. .TP \fB\-\-set\-tier\-mask=\fR Set bit mask to specify which tier each of the 32 possible operating points conforms to. Bit value 0 (default): Main Tier, 1: High Tier. .TP \fB\-\-min\-cr=\fR Set minimum compression ratio. Take integer values. Default is 0. If non\-zero, encoder will try to keep the compression ratio of each frame to be higher than the given value divided by 100. .TP \fB\-\-vbr\-corpus\-complexity\-lap=\fR Set average corpus complexity per mb for single pass VBR using lap. (0..10000), default is 0 .TP \fB\-\-input\-chroma\-subsampling\-x=\fR Chroma subsampling x value .TP \fB\-\-input\-chroma\-subsampling\-y=\fR Chroma subsampling y value .TP \fB\-\-dv\-cost\-upd\-freq=\fR Update freq for dv costs. 0: SB, 1: SB Row per Tile, 2: Tile, 3: Off .IP \fB\-\-partition\-info\-path=\fR Partition information read and write path \fB\-\-enable\-rate\-guide\-deltaq=\fR .IP Enable rate guide deltaq (1), by default off (0). It requires \fB\-\-deltaq\-mode\fR=\fI\,3\/\fR. If turned on, it requires an input file specified by \fB\-\-rate\-distribution\-info\fR. .TP \fB\-\-rate\-distribution\-info=\fR Rate distribution information input.It requires \fB\-\-enable\-rate\-guide\-deltaq\fR=\fI\,1\/\fR. .TP \fB\-\-enable\-directional\-intra=\fR Enable directional intra prediction modes (0: false, 1: true (default)) .TP \fB\-\-enable\-tx\-size\-search=\fR Enable transform size search to find the best size for each block. If false, transforms always have the largest possible size (0: false, 1: true (default)). Ignored in non rd pick mode in real\-time coding. .TP \fB\-\-loopfilter\-control=\fR Control loop filtering (0: Loopfilter disabled for all frames, 1: Enable loopfilter for all frames (default), 2: Disable loopfilter for non\-reference frames, 3: Disable loopfilter for frames with low motion) .TP \fB\-\-auto\-intra\-tools\-off=\fR Automatically turn off several intra coding tools for allintra mode; only in effect if \fB\-\-deltaq\-mode\fR=\fI\,3\/\fR .TP \fB\-p\fR , \fB\-\-passes=\fR Number of passes (1/2/3) .TP \fB\-\-two\-pass\-output=\fR The output file for the first two passes for three\-pass encoding .TP \fB\-spf\fR , \fB\-\-second\-pass\-log=\fR Log file from second pass .TP \fB\-\-fwd\-kf\-dist=\fR Set distance between forward keyframes. A value of \fB\-1\fR (default) means no repetitive forward keyframes. .TP \fB\-\-strict\-level\-conformance=\fR When set to 1, exit the encoder when it fails to encode to a given target level .TP \fB\-\-sb\-qp\-sweep=\fR When set to 1, enable the superblock level qp sweep for a given lambda to minimize the rdcost. .TP \fB\-\-dist\-metric=\fR Distortion metric to use for in\-block optimization .IP psnr, qm\-psnr .TP \fB\-\-kf\-max\-pyr\-height=\fR Maximum height of pyramid structure used for the GOP starting with a key frame (\fB\-1\fR to 5). When set to \fB\-1\fR (default), it does not have any effect. The actual maximum pyramid height will be the minimum of this value and the value of gf_max_pyr_height. .SS "Stream timebase (--timebase):" .IP The desired precision of timestamps in the output, expressed in fractional seconds. Default is 1/1000. .PP Included encoders: .TP av1 \- AOMedia Project AV1 Encoder v3.7.0 (default) .IP Use \fB\-\-codec\fR to switch to a non\-default encoder.