Add documentation for the image2 demuxer.
[ffmpeg.git] / doc / demuxers.texi
1 @chapter Demuxers
2 @c man begin DEMUXERS
3
4 Demuxers are configured elements in FFmpeg which allow to read the
5 multimedia streams from a particular type of file.
6
7 When you configure your FFmpeg build, all the supported demuxers
8 are enabled by default. You can list all available ones using the
9 configure option "--list-demuxers".
10
11 You can disable all the demuxers using the configure option
12 "--disable-demuxers", and selectively enable a single demuxer with
13 the option "--enable-demuxer=@var{DEMUXER}", or disable it
14 with the option "--disable-demuxer=@var{DEMUXER}".
15
16 The option "-formats" of the ff* tools will display the list of
17 enabled demuxers.
18
19 The description of some of the currently available demuxers follows.
20
21 @section image2
22
23 Image file demuxer.
24
25 This demuxer reads from a list of image files specified by a pattern.
26
27 The filename of each file to read must contain a sequential number,
28 which specifies the position of the file in the sequence.
29
30 The pattern must contain the string "%d" or "%0@var{N}d", which
31 specifies the position of the characters representing the seqential
32 number in each filename matched by the pattern. If the form
33 "%d0@var{N}d" is used, the string representing the number in each
34 filename is 0-padded and @var{N} is the total number of 0-padded
35 digits representing the number. The literal character '%' can be
36 specified in the pattern with the string "%%".
37
38 The first filename of the file sequence specified by the pattern must
39 contain a number inclusively contained between 0 and 4, all the
40 following numbers must be sequential.
41
42 The pattern may contain a suffix which is used to automatically
43 determine the format of the images contained in the files.
44
45 For example the pattern "img-%03d.bmp" will match a sequence of
46 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
47 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
48 sequence of filenames of the form @file{i%m%g-1.jpg},
49 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
50
51 The size, the pixel format, and the format of each image must be the
52 same for all the files in the sequence.
53
54 The following example shows how to use @file{ffmpeg} for creating a
55 video from the images in the file sequence @file{img-001.jpeg},
56 @file{img-002.jpeg}, ..., assuming an input framerate of 10 frames per
57 second:
58 @example
59 ffmpeg -r 10 -f image2 -i 'img-%03d.jpeg' out.avi
60 @end example
61
62 @c man end INPUT DEVICES