.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.3.
.TH XAVS2 "1" "April 2021" "xavs2 1.3" "User Commands"
.SH NAME
xavs2 \- AVS2 (IEEE 1857.4) encoder
.SH DESCRIPTION
xavs2 lib loaded: version 1.3.0 unstable 8\-bit
.SH SYNOPSIS
.B xavs2
[\-f \fIEncoderFile.cfg\fR] [\-p \fIParameterName\fR=\fIValue\fR] [\-\-\fIParameterName\fR=\fIvalue\fR]
.SH PARAMETERS
.TP
\fBWidth\fRImage width  in pixels
.TP
\fBSourceWidth\fR  \- Same as `Width`
.TP
\fBHeight\fRImage height in pixels
.TP
\fBSourceHeight\fR  \- Same as `Height`
.TP
\fBInput\fRInput sequence, YUV 4:2:0
.TP
\fBInputFile\fR  \- Same as `Input`
.TP
\fBInputHeaderLength\fRIf the inputfile has a header, state it's length in byte here
.TP
\fBFrameRate\fRFramerateCode, 1: 24000/1001,2: 24,3: 25(default), 4: 30000/1001,5: 30,6: 50,7: 60000/1001,8: 60
.TP
\fBChromaFormat\fRYUV format, 0=4:0:0, 1=4:2:0(default), 2=4:2:2
.TP
\fBInputSampleBitDepth\fRSample Bitdepth of input file
.TP
\fBFrames\fRNumber of frames to be coded
.TP
\fBFramesToBeEncoded\fR  \- Same as `Frames`
.TP
\fBoutput\fROutput bistream file path
.TP
\fBOutputFile\fR  \- Same as `output`
.TP
\fBRecon\fROutput reconstruction YUV file path
.TP
\fBReconFile\fR  \- Same as `Recon`
.TP
\fBMaxSizeInBit\fRMaximum Coding Unit (CU) Size (4, 5, 6)
.TP
\fBMinSizeInBit\fRMinimum Coding Unit (CU) Size (3, 4, 5, 6)
.TP
\fBProfileID\fRProfile ID (18: MAIN PICTURE profile, 32: MAIN profile, 34: MAIN10 profile)
.TP
\fBLevelID\fRLevel ID   (16: 2.0;  32: 4.0;  34: 4.2;  64: 6.0;  66: 6.2)
.TP
\fBSampleBitDepth\fREncoding bit\-depth
.TP
\fBIntraPeriodMax\fRmaximum intra\-period, one I\-frame mush appear in any NumMax of frames
.TP
\fBIntraPeriodMin\fRminimum intra\-period, only one I\-frame can appear in at most NumMin of frames
.TP
\fBOpenGOP\fROpen GOP or Closed GOP, 1: Open(default), 0: Closed
.TP
\fBUseHadamard\fRHadamard transform (0=not used, 1=used)
.TP
\fBFME\fRMotion Estimation method: 0\-Full Search, 1\-DIA, 2\-HEX, 3\-UMH (default), 4\-TZ
.TP
\fBSearchRange\fRMax search range
.TP
\fBNumberReferenceFrames\fRNumber of previous frames used for inter motion search (1\-5)
.TP
\fBTemporalIdExistFlag\fRtemporal ID
.TP
\fBFFRAMEEnable\fRUse F Frame or not (0: Don't use F frames  1:Use F frames instead of P frames)
.TP
\fBDHPEnable\fR(0: Don't use DHP,      1:Use DHP)
.TP
\fBMHPSKIPEnable\fR(0: Don't use MH_PSKIP, 1:Use MH_PSKIP)
.TP
\fBWSMEnable\fR(0: Don't use WSM,      1:Use WSM)
.TP
\fBNumberBFrames\fRNumber of B frames inserted between I/P/F frames (0=not used)
.TP
\fBInter2PU\fRinter partition mode 2NxN or Nx2N or AMP
.TP
\fBInterAMP\fRinter partition mode AMP
.TP
\fBIntraInInter\fRintra partition in inter frame
.TP
\fBRdoLevel\fRRD\-optimized mode decision (0:off, 1: only for best partition mode of one CU, 2: only for best 2 partition modes; 3: All partition modes)
.TP
\fBLoopFilterDisable\fRDisable loop filter in picture header (0=Filter, 1=No Filter)
.TP
\fBLoopFilterParameter\fRSend loop filter parameter (0= No parameter, 1= Send Parameter)
.TP
\fBLoopFilterAlphaOffset\fRAplha offset in loop filter
.TP
\fBLoopFilterBetaOffset\fRBeta offset in loop filter
.TP
\fBSAOEnable\fREnable SAO or not (1: on, 0: off)
.TP
\fBALFEnable\fREnable ALF or not (1: on, 0: off)
.TP
\fBALFLowLatencyEncodingEnable\fREnable Low Latency ALF (1=Low Latency mode, 0=High Efficiency mode)
.TP
\fBCrossSliceLoopFilter\fREnable Cross Slice Boundary Filter (0=Disable, 1=Enable)
.TP
\fBWQEnable\fRWeighted quantization
.TP
\fBRdoqLevel\fRRdoq Level (0: off, 1: cu level, only for best partition mode, 2: all mode)
.TP
\fBLambdaFactor\fRdefault: 75,  Rdoq Lambda factor
.TP
\fBLambdaFactorP\fRdefault: 120, Rdoq Lambda factor P/F frame
.TP
\fBLambdaFactorB\fRdefault: 100, Rdoq Lambda factor B frame
.TP
\fBPMVREnable\fRPMVR
.TP
\fBNSQT\fRNSQT
.TP
\fBSDIP\fRSDIP
.TP
\fBSECTEnable\fRSecondary Transform
.TP
\fBTDRDOEnable\fRTDRDO, only for LDP configuration (without B frames)
.TP
\fBRefineQP\fRRefined QP, only for RA configuration (with B frames)
.TP
\fBRateControl\fR0: CQP, 1: CBR (frame level), 2: CBR (SCU level), 3: VBR
.TP
\fBTargetBitRate\fRtarget bitrate, in bps
.TP
\fBQP\fRinitial qp for first frame (8bit: 0~63; 10bit: 0~79)
.TP
\fBInitialQP\fR  \- Same as `QP`
.TP
\fBQPIFrame\fR  \- Same as `QP`
.TP
\fBMinQP\fRmin qp (8bit: 0~63; 10bit: 0~79)
.TP
\fBMaxQP\fRmax qp (8bit: 0~63; 10bit: 0~79)
.TP
\fBGopSize\fRsub GOP size (negative numbers indicating an employ of default settings, which will invliadate the following settings.)
.TP
\fBPresetLevel\fRpreset level for tradeoff between speed and performance, ordered from fastest to slowest (0, ..., 9), default: 5
.TP
\fBPreset\fR  \- Same as `PresetLevel`
.TP
\fBSliceNum\fRNumber of slices for each frame
.TP
\fBNumParallelGop\fRnumber of parallel GOPs (0,1: no GOP parallelization)
.TP
\fBThreadFrames\fRnumber of parallel threads for frames ( 0: auto )
.TP
\fBThreadRows\fRnumber of parallel threads for rows   ( 0: auto )
.TP
\fBEnableAecThread\fREnable AEC thread or not (default: enabled)
.TP
\fBLogLevel\fRlog level: \fB\-1\fR: none, 0: error, 1: warning, 2: info, 3: debug
.TP
\fBLog\fR  \- Same as `LogLevel`
.TP
\fBEnablePSNR\fREnable PSNR or not (default: Enable)
.TP
\fBEnableSSIM\fREnable SSIM or not (default: Enable)