OS Manuals

/usr/bin/vpxenc

Library for the vp8/vp9 codecs

From libvpx 1.17.0-r2 (os), captured 2026-11-05 by running vpxenc --help (exit 0). permalink

Usage: /usr/bin/vpxenc <options> -o dst_filename src_filename

Options:
            --help                      Show usage options and exit
  -D,       --debug                     Debug mode (makes output deterministic)
  -o <arg>, --output=<arg>              Output filename
            --codec=<arg>               Codec to use
  -p <arg>, --passes=<arg>              Number of passes (1/2)
            --pass=<arg>                Pass to execute (1/2)
            --fpf=<arg>                 First pass statistics file name
            --limit=<arg>               Stop encoding after n input frames
            --skip=<arg>                Skip the first n input frames
  -d <arg>, --deadline=<arg>            Deadline per frame (usec)
            --best                      Use Best Quality Deadline
            --good                      Use Good Quality Deadline
            --rt                        Use Realtime Quality Deadline
  -q,       --quiet                     Do not print encode progress
  -v,       --verbose                   Show encoder parameters
            --psnr                      Show PSNR in status line
            --webm                      Output WebM (default when WebM IO is enabled)
            --ivf                       Output IVF
  -P,       --output-partitions         Makes encoder output partitions. Requires IVF output!
            --q-hist=<arg>              Show quantizer histogram (n-buckets)
            --rate-hist=<arg>           Show rate histogram (n-buckets)
            --disable-warnings          Disable warnings about potentially incorrect encode settings.
  -y,       --disable-warning-prompt    Display warnings, but do not prompt user to continue.
            --test-decode=<arg>         Test encode/decode mismatch
                                       	  off, fatal, warn

Encoder Global Options:
            --nv12                      Input file is NV12
            --yv12                      Input file is YV12
            --i420                      Input file is I420 (default)
            --i422                      Input file is I422
            --i444                      Input file is I444
            --i440                      Input file is I440
  -u <arg>, --usage=<arg>               Usage profile number to use
  -t <arg>, --threads=<arg>             Max number of threads to use
            --profile=<arg>             Bitstream profile number to use
  -w <arg>, --width=<arg>               Frame width
  -h <arg>, --height=<arg>              Frame height
            --stereo-mode=<arg>         Stereo 3D video format
                                       	  mono, left-right, bottom-top, top-bottom, right-left
            --timebase=<arg>            Output timestamp precision (fractional seconds)
            --fps=<arg>                 Stream frame rate (rate/scale)
            --error-resilient=<arg>     Enable error resiliency features
            --test-16bit-internal       Force use of 16 bit internal buffer
            --lag-in-frames=<arg>       Max number of frames to lag

Rate Control Options:
            --drop-frame=<arg>          Temporal resampling threshold (buf %)
            --resize-allowed=<arg>      Spatial resampling enabled (bool)
            --resize-width=<arg>        Width of encoded frame
            --resize-height=<arg>       Height of encoded frame
            --resize-up=<arg>           Upscale threshold (buf %)
            --resize-down=<arg>         Downscale threshold (buf %)
            --end-usage=<arg>           Rate control mode
                                       	  vbr, cbr, cq, q
            --target-bitrate=<arg>      Bitrate (kbps)
            --min-q=<arg>               Minimum (best) quantizer
            --max-q=<arg>               Maximum (worst) quantizer
            --undershoot-pct=<arg>      Datarate undershoot (min) target (%)
            --overshoot-pct=<arg>       Datarate overshoot (max) target (%)
            --buf-sz=<arg>              Client buffer size (ms)
            --buf-initial-sz=<arg>      Client initial buffer size (ms)
            --buf-optimal-sz=<arg>      Client optimal buffer size (ms)

Twopass Rate Control Options:
            --bias-pct=<arg>            CBR/VBR bias (0=CBR, 100=VBR)
            --minsection-pct=<arg>      GOP min bitrate (% of target)
            --maxsection-pct=<arg>      GOP max bitrate (% of target)
            --corpus-complexity=<arg>   corpus vbr complexity midpoint

Keyframe Placement Options:
            --kf-min-dist=<arg>         Minimum keyframe interval (frames)
            --kf-max-dist=<arg>         Maximum keyframe interval (frames)
            --disable-kf                Disable keyframe placement

