]> git.sesse.net Git - ffmpeg/blobdiff - doc/encoders.texi
display: add matrix flip api
[ffmpeg] / doc / encoders.texi
index 5c0e4896849db6c110f8e80a551d8db07b5410e6..94d834077a257dabfa6f1170d64dfcc51887c14e 100644 (file)
@@ -518,6 +518,43 @@ be better than any of the two specified individually. In other
 words, the resulting quality will be the worse one of the two
 effects.
 
 words, the resulting quality will be the worse one of the two
 effects.
 
+@item ssim
+Set structural similarity (SSIM) displaying method. Possible values:
+
+@table @samp
+@item off
+Disable displaying of SSIM information.
+
+@item avg
+Output average SSIM at the end of encoding to stdout. The format of
+showing the average SSIM is:
+
+@example
+Average SSIM: %f
+@end example
+
+For users who are not familiar with C, %f means a float number, or
+a decimal (e.g. 0.939232).
+
+@item frame
+Output both per-frame SSIM data during encoding and average SSIM at
+the end of encoding to stdout. The format of per-frame information
+is:
+
+@example
+       SSIM: avg: %1.3f min: %1.3f max: %1.3f
+@end example
+
+For users who are not familiar with C, %1.3f means a float number
+rounded to 3 digits after the dot (e.g. 0.932).
+
+@end table
+
+@item ssim_acc
+Set SSIM accuracy. Valid options are integers within the range of
+0-4, while 0 gives the most accurate result and 4 computes the
+fastest.
+
 @end table
 
 @section libx264
 @end table
 
 @section libx264
@@ -539,39 +576,53 @@ a list of key=value tuples as accepted by x264_param_parse.
 The following options are supported by the x264 wrapper, the x264-equivalent
 options follow the Libav ones.
 
 The following options are supported by the x264 wrapper, the x264-equivalent
 options follow the Libav ones.
 
-@multitable @columnfractions .2 .2
+@multitable {                  } {              } {                           }
 @item b                 @tab bitrate
 @item b                 @tab bitrate
-Libav @code{b} option is expressed in bits/s, x264 @code{bitrate} in kilobits/s.
+@tab Libav @code{b} option is expressed in bits/s, x264 @code{bitrate} in kilobits/s.
 @item bf                @tab bframes
 @item bf                @tab bframes
-Maximum number of B-frames.
+@tab Maximum number of B-frames.
 @item g                 @tab keyint
 @item g                 @tab keyint
-Maximum GOP size.
+@tab Maximum GOP size.
 @item qmin              @tab qpmin
 @item qmin              @tab qpmin
+@tab Minimum quantizer scale.
 @item qmax              @tab qpmax
 @item qmax              @tab qpmax
+@tab Maximum quantizer scale.
 @item qdiff             @tab qpstep
 @item qdiff             @tab qpstep
+@tab Maximum difference between quantizer scales.
 @item qblur             @tab qblur
 @item qblur             @tab qblur
+@tab Quantizer curve blur
 @item qcomp             @tab qcomp
 @item qcomp             @tab qcomp
+@tab Quantizer curve compression factor
 @item refs              @tab ref
 @item refs              @tab ref
+@tab Number of reference frames each P-frame can use. The range is from @var{0-16}.
 @item sc_threshold      @tab scenecut
 @item sc_threshold      @tab scenecut
+@tab Sets the threshold for the scene change detection.
 @item trellis           @tab trellis
 @item trellis           @tab trellis
+@tab Performs Trellis quantization to increase efficiency. Enabled by default.
 @item nr                @tab nr
 @item nr                @tab nr
-Noise reduction.
+@tab Noise reduction.
 @item me_range          @tab merange
 @item me_range          @tab merange
+@tab Maximum range of the motion search in pixels.
 @item me_method         @tab me
 @item me_method         @tab me
+@tab Full-pixel motion estimation method.
 @item subq              @tab subme
 @item subq              @tab subme
+@tab Sub-pixel motion estimation method.
 @item b_strategy        @tab b-adapt
 @item b_strategy        @tab b-adapt
-@item keyint_min        @tab keyint-min
+@tab Adaptive B-frame placement decision algorithm. Use only on first-pass.
+@item keyint_min        @tab min-keyint
+@tab Minimum GOP size.
 @item coder             @tab cabac
 @item coder             @tab cabac
-Set coder to @code{ac} to use CABAC.
+@tab Set coder to @code{ac} to use CABAC.
 @item cmp               @tab chroma-me
 @item cmp               @tab chroma-me
-Set to @code{chroma} to use chroma motion estimation.
+@tab Set to @code{chroma} to use chroma motion estimation.
 @item threads           @tab threads
 @item threads           @tab threads
+@tab Number of encoding threads.
 @item thread_type       @tab sliced_threads
 @item thread_type       @tab sliced_threads
-Set to @code{slice} to use sliced threading instead of frame threading.
+@tab Set to @code{slice} to use sliced threading instead of frame threading.
 @item flags -cgop       @tab open-gop
 @item flags -cgop       @tab open-gop
-Set @code{-cgop} to use recovery points to close GOPs.
+@tab Set @code{-cgop} to use recovery points to close GOPs.
 @item rc_init_occupancy @tab vbv-init
 @item rc_init_occupancy @tab vbv-init
-Initial buffer occupancy.
+@tab Initial buffer occupancy.
 @end multitable
 
 @subsection Private Options
 @end multitable
 
 @subsection Private Options