Hello, x264 has grown out of sync with the documentation in the mplayer man page. This patch attempts to correct that by changing every incorrect default I found and by documenting every undocumented parameter which I was able to describe.
Most of the descriptions are from the x264 commit messages and the source code. I make no guarantee that the parameters are described correctly--I did my best, but I haven't (yet) used many of them. * update defaults: frameref to 3 bframes to 3 subq to 6 trellis to 1 threads to 0 (auto) * document the following parameters: intra_refresh mbtree rc_lookahead weightp psy sliced_threads slice_max_size slice_max_mbs slices sync_lookahead deterministic constrained_intra aud dump_yuv There are several parameters for which I am unable to write a coherent description; these are not included in the patch: overscan videoformat fullrange colorprim transfer colormatrix chromaloc cabac_idc sps_id annexb Comments? Thanks, Corey
Index: DOCS/man/en/mplayer.1 =================================================================== --- DOCS/man/en/mplayer.1 (revision 30589) +++ DOCS/man/en/mplayer.1 (working copy) @@ -10120,8 +10120,15 @@ are just as big as I-frames, but do not reset the "keyint counter". . .TP +.B (no)intra_refresh +Periodic intra block refresh instead of keyframes (default: disabled). +This option disables IDR-frames, and, instead, uses a moving vertical bar +of intra-coded blocks. This reduces compression efficiency but benefits +low-latency streaming and resilience to packet loss. +. +.TP .B frameref=<1\-16> -Number of previous frames used as predictors in B- and P-frames (default: 1). +Number of previous frames used as predictors in B- and P-frames (default: 3). This is effective in anime, but in live-action material the improvements usually drop off very rapidly above 6 or so reference frames. This has no effect on decoding speed, but does increase the memory needed for @@ -10130,7 +10137,7 @@ . .TP .B bframes=<0\-16> -maximum number of consecutive B-frames between I- and P-frames (default: 0) +maximum number of consecutive B-frames between I- and P-frames (default: 3) . .TP .B (no)b_adapt @@ -10206,6 +10213,21 @@ frames (default: 4) . .TP +.B (no)mbtree +Enable macroblock tree ratecontrol (default: enabled). +Use a large lookahead to track temporal propagation of data and weight quality +accordingly. +In multi-pass mode, this writes to a separate stats file named +<passlogfile>.mbtree. +Mbtree is not currently compatible with b_pyramid. +. +.TP +.B rc_lookahead=<0\-250> +Adjust the mbtree lookahead distance (default: 40). +Larger values will be slower and cause x264 to consume more memory, but can +yield higher quality. +. +.TP .B ratetol=<0.1\-100.0> (ABR or two pass) allowed variance in average bitrate (no particular units) (default: 1.0) . @@ -10298,6 +10320,20 @@ .RE . .TP +.B weightp +Weighted P-frame prediction mode (default: 2). +.PD 0 +.RSs +.IPs 0 +disabled (fastest) +.IPs 1 +blind mode (slightly better quality) +.IPs 2 +smart mode (best) +.RE +.PD 1 +. +.TP .B (no)weight_b Use weighted prediction in B-frames. Without this option, bidirectionally predicted macroblocks give @@ -10401,9 +10437,9 @@ searches. .IPs 6 Enables rate-distortion optimization of macroblock types in -I- and P-frames (default). +I- and P-frames. .IPs 7 -Enables rate-distortion optimization of macroblock types in all frames. +Enables rate-distortion optimization of macroblock types in all frames (default). .IPs 8 Enables rate-distortion optimization of motion vectors and intra prediction modes in I- and P-frames. .IPs 9 @@ -10434,9 +10470,9 @@ .PD 0 .RSs .IPs 0 -disabled (default) +disabled .IPs 1 -enabled only for the final encode +enabled only for the final encode (default) .IPs 2 enabled during all mode decisions (slow, requires subq>=6) .RE @@ -10455,6 +10491,11 @@ .PD 1 . .TP +.B (no)psy +Enable psychovisual optimizations that hurt PSNR and SSIM but ought to look +better (default: enabled). +. +.TP .B deadzone_inter=<0\-32> Set the size of the inter luma quantization deadzone for non-trellis quantization (default: 21). @@ -10586,12 +10627,43 @@ . .TP .B threads=<0\-16> -Spawn threads to encode in parallel on multiple CPUs (default: 1). +Spawn threads to encode in parallel on multiple CPUs (default: 0). This has a slight penalty to compression quality. 0 or 'auto' tells x264 to detect how many CPUs you have and pick an appropriate number of threads. . .TP +.B (no)sliced_threads +Use slice-based threading (default: disabled). +Unlike normal threading, this option adds no encoding latency, but is slightly +slower and less effective at compression. +. +.TP +.B slice_max_size=<0 or positive integer> +Maximum slice size in bytes (default:0). +A value of zero disables the maximum. +. +.TP +.B slice_max_mbs=<0 or positive integer> +Maximum slice size in number of macroblocks (default:0). +A value of zero disables the maximum. +. +.TP +.B slices=<0 or positive integer> +Maximum number of slices per frame (default:0). +A value of zero disables the maximum. +. +.TP +.B sync_lookahead=<0\-250> +Adjusts the size of the threaded lookahead buffer (default: 0). +0 or 'auto' tells x264 to automatically determine buffer size. +. +.TP +.B (no)deterministic +Use only deterministic optimizations with multithreaded encoding (default: +enabled). +. +.TP .B (no)global_header Causes SPS and PPS to appear only once, at the beginning of the bitstream (default: disabled). @@ -10603,6 +10675,16 @@ Treat the video content as interlaced. . .TP +.B (no)constrained_intra +Enable constrained intra prediction (default: disabled). +This significantly reduces compression, but is required for the base layer of +SVC encodes. +. +.TP +.B (no)aud +Write access unit delimeters to the stream (default: disabled). +. +.TP .B log=<\-1\-3> Adjust the amount of logging info printed to the screen. .PD 0 @@ -10644,6 +10726,11 @@ the encoding process, in which x264 will attempt to present an overview of how each frame gets encoded. Each block type on the visualized movie will be colored as follows: +. +.TP +.B dump_yuv=<file name> +Dump YUV frames to the specified file. +For debugging use. .PD 0 .RSs .IPs red/pink
_______________________________________________ MPlayer-DOCS mailing list [email protected] https://lists.mplayerhq.hu/mailman/listinfo/mplayer-docs