VP8 Specific Options:
            --cpu-used=<arg>            CPU Used (-16..16)
            --auto-alt-ref=<arg>        Enable automatic alt reference frames. (0..1)
            --noise-sensitivity=<arg>   Noise sensitivity (frames to blur)
            --sharpness=<arg>           Increase sharpness at the expense of lower PSNR. (0..7)
            --static-thresh=<arg>       Motion detection threshold
            --token-parts=<arg>         Number of token partitions to use, log2
            --arnr-maxframes=<arg>      AltRef max frames (0..15)
            --arnr-strength=<arg>       AltRef filter strength (0..6)
            --arnr-type=<arg>           AltRef filter type (1..3)
            --tune=<arg>                Material to favor
                                       	  psnr, ssim
            --cq-level=<arg>            Constant/Constrained Quality level
            --max-intra-rate=<arg>      Max I-frame bitrate (pct)
            --gf-cbr-boost=<arg>        Boost for Golden Frame in CBR mode (pct)
            --screen-content-mode=<arg> Screen content mode

VP9 Specific Options:
            --cpu-used=<arg>            CPU Used (-9..9)
            --auto-alt-ref=<arg>        Enable automatic alt reference frames, 2+ enables multi-layer. (0..6)
            --sharpness=<arg>           Increase sharpness at the expense of lower PSNR. (0..7)
            --static-thresh=<arg>       Motion detection threshold
            --tile-columns=<arg>        Number of tile columns to use, log2
            --tile-rows=<arg>           Number of tile rows to use, log2 (set to 0 while threads > 1)
            --enable-tpl=<arg>          Enable temporal dependency model
            --enable-keyframe-filtering=<arg>
                                        Enable key frame temporal filtering (0: off (default), 1: on)
            --arnr-maxframes=<arg>      AltRef max frames (0..15)
            --arnr-strength=<arg>       AltRef filter strength (0..6)
            --arnr-type=<arg>           AltRef filter type (1..3)
            --tune=<arg>                Material to favor
                                       	  psnr, ssim
            --cq-level=<arg>            Constant/Constrained Quality level
            --max-intra-rate=<arg>      Max I-frame bitrate (pct)
            --max-inter-rate=<arg>      Max P-frame bitrate (pct)
            --gf-cbr-boost=<arg>        Boost for Golden Frame in CBR mode (pct)
            --lossless=<arg>            Lossless mode (0: false (default), 1: true)
            --frame-parallel=<arg>      Enable frame parallel decodability features
            --aq-mode=<arg>             Adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3: cyclic refresh, 4: equator360)
            --alt-ref-aq=<arg>          Special adaptive quantization for the alternate reference frames.
            --frame-boost=<arg>         Enable frame periodic boost (0: off (default), 1: on)
            --noise-sensitivity=<arg>   Noise sensitivity (frames to blur)
            --tune-content=<arg>        Tune content type
                                       	  default, screen, film
            --color-space=<arg>         The color space of input content:
                                       	  unknown, bt601, bt709, smpte170, smpte240, bt2020, reserved, sRGB
            --min-gf-interval=<arg>     min gf/arf frame interval (default 0, indicating in-built behavior)
            --max-gf-interval=<arg>     max gf/arf frame interval (default 0, indicating in-built behavior)
            --target-level=<arg>        Target level
                                        255: off (default)
                                          0: only keep level stats
                                          1: adaptively set alt-ref distance and column tile limit based on picture size, and keep level stats
                                         10: level 1.0  11: level 1.1  ...  62: level 6.2
            --row-mt=<arg>              Enable row based non-deterministic multi-threading in VP9
            --disable-loopfilter=<arg>  Control Loopfilter in VP9:
                                          0: Loopfilter on for all frames (default)
                                          1: Loopfilter off for non reference frames
                                          2: Loopfilter off for all frames
            --validate-hbd-input=<arg>  Check that input samples are within the valid range for the chosen bit depth with high bit depth encoding (0: disabled, 1: enabled (default))
  -b <arg>, --bit-depth=<arg>           Bit depth for codec (8 for version <=1, 10 or 12 for version 2)
                                       	  8, 10, 12
            --input-bit-depth=<arg>     Actual bit depth of input source

