Browse code

doc/muxers: document animated GIF muxer.

Clément Bœsch authored on 2013/10/20 03:39:30
Showing 1 changed files
... ...
@@ -146,6 +146,40 @@ ffmpeg -i INPUT -f framemd5 -
146 146
 
147 147
 See also the @ref{md5} muxer.
148 148
 
149
+@anchor{gif}
150
+@section gif
151
+
152
+Animated GIF muxer.
153
+
154
+It accepts the following options:
155
+
156
+@table @option
157
+@item loop
158
+Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
159
+for looping indefinitely (default).
160
+
161
+@item final_delay
162
+Force the delay (expressed in centiseconds) after the last frame. Each frame
163
+ends with a delay until the next frame. The default is @code{-1}, which is a
164
+special value to tell the muxer to re-use the previous delay. In case of a
165
+loop, you might want to customize this value to mark a pause for instance.
166
+@end table
167
+
168
+For example, to encode a gif looping 10 times, with a 5 seconds delay between
169
+the loops:
170
+@example
171
+ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
172
+@end example
173
+
174
+Note 1: if you wish to extract the frames in separate GIF files, you need to
175
+force the @ref{image2} muxer:
176
+@example
177
+ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
178
+@end example
179
+
180
+Note 2: the GIF format has a very small time base: the delay between two frames
181
+can not be smaller than one centi second.
182
+
149 183
 @anchor{hls}
150 184
 @section hls
151 185