doc/demuxers.texi: avoid comma splice in image2 documentation
[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 pattern may contain the string "%d" or "%0@var{N}d", which
28 specifies the position of the characters representing a sequential
29 number in each filename matched by the pattern. If the form
30 "%d0@var{N}d" is used, the string representing the number in each
31 filename is 0-padded and @var{N} is the total number of 0-padded
32 digits representing the number. The literal character '%' can be
33 specified in the pattern with the string "%%".
34
35 If the pattern contains "%d" or "%0@var{N}d", the first filename of
36 the file list specified by the pattern must contain a number
37 inclusively contained between @var{start_number} and
38 @var{start_number}+4, and all the following numbers must be
39 sequential.
40
41 The pattern may contain a suffix which is used to automatically
42 determine the format of the images contained in the files.
43
44 For example the pattern "img-%03d.bmp" will match a sequence of
45 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
46 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
47 sequence of filenames of the form @file{i%m%g-1.jpg},
48 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
49
50 The size, the pixel format, and the format of each image must be the
51 same for all the files in the sequence.
52
53 This demuxer accepts the following options:
54 @table @option
55 @item framerate
56 Set the framerate for the video stream. It defaults to 25.
57 @item loop
58 If set to 1, loop over the input. Default value is 0.
59 @item pixel_format
60 Set the pixel format of the images to read. If not specified the pixel
61 format is guessed from the first image file in the sequence.
62 @item start_number
63 Set the index of the file matched by the image file pattern to start
64 to read from. Default value is 0.
65 @item video_size
66 Set the video size of the images to read. If not specified the video
67 size is guessed from the first image file in the sequence.
68 @end table
69
70 The following example shows how to use @command{ffmpeg} for creating a
71 video from the images in the file sequence @file{img-001.jpeg},
72 @file{img-002.jpeg}, ..., assuming an input frame rate of 10 frames per
73 second:
74 @example
75 ffmpeg -i 'img-%03d.jpeg' -r 10 out.mkv
76 @end example
77
78 As above, but start by reading from a file with index 100 in the sequence:
79 @example
80 ffmpeg -start_number 100 -i 'img-%03d.jpeg' -r 10 out.mkv
81 @end example
82
83 Note that the pattern must not necessarily contain "%d" or
84 "%0@var{N}d", for example to convert a single image file
85 @file{img.jpeg} you can employ the command:
86 @example
87 ffmpeg -i img.jpeg img.png
88 @end example
89
90 @section applehttp
91
92 Apple HTTP Live Streaming demuxer.
93
94 This demuxer presents all AVStreams from all variant streams.
95 The id field is set to the bitrate variant index number. By setting
96 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
97 the caller can decide which variant streams to actually receive.
98 The total bitrate of the variant that the stream belongs to is
99 available in a metadata key named "variant_bitrate".
100
101 @section sbg
102
103 SBaGen script demuxer.
104
105 This demuxer reads the script language used by SBaGen
106 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
107 script looks like that:
108 @example
109 -SE
110 a: 300-2.5/3 440+4.5/0
111 b: 300-2.5/0 440+4.5/3
112 off: -
113 NOW      == a
114 +0:07:00 == b
115 +0:14:00 == a
116 +0:21:00 == b
117 +0:30:00    off
118 @end example
119
120 A SBG script can mix absolute and relative timestamps. If the script uses
121 either only absolute timestamps (including the script start time) or only
122 relative ones, then its layout is fixed, and the conversion is
123 straightforward. On the other hand, if the script mixes both kind of
124 timestamps, then the @var{NOW} reference for relative timestamps will be
125 taken from the current time of day at the time the script is read, and the
126 script layout will be frozen according to that reference. That means that if
127 the script is directly played, the actual times will match the absolute
128 timestamps up to the sound controller's clock accuracy, but if the user
129 somehow pauses the playback or seeks, all times will be shifted accordingly.
130
131 @c man end INPUT DEVICES