Vizier Rate Control Options:
            --use-vizier-rc-params=<arg>
                                        Use vizier rc params
            --active-wq-factor=<arg>    Active worst quality factor
            --err-per-mb-factor=<arg>   Error per macroblock factor
            --sr-default-decay-limit=<arg>
                                        Second reference default decay limit
            --sr-diff-factor=<arg>      Second reference diff factor
            --kf-err-per-mb-factor=<arg>
                                        Keyframe error per macroblock factor
            --kf-frame-min-boost-factor=<arg>
                                        Keyframe min boost
            --kf-frame-max-boost-first-factor=<arg>
                                        Max keyframe boost adjustment factor for first frame
            --kf-frame-max-boost-subs-factor=<arg>
                                        Max boost adjustment factor for subsequent KFs
            --kf-max-total-boost-factor=<arg>
                                        Keyframe max total boost factor
            --gf-max-total-boost-factor=<arg>
                                        Golden frame max total boost factor
            --gf-frame-max-boost-factor=<arg>
                                        Golden frame max per frame boost factor
            --zm-factor=<arg>           Zero motion power factor
            --rd-mult-inter-qp-fac=<arg>
                                        RD multiplier adjustment for inter frames
            --rd-mult-arf-qp-fac=<arg>  RD multiplier adjustment for alt-ref frames
            --rd-mult-key-qp-fac=<arg>  RD multiplier adjustment for key frames

Stream timebase (--timebase):
  The desired precision of timestamps in the output, expressed
  in fractional seconds. Default is 1/1000.

Included encoders:

    vp8    - WebM Project VP8 Encoder v1.17.0
    vp9    - WebM Project VP9 Encoder v1.17.0 (default)

        Use --codec to switch to a non-default encoder.
