Browse code

Document the preset files system.

Originally committed as revision 15563 to svn://svn.ffmpeg.org/ffmpeg/trunk

Stefano Sabatini authored on 2008/10/05 18:45:54
Showing 1 changed files
... ...
@@ -780,6 +780,40 @@ Set the maximum demux-decode delay.
780 780
 Set the initial demux-decode delay.
781 781
 @end table
782 782
 
783
+@section Preset files
784
+
785
+A preset file contains a sequence of @var{option}=@var{value} pairs,
786
+one for each line, specifying a sequence of options which would be
787
+awkward to specify on the command line. Lines starting with the hash
788
+('#') character are ignored and are used to provide comments. Check
789
+the @file{ffpresets} directory in the FFmpeg source tree for examples.
790
+
791
+Preset files are specified with the @code{vpre}, @code{apre} and
792
+@code{spre} options. The options specified in a preset file are
793
+applied to the currently selected codec of the same type as specified
794
+by the preset option.
795
+
796
+The argument passed to the preset options identifies the preset file
797
+to use according to the following rules.
798
+
799
+First ffmpeg searches for a file named @var{arg}.ffpreset in the
800
+directories @file{$HOME/.ffmpeg}, @file{/usr/local/share/ffmpeg} and
801
+@file{/usr/share/ffmpeg} in that order. For example, if the argument
802
+is @code{libx264-max}, it will search for the file
803
+@file{libx264-max.ffpreset}.
804
+
805
+If no such file is found, then ffmpeg will search for a file named
806
+@var{codec_name}-@var{arg}.ffpreset in the above-mentioned
807
+directories, where @var{codec_name} is the name of the codec to which
808
+the preset file options will be applied. For example, if you select
809
+the video codec with @code{-vcodec libx264} and use @code{-vpre max},
810
+then it will search for the file @file{libx264-max.ffpreset}.
811
+
812
+Finally, if the above rules failed and the argument specifies an
813
+absolute pathname, ffmpeg will search for that filename. This way you
814
+can specify the absolute and complete filename of the preset file, for
815
+example @file{./ffpresets/libx264-max.ffpreset}.
816
+
783 817
 @node FFmpeg formula evaluator
784 818
 @section FFmpeg formula evaluator
785 819