[FFmpeg-cvslog] doc/muxers: document animated GIF muxer.

[Clément Bœsch]

ffmpeg | branch: master | Clément Bœsch <u at pkh.me> | Sat Oct 19 20:39:30 2013 +0200| [3e036d407d1857b814f8ce8b59deb7280f726661] | committer: Clément Bœsch

doc/muxers: document animated GIF muxer.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=3e036d407d1857b814f8ce8b59deb7280f726661
---

 doc/muxers.texi |   34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index ae5301c..bb474c1 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -146,6 +146,40 @@ ffmpeg -i INPUT -f framemd5 -
 
 See also the @ref{md5} muxer.
 
+ at anchor{gif}
+ at section gif
+
+Animated GIF muxer.
+
+It accepts the following options:
+
+ at table @option
+ at item loop
+Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
+for looping indefinitely (default).
+
+ at item final_delay
+Force the delay (expressed in centiseconds) after the last frame. Each frame
+ends with a delay until the next frame. The default is @code{-1}, which is a
+special value to tell the muxer to re-use the previous delay. In case of a
+loop, you might want to customize this value to mark a pause for instance.
+ at end table
+
+For example, to encode a gif looping 10 times, with a 5 seconds delay between
+the loops:
+ at example
+ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
+ at end example
+
+Note 1: if you wish to extract the frames in separate GIF files, you need to
+force the @ref{image2} muxer:
+ at example
+ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
+ at end example
+
+Note 2: the GIF format has a very small time base: the delay between two frames
+can not be smaller than one centi second.
+
 @anchor{hls}
 @section hls