lavf/img2dec: add and document pattern_type option
[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 The syntax and meaning of the pattern is specified by the
27 option @var{pattern_type}.
28
29 The pattern may contain a suffix which is used to automatically
30 determine the format of the images contained in the files.
31
32 The size, the pixel format, and the format of each image must be the
33 same for all the files in the sequence.
34
35 This demuxer accepts the following options:
36 @table @option
37 @item framerate
38 Set the framerate for the video stream. It defaults to 25.
39 @item loop
40 If set to 1, loop over the input. Default value is 0.
41 @item pattern_type
42 Select the pattern type used to interpret the provided filename.
43
44 @var{pattern_type} accepts one of the following values.
45 @table @option
46 @item sequence
47 Select a sequence pattern type, used to specify a sequence of files
48 indexed by sequential numbers.
49
50 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
51 specifies the position of the characters representing a sequential
52 number in each filename matched by the pattern. If the form
53 "%d0@var{N}d" is used, the string representing the number in each
54 filename is 0-padded and @var{N} is the total number of 0-padded
55 digits representing the number. The literal character '%' can be
56 specified in the pattern with the string "%%".
57
58 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
59 the file list specified by the pattern must contain a number
60 inclusively contained between @var{start_number} and
61 @var{start_number}+@var{start_number_range}-1, and all the following
62 numbers must be sequential.
63
64 For example the pattern "img-%03d.bmp" will match a sequence of
65 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
66 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
67 sequence of filenames of the form @file{i%m%g-1.jpg},
68 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
69
70 Note that the pattern must not necessarily contain "%d" or
71 "%0@var{N}d", for example to convert a single image file
72 @file{img.jpeg} you can employ the command:
73 @example
74 ffmpeg -i img.jpeg img.png
75 @end example
76
77 @item glob
78 Select a glob wildcard pattern type.
79
80 The pattern is interpreted like a @code{glob()} pattern. This is only
81 selectable if libavformat was compiled with globbing support.
82
83 @item glob_sequence @emph{(deprecated, will be removed)}
84 Select a mixed glob wildcard/sequence pattern.
85
86 If your version of libavformat was compiled with globbing support, and
87 the provided pattern contains at least one glob meta character among
88 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
89 interpreted like a @code{glob()} pattern, otherwise it is interpreted
90 like a sequence pattern.
91
92 All glob special characters @code{%*?[]@{@}} must be prefixed
93 with "%". To escape a literal "%" you shall use "%%".
94
95 For example the pattern @code{foo-%*.jpeg} will match all the
96 filenames prefixed by "foo-" and terminating with ".jpeg", and
97 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
98 "foo-", followed by a sequence of three characters, and terminating
99 with ".jpeg".
100
101 This pattern type is deprecated in favor of @var{glob} and
102 @var{sequence}.
103 @end table
104
105 Default value is @var{glob_sequence}.
106 @item pixel_format
107 Set the pixel format of the images to read. If not specified the pixel
108 format is guessed from the first image file in the sequence.
109 @item start_number
110 Set the index of the file matched by the image file pattern to start
111 to read from. Default value is 0.
112 @item start_number_range
113 Set the index interval range to check when looking for the first image
114 file in the sequence, starting from @var{start_number}. Default value
115 is 5.
116 @item video_size
117 Set the video size of the images to read. If not specified the video
118 size is guessed from the first image file in the sequence.
119 @end table
120
121 @subsection Examples
122
123 @itemize
124 @item
125 Use @command{ffmpeg} for creating a video from the images in the file
126 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
127 input frame rate of 10 frames per second:
128 @example
129 ffmpeg -i 'img-%03d.jpeg' -r 10 out.mkv
130 @end example
131
132 @item
133 As above, but start by reading from a file with index 100 in the sequence:
134 @example
135 ffmpeg -start_number 100 -i 'img-%03d.jpeg' -r 10 out.mkv
136 @end example
137
138 @item
139 Read images matching the "*.png" glob pattern , that is all the files
140 terminating with the ".png" suffix:
141 @example
142 ffmpeg -pattern_type glob -i "*.png" -r 10 out.mkv
143 @end example
144 @end itemize
145
146 @section applehttp
147
148 Apple HTTP Live Streaming demuxer.
149
150 This demuxer presents all AVStreams from all variant streams.
151 The id field is set to the bitrate variant index number. By setting
152 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
153 the caller can decide which variant streams to actually receive.
154 The total bitrate of the variant that the stream belongs to is
155 available in a metadata key named "variant_bitrate".
156
157 @section sbg
158
159 SBaGen script demuxer.
160
161 This demuxer reads the script language used by SBaGen
162 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
163 script looks like that:
164 @example
165 -SE
166 a: 300-2.5/3 440+4.5/0
167 b: 300-2.5/0 440+4.5/3
168 off: -
169 NOW      == a
170 +0:07:00 == b
171 +0:14:00 == a
172 +0:21:00 == b
173 +0:30:00    off
174 @end example
175
176 A SBG script can mix absolute and relative timestamps. If the script uses
177 either only absolute timestamps (including the script start time) or only
178 relative ones, then its layout is fixed, and the conversion is
179 straightforward. On the other hand, if the script mixes both kind of
180 timestamps, then the @var{NOW} reference for relative timestamps will be
181 taken from the current time of day at the time the script is read, and the
182 script layout will be frozen according to that reference. That means that if
183 the script is directly played, the actual times will match the absolute
184 timestamps up to the sound controller's clock accuracy, but if the user
185 somehow pauses the playback or seeks, all times will be shifted accordingly.
186
187 @c man end INPUT DEVICES