doc/demuxers: document gif demuxer
authorLou Logan <lou@lrcd.com>
Fri, 29 Aug 2014 00:26:11 +0000 (16:26 -0800)
committerLou Logan <lou@lrcd.com>
Wed, 3 Sep 2014 18:16:05 +0000 (10:16 -0800)
Signed-off-by: Lou Logan <lou@lrcd.com>
doc/demuxers.texi

index d51b9d0..e582322 100644 (file)
@@ -174,6 +174,40 @@ See @url{http://quvi.sourceforge.net/} for more information.
 FFmpeg needs to be built with @code{--enable-libquvi} for this demuxer to be
 enabled.
 
+@section gif
+
+Animated GIF demuxer.
+
+It accepts the following options:
+
+@table @option
+@item min_delay
+Set the minimum valid delay between frames in hundredths of seconds.
+Range is 0 to 6000. Default value is 2.
+
+@item default_delay
+Set the default delay between frames in hundredths of seconds.
+Range is 0 to 6000. Default value is 10.
+
+@item ignore_loop
+GIF files can contain information to loop a certain number of times (or
+infinitely). If @option{ignore_loop} is set to 1, then the loop setting
+from the input will be ignored and looping will not occur. If set to 0,
+then looping will occur and will cycle the number of times according to
+the GIF. Default value is 1.
+@end table
+
+For example, with the overlay filter, place an infinitely looping GIF
+over another video:
+@example
+ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
+@end example
+
+Note that in the above example the shortest option for overlay filter is
+used to end the output video at the length of the shortest input file,
+which in this case is @file{input.mp4} as the GIF in this example loops
+infinitely.
+
 @section image2
 
 Image file demuxer.