lavf/concat: document the use of the files durations.
[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 @code{--list-demuxers}.
10
11 You can disable all the demuxers using the configure option
12 @code{--disable-demuxers}, and selectively enable a single demuxer with
13 the option @code{--enable-demuxer=@var{DEMUXER}}, or disable it
14 with the option @code{--disable-demuxer=@var{DEMUXER}}.
15
16 The option @code{-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 applehttp
22
23 Apple HTTP Live Streaming demuxer.
24
25 This demuxer presents all AVStreams from all variant streams.
26 The id field is set to the bitrate variant index number. By setting
27 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
28 the caller can decide which variant streams to actually receive.
29 The total bitrate of the variant that the stream belongs to is
30 available in a metadata key named "variant_bitrate".
31
32 @section concat
33
34 Virtual concatenation script demuxer.
35
36 This demuxer reads a list of files and other directives from a text file and
37 demuxes them one after the other, as if all their packet had been muxed
38 together.
39
40 The timestamps in the files are adjusted so that the first file starts at 0
41 and each next file starts where the previous one finishes. Note that it is
42 done globally and may cause gaps if all streams do not have exactly the same
43 length.
44
45 All files must have the same streams (same codecs, same time base, etc.).
46
47 The duration of each file is used to adjust the timestamps of the next file:
48 if the duration is incorrect (because it was computed using the bit-rate or
49 because the file is truncated, for example), it can cause artifacts. The
50 @code{duration} directive can be used to override the duration stored in
51 each file.
52
53 @subsection Syntax
54
55 The script is a text file in extended-ASCII, with one directive per line.
56 Empty lines, leading spaces and lines starting with '#' are ignored. The
57 following directive is recognized:
58
59 @table @option
60
61 @item @code{file @var{path}}
62 Path to a file to read; special characters and spaces must be escaped with
63 backslash or single quotes.
64
65 All subsequent directives apply to that file.
66
67 @item @code{ffconcat version 1.0}
68 Identify the script type and version. It also sets the @option{safe} option
69 to 1 if it was to its default -1.
70
71 To make FFmpeg recognize the format automatically, this directive must
72 appears exactly as is (no extra space or byte-order-mark) on the very first
73 line of the script.
74
75 @item @code{duration @var{dur}}
76 Duration of the file. This information can be specified from the file;
77 specifying it here may be more efficient or help if the information from the
78 file is not available or accurate.
79
80 @end table
81
82 @subsection Options
83
84 This demuxer accepts the following option:
85
86 @table @option
87
88 @item safe
89 If set to 1, reject unsafe file paths. A file path is considered safe if it
90 does not contain a protocol specification and is relative and all components
91 only contain characters from the portable character set (letters, digits,
92 period, underscore and hyphen) and have no period at the beginning of a
93 component.
94
95 If set to 0, any file name is accepted.
96
97 The default is -1, it is equivalent to 1 if the format was automatically
98 probed and 0 otherwise.
99
100 @end table
101
102 @section image2
103
104 Image file demuxer.
105
106 This demuxer reads from a list of image files specified by a pattern.
107 The syntax and meaning of the pattern is specified by the
108 option @var{pattern_type}.
109
110 The pattern may contain a suffix which is used to automatically
111 determine the format of the images contained in the files.
112
113 The size, the pixel format, and the format of each image must be the
114 same for all the files in the sequence.
115
116 This demuxer accepts the following options:
117 @table @option
118 @item framerate
119 Set the framerate for the video stream. It defaults to 25.
120 @item loop
121 If set to 1, loop over the input. Default value is 0.
122 @item pattern_type
123 Select the pattern type used to interpret the provided filename.
124
125 @var{pattern_type} accepts one of the following values.
126 @table @option
127 @item sequence
128 Select a sequence pattern type, used to specify a sequence of files
129 indexed by sequential numbers.
130
131 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
132 specifies the position of the characters representing a sequential
133 number in each filename matched by the pattern. If the form
134 "%d0@var{N}d" is used, the string representing the number in each
135 filename is 0-padded and @var{N} is the total number of 0-padded
136 digits representing the number. The literal character '%' can be
137 specified in the pattern with the string "%%".
138
139 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
140 the file list specified by the pattern must contain a number
141 inclusively contained between @var{start_number} and
142 @var{start_number}+@var{start_number_range}-1, and all the following
143 numbers must be sequential.
144
145 For example the pattern "img-%03d.bmp" will match a sequence of
146 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
147 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
148 sequence of filenames of the form @file{i%m%g-1.jpg},
149 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
150
151 Note that the pattern must not necessarily contain "%d" or
152 "%0@var{N}d", for example to convert a single image file
153 @file{img.jpeg} you can employ the command:
154 @example
155 ffmpeg -i img.jpeg img.png
156 @end example
157
158 @item glob
159 Select a glob wildcard pattern type.
160
161 The pattern is interpreted like a @code{glob()} pattern. This is only
162 selectable if libavformat was compiled with globbing support.
163
164 @item glob_sequence @emph{(deprecated, will be removed)}
165 Select a mixed glob wildcard/sequence pattern.
166
167 If your version of libavformat was compiled with globbing support, and
168 the provided pattern contains at least one glob meta character among
169 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
170 interpreted like a @code{glob()} pattern, otherwise it is interpreted
171 like a sequence pattern.
172
173 All glob special characters @code{%*?[]@{@}} must be prefixed
174 with "%". To escape a literal "%" you shall use "%%".
175
176 For example the pattern @code{foo-%*.jpeg} will match all the
177 filenames prefixed by "foo-" and terminating with ".jpeg", and
178 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
179 "foo-", followed by a sequence of three characters, and terminating
180 with ".jpeg".
181
182 This pattern type is deprecated in favor of @var{glob} and
183 @var{sequence}.
184 @end table
185
186 Default value is @var{glob_sequence}.
187 @item pixel_format
188 Set the pixel format of the images to read. If not specified the pixel
189 format is guessed from the first image file in the sequence.
190 @item start_number
191 Set the index of the file matched by the image file pattern to start
192 to read from. Default value is 0.
193 @item start_number_range
194 Set the index interval range to check when looking for the first image
195 file in the sequence, starting from @var{start_number}. Default value
196 is 5.
197 @item video_size
198 Set the video size of the images to read. If not specified the video
199 size is guessed from the first image file in the sequence.
200 @end table
201
202 @subsection Examples
203
204 @itemize
205 @item
206 Use @command{ffmpeg} for creating a video from the images in the file
207 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
208 input frame rate of 10 frames per second:
209 @example
210 ffmpeg -i 'img-%03d.jpeg' -r 10 out.mkv
211 @end example
212
213 @item
214 As above, but start by reading from a file with index 100 in the sequence:
215 @example
216 ffmpeg -start_number 100 -i 'img-%03d.jpeg' -r 10 out.mkv
217 @end example
218
219 @item
220 Read images matching the "*.png" glob pattern , that is all the files
221 terminating with the ".png" suffix:
222 @example
223 ffmpeg -pattern_type glob -i "*.png" -r 10 out.mkv
224 @end example
225 @end itemize
226
227 @section rawvideo
228
229 Raw video demuxer.
230
231 This demuxer allows to read raw video data. Since there is no header
232 specifying the assumed video parameters, the user must specify them
233 in order to be able to decode the data correctly.
234
235 This demuxer accepts the following options:
236 @table @option
237
238 @item framerate
239 Set input video frame rate. Default value is 25.
240
241 @item pixel_format
242 Set the input video pixel format. Default value is @code{yuv420p}.
243
244 @item video_size
245 Set the input video size. This value must be specified explicitly.
246 @end table
247
248 For example to read a rawvideo file @file{input.raw} with
249 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
250 size of @code{320x240}, and a frame rate of 10 images per second, use
251 the command:
252 @example
253 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
254 @end example
255
256 @section sbg
257
258 SBaGen script demuxer.
259
260 This demuxer reads the script language used by SBaGen
261 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
262 script looks like that:
263 @example
264 -SE
265 a: 300-2.5/3 440+4.5/0
266 b: 300-2.5/0 440+4.5/3
267 off: -
268 NOW      == a
269 +0:07:00 == b
270 +0:14:00 == a
271 +0:21:00 == b
272 +0:30:00    off
273 @end example
274
275 A SBG script can mix absolute and relative timestamps. If the script uses
276 either only absolute timestamps (including the script start time) or only
277 relative ones, then its layout is fixed, and the conversion is
278 straightforward. On the other hand, if the script mixes both kind of
279 timestamps, then the @var{NOW} reference for relative timestamps will be
280 taken from the current time of day at the time the script is read, and the
281 script layout will be frozen according to that reference. That means that if
282 the script is directly played, the actual times will match the absolute
283 timestamps up to the sound controller's clock accuracy, but if the user
284 somehow pauses the playback or seeks, all times will be shifted accordingly.
285
286 @section tedcaptions
287
288 JSON captions used for @url{http://www.ted.com/, TED Talks}.
289
290 TED does not provide links to the captions, but they can be guessed from the
291 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
292 contains a bookmarklet to expose them.
293
294 This demuxer accepts the following option:
295 @table @option
296 @item start_time
297 Set the start time of the TED talk, in milliseconds. The default is 15000
298 (15s). It is used to sync the captions with the downloadable videos, because
299 they include a 15s intro.
300 @end table
301
302 Example: convert the captions to a format most players understand:
303 @example
304 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
305 @end example
306
307 @c man end DEMUXERS