Options (112)
OptionDescriptionSource
--helpShow usage options and exithelp
-D--debug Debug mode (makes output deterministic)help
-o, --output argOutput filenamehelp
--codec argCodec to usehelp
-p, --passes argNumber of passes (1/2)help
--pass argPass to execute (1/2)help
--fpf argFirst pass statistics file namehelp
--limit argStop encoding after n input frameshelp
--skip argSkip the first n input frameshelp
-d, --deadline argDeadline per frame (usec)help
--bestUse Best Quality Deadlinehelp
--goodUse Good Quality Deadlinehelp
--rtUse Realtime Quality Deadlinehelp
-q--quiet Do not print encode progresshelp
-v--verbose Show encoder parametershelp
--psnrShow PSNR in status linehelp
--webmOutput WebM (default when WebM IO is enabled)help
--ivfOutput IVFhelp
-P--output-partitions Makes encoder output partitions.help
--q-hist argShow quantizer histogram (n-buckets)help
--rate-hist argShow rate histogram (n-buckets)help
--disable-warningsDisable warnings about potentially incorrect encode settings.help
-y--disable-warning-prompt Display warnings, but do not prompt user to continue.help
--test-decode argTest encode/decode mismatch off, fatal, warnhelp
--nv12Input file is NV12help
--yv12Input file is YV12help
--i420Input file is I420 (default)help
--i422Input file is I422help
--i444Input file is I444help
--i440Input file is I440help
-u, --usage argUsage profile number to usehelp
-t, --threads argMax number of threads to usehelp
--profile argBitstream profile number to usehelp
-w, --width argFrame widthhelp
-h, --height argFrame heighthelp
--stereo-mode argStereo 3D video format mono, left-right, bottom-top, top-bottom, right-lefthelp
--timebase argOutput timestamp precision (fractional seconds)help
--fps argStream frame rate (rate/scale)help
--error-resilient argEnable error resiliency featureshelp
--test-16bit-internalForce use of 16 bit internal bufferhelp
--lag-in-frames argMax number of frames to laghelp
--drop-frame argTemporal resampling threshold (buf %)help
--resize-allowed argSpatial resampling enabled (bool)help
--resize-width argWidth of encoded framehelp
--resize-height argHeight of encoded framehelp
--resize-up argUpscale threshold (buf %)help
--resize-down argDownscale threshold (buf %)help
--end-usage argRate control mode vbr, cbr, cq, qhelp
--target-bitrate argBitrate (kbps)help
--min-q argMinimum (best) quantizerhelp
--max-q argMaximum (worst) quantizerhelp
--undershoot-pct argDatarate undershoot (min) target (%)help
--overshoot-pct argDatarate overshoot (max) target (%)help
--buf-sz argClient buffer size (ms)help
--buf-initial-sz argClient initial buffer size (ms)help
--buf-optimal-sz argClient optimal buffer size (ms)help
--bias-pct argCBR/VBR bias (0=CBR, 100=VBR)help
--minsection-pct argGOP min bitrate (% of target)help
--maxsection-pct argGOP max bitrate (% of target)help
--corpus-complexity argcorpus vbr complexity midpointhelp
--kf-min-dist argMinimum keyframe interval (frames)help
--kf-max-dist argMaximum keyframe interval (frames)help
--disable-kfDisable keyframe placementhelp
--cpu-used argCPU Used (-16..16)help
--auto-alt-ref argEnable automatic alt reference frames.help
--noise-sensitivity argNoise sensitivity (frames to blur)help
--sharpness argIncrease sharpness at the expense of lower PSNR.help
--static-thresh argMotion detection thresholdhelp
--token-parts argNumber of token partitions to use, log2help
--arnr-maxframes argAltRef max frames (0..15)help
--arnr-strength argAltRef filter strength (0..6)help
--arnr-type argAltRef filter type (1..3)help
--tune argMaterial to favor psnr, ssimhelp
--cq-level argConstant/Constrained Quality levelhelp
--max-intra-rate argMax I-frame bitrate (pct)help
--gf-cbr-boost argBoost for Golden Frame in CBR mode (pct)help
--tile-columns argNumber of tile columns to use, log2help
--tile-rows argNumber of tile rows to use, log2 (set to 0 while threads > 1)help
--enable-tpl argEnable temporal dependency modelhelp
--enable-keyframe-filtering argEnable key frame temporal filtering (0: off (default), 1: on)help
--max-inter-rate argMax P-frame bitrate (pct)help
--lossless argLossless mode (0: false (default), 1: true)help
--frame-parallel argEnable frame parallel decodability featureshelp
--aq-mode argAdaptive quantization mode (0: off (default), 1: variance 2: complexity, 3: cyclic refresh, 4: equator360)help
--alt-ref-aq argSpecial adaptive quantization for the alternate reference frames.help
--frame-boost argEnable frame periodic boost (0: off (default), 1: on)help
--tune-content argTune content type default, screen, filmhelp
--color-space argThe color space of input content: unknown, bt601, bt709, smpte170, smpte240, bt2020, reserved, sRGBhelp
--min-gf-interval argmin gf/arf frame interval (default 0, indicating in-built behavior)help
--max-gf-interval argmax gf/arf frame interval (default 0, indicating in-built behavior)help
--target-level argTarget level 255: off (default) 0: only keep level stats 1: adaptively set alt-ref distance and column tile limit based on picture size, and keep level stats 10: level 1.0 11: level 1.1 ...help
--row-mt argEnable row based non-deterministic multi-threading in VP9help
--disable-loopfilter argControl Loopfilter in VP9: 0: Loopfilter on for all frames (default) 1: Loopfilter off for non reference frames 2: Loopfilter off for all frameshelp
--validate-hbd-input argCheck that input samples are within the valid range for the chosen bit depth with high bit depth encoding (0: disabled, 1: enabled (default))help
-b, --bit-depth argBit depth for codec (8 for version <=1, 10 or 12 for version 2) 8, 10, 12help
--input-bit-depth argActual bit depth of input sourcehelp
--use-vizier-rc-params argUse vizier rc paramshelp
--active-wq-factor argActive worst quality factorhelp
--err-per-mb-factor argError per macroblock factorhelp
--sr-default-decay-limit argSecond reference default decay limithelp
--sr-diff-factor argSecond reference diff factorhelp
--kf-err-per-mb-factor argKeyframe error per macroblock factorhelp
--kf-frame-min-boost-factor argKeyframe min boosthelp
--kf-frame-max-boost-first-factor argMax keyframe boost adjustment factor for first framehelp
--kf-frame-max-boost-subs-factor argMax boost adjustment factor for subsequent KFshelp
--kf-max-total-boost-factor argKeyframe max total boost factorhelp
--gf-max-total-boost-factor argGolden frame max total boost factorhelp
--gf-frame-max-boost-factor argGolden frame max per frame boost factorhelp
--zm-factor argZero motion power factorhelp
--rd-mult-inter-qp-fac argRD multiplier adjustment for inter frameshelp
--rd-mult-arf-qp-fac argRD multiplier adjustment for alt-ref frameshelp
--rd-mult-key-qp-fac argRD multiplier adjustment for key frameshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.