Browse code

doc/encoders: add libxvid doc

Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
(cherry picked from commit 6b255e5e70c72aa59ff7aed74b4ee976223eb140)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>

Conflicts:
doc/encoders.texi

Timothy Gu authored on 2013/07/30 11:12:10
Showing 1 changed files
... ...
@@ -710,4 +710,117 @@ ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
710 710
 For more information about libx264 and the supported options see:
711 711
 @url{http://www.videolan.org/developers/x264.html}
712 712
 
713
+@section libxvid
714
+
715
+Xvid MPEG-4 Part 2 encoder wrapper.
716
+
717
+This encoder requires the presence of the libxvidcore headers and library
718
+during configuration. You need to explicitly configure the build with
719
+@code{--enable-libxvid --enable-gpl}.
720
+
721
+The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
722
+users can encode to this format without this library.
723
+
724
+@subsection Options
725
+
726
+The following options are supported by the libxvid wrapper. Some of
727
+the following options are listed but are not documented, and
728
+correspond to shared codec options. See @ref{codec-options,,the Codec
729
+Options chapter} for their documentation. The other shared options
730
+which are not listed have no effect for the libxvid encoder.
731
+
732
+@table @option
733
+@item b
734
+
735
+@item g
736
+
737
+@item qmin
738
+
739
+@item qmax
740
+
741
+@item mpeg_quant
742
+
743
+@item threads
744
+
745
+@item bf
746
+
747
+@item b_qfactor
748
+
749
+@item b_qoffset
750
+
751
+@item flags
752
+Set specific encoding flags. Possible values:
753
+
754
+@table @samp
755
+
756
+@item mv4
757
+Use four motion vector by macroblock.
758
+
759
+@item aic
760
+Enable high quality AC prediction.
761
+
762
+@item gray
763
+Only encode grayscale.
764
+
765
+@item gmc
766
+Enable the use of global motion compensation (GMC).
767
+
768
+@item qpel
769
+Enable quarter-pixel motion compensation.
770
+
771
+@item cgop
772
+Enable closed GOP.
773
+
774
+@item global_header
775
+Place global headers in extradata instead of every keyframe.
776
+
777
+@end table
778
+
779
+@item trellis
780
+
781
+@item me_method
782
+Set motion estimation method. Possible values in decreasing order of
783
+speed and increasing order of quality:
784
+
785
+@table @samp
786
+@item zero
787
+Use no motion estimation (default).
788
+
789
+@item phods
790
+@item x1
791
+@item log
792
+Enable advanced diamond zonal search for 16x16 blocks and half-pixel
793
+refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
794
+@samp{phods}.
795
+
796
+@item epzs
797
+Enable all of the things described above, plus advanced diamond zonal
798
+search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
799
+estimation on chroma planes.
800
+
801
+@item full
802
+Enable all of the things described above, plus extended 16x16 and 8x8
803
+blocks search.
804
+@end table
805
+
806
+@item mbd
807
+Set macroblock decision algorithm. Possible values in the increasing
808
+order of quality:
809
+
810
+@table @samp
811
+@item simple
812
+Use macroblock comparing function algorithm (default).
813
+
814
+@item bits
815
+Enable rate distortion-based half pixel and quarter pixel refinement for
816
+16x16 blocks.
817
+
818
+@item rd
819
+Enable all of the things described above, plus rate distortion-based
820
+half pixel and quarter pixel refinement for 8x8 blocks, and rate
821
+distortion-based search using square pattern.
822
+@end table
823
+
824
+@end table
825
+
713 826
 @c man end VIDEO ENCODERS