Merge commit '21015109ec0fac0f104a5355f272ecb956ba3f4e'
[ffmpeg.git] / doc / demuxers.texi
1 @chapter Demuxers
2 @c man begin DEMUXERS
3
4 Demuxers are configured elements in FFmpeg that can 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 @anchor{concat}
33 @section concat
34
35 Virtual concatenation script demuxer.
36
37 This demuxer reads a list of files and other directives from a text file and
38 demuxes them one after the other, as if all their packet had been muxed
39 together.
40
41 The timestamps in the files are adjusted so that the first file starts at 0
42 and each next file starts where the previous one finishes. Note that it is
43 done globally and may cause gaps if all streams do not have exactly the same
44 length.
45
46 All files must have the same streams (same codecs, same time base, etc.).
47
48 The duration of each file is used to adjust the timestamps of the next file:
49 if the duration is incorrect (because it was computed using the bit-rate or
50 because the file is truncated, for example), it can cause artifacts. The
51 @code{duration} directive can be used to override the duration stored in
52 each file.
53
54 @subsection Syntax
55
56 The script is a text file in extended-ASCII, with one directive per line.
57 Empty lines, leading spaces and lines starting with '#' are ignored. The
58 following directive is recognized:
59
60 @table @option
61
62 @item @code{file @var{path}}
63 Path to a file to read; special characters and spaces must be escaped with
64 backslash or single quotes.
65
66 All subsequent directives apply to that file.
67
68 @item @code{ffconcat version 1.0}
69 Identify the script type and version. It also sets the @option{safe} option
70 to 1 if it was to its default -1.
71
72 To make FFmpeg recognize the format automatically, this directive must
73 appears exactly as is (no extra space or byte-order-mark) on the very first
74 line of the script.
75
76 @item @code{duration @var{dur}}
77 Duration of the file. This information can be specified from the file;
78 specifying it here may be more efficient or help if the information from the
79 file is not available or accurate.
80
81 If the duration is set for all files, then it is possible to seek in the
82 whole concatenated video.
83
84 @end table
85
86 @subsection Options
87
88 This demuxer accepts the following option:
89
90 @table @option
91
92 @item safe
93 If set to 1, reject unsafe file paths. A file path is considered safe if it
94 does not contain a protocol specification and is relative and all components
95 only contain characters from the portable character set (letters, digits,
96 period, underscore and hyphen) and have no period at the beginning of a
97 component.
98
99 If set to 0, any file name is accepted.
100
101 The default is -1, it is equivalent to 1 if the format was automatically
102 probed and 0 otherwise.
103
104 @end table
105
106 @section flv
107
108 Adobe Flash Video Format demuxer.
109
110 This demuxer is used to demux FLV files and RTMP network streams.
111
112 @table @option
113 @item -flv_demuxer @var{bool}
114 Allocate the streams according to the onMetaData array content.
115 @end table
116
117 @section libgme
118
119 The Game Music Emu library is a collection of video game music file emulators.
120
121 See @url{http://code.google.com/p/game-music-emu/} for more information.
122
123 Some files have multiple tracks. The demuxer will pick the first track by
124 default. The @option{track_index} option can be used to select a different
125 track. Track indexes start at 0. The demuxer exports the number of tracks as
126 @var{tracks} meta data entry.
127
128 For very large files, the @option{max_size} option may have to be adjusted.
129
130 @section libquvi
131
132 Play media from Internet services using the quvi project.
133
134 The demuxer accepts a @option{format} option to request a specific quality. It
135 is by default set to @var{best}.
136
137 See @url{http://quvi.sourceforge.net/} for more information.
138
139 FFmpeg needs to be built with @code{--enable-libquvi} for this demuxer to be
140 enabled.
141
142 @section image2
143
144 Image file demuxer.
145
146 This demuxer reads from a list of image files specified by a pattern.
147 The syntax and meaning of the pattern is specified by the
148 option @var{pattern_type}.
149
150 The pattern may contain a suffix which is used to automatically
151 determine the format of the images contained in the files.
152
153 The size, the pixel format, and the format of each image must be the
154 same for all the files in the sequence.
155
156 This demuxer accepts the following options:
157 @table @option
158 @item framerate
159 Set the frame rate for the video stream. It defaults to 25.
160 @item loop
161 If set to 1, loop over the input. Default value is 0.
162 @item pattern_type
163 Select the pattern type used to interpret the provided filename.
164
165 @var{pattern_type} accepts one of the following values.
166 @table @option
167 @item sequence
168 Select a sequence pattern type, used to specify a sequence of files
169 indexed by sequential numbers.
170
171 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
172 specifies the position of the characters representing a sequential
173 number in each filename matched by the pattern. If the form
174 "%d0@var{N}d" is used, the string representing the number in each
175 filename is 0-padded and @var{N} is the total number of 0-padded
176 digits representing the number. The literal character '%' can be
177 specified in the pattern with the string "%%".
178
179 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
180 the file list specified by the pattern must contain a number
181 inclusively contained between @var{start_number} and
182 @var{start_number}+@var{start_number_range}-1, and all the following
183 numbers must be sequential.
184
185 For example the pattern "img-%03d.bmp" will match a sequence of
186 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
187 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
188 sequence of filenames of the form @file{i%m%g-1.jpg},
189 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
190
191 Note that the pattern must not necessarily contain "%d" or
192 "%0@var{N}d", for example to convert a single image file
193 @file{img.jpeg} you can employ the command:
194 @example
195 ffmpeg -i img.jpeg img.png
196 @end example
197
198 @item glob
199 Select a glob wildcard pattern type.
200
201 The pattern is interpreted like a @code{glob()} pattern. This is only
202 selectable if libavformat was compiled with globbing support.
203
204 @item glob_sequence @emph{(deprecated, will be removed)}
205 Select a mixed glob wildcard/sequence pattern.
206
207 If your version of libavformat was compiled with globbing support, and
208 the provided pattern contains at least one glob meta character among
209 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
210 interpreted like a @code{glob()} pattern, otherwise it is interpreted
211 like a sequence pattern.
212
213 All glob special characters @code{%*?[]@{@}} must be prefixed
214 with "%". To escape a literal "%" you shall use "%%".
215
216 For example the pattern @code{foo-%*.jpeg} will match all the
217 filenames prefixed by "foo-" and terminating with ".jpeg", and
218 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
219 "foo-", followed by a sequence of three characters, and terminating
220 with ".jpeg".
221
222 This pattern type is deprecated in favor of @var{glob} and
223 @var{sequence}.
224 @end table
225
226 Default value is @var{glob_sequence}.
227 @item pixel_format
228 Set the pixel format of the images to read. If not specified the pixel
229 format is guessed from the first image file in the sequence.
230 @item start_number
231 Set the index of the file matched by the image file pattern to start
232 to read from. Default value is 0.
233 @item start_number_range
234 Set the index interval range to check when looking for the first image
235 file in the sequence, starting from @var{start_number}. Default value
236 is 5.
237 @item ts_from_file
238 If set to 1, will set frame timestamp to modification time of image file. Note
239 that monotonity of timestamps is not provided: images go in the same order as
240 without this option. Default value is 0.
241 @item video_size
242 Set the video size of the images to read. If not specified the video
243 size is guessed from the first image file in the sequence.
244 @end table
245
246 @subsection Examples
247
248 @itemize
249 @item
250 Use @command{ffmpeg} for creating a video from the images in the file
251 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
252 input frame rate of 10 frames per second:
253 @example
254 ffmpeg -i 'img-%03d.jpeg' -r 10 out.mkv
255 @end example
256
257 @item
258 As above, but start by reading from a file with index 100 in the sequence:
259 @example
260 ffmpeg -start_number 100 -i 'img-%03d.jpeg' -r 10 out.mkv
261 @end example
262
263 @item
264 Read images matching the "*.png" glob pattern , that is all the files
265 terminating with the ".png" suffix:
266 @example
267 ffmpeg -pattern_type glob -i "*.png" -r 10 out.mkv
268 @end example
269 @end itemize
270
271 @section mpegts
272
273 MPEG-2 transport stream demuxer.
274
275 @table @option
276
277 @item fix_teletext_pts
278 Overrides teletext packet PTS and DTS values with the timestamps calculated
279 from the PCR of the first program which the teletext stream is part of and is
280 not discarded. Default value is 1, set this option to 0 if you want your
281 teletext packet PTS and DTS values untouched.
282 @end table
283
284 @section rawvideo
285
286 Raw video demuxer.
287
288 This demuxer allows to read raw video data. Since there is no header
289 specifying the assumed video parameters, the user must specify them
290 in order to be able to decode the data correctly.
291
292 This demuxer accepts the following options:
293 @table @option
294
295 @item framerate
296 Set input video frame rate. Default value is 25.
297
298 @item pixel_format
299 Set the input video pixel format. Default value is @code{yuv420p}.
300
301 @item video_size
302 Set the input video size. This value must be specified explicitly.
303 @end table
304
305 For example to read a rawvideo file @file{input.raw} with
306 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
307 size of @code{320x240}, and a frame rate of 10 images per second, use
308 the command:
309 @example
310 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
311 @end example
312
313 @section sbg
314
315 SBaGen script demuxer.
316
317 This demuxer reads the script language used by SBaGen
318 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
319 script looks like that:
320 @example
321 -SE
322 a: 300-2.5/3 440+4.5/0
323 b: 300-2.5/0 440+4.5/3
324 off: -
325 NOW      == a
326 +0:07:00 == b
327 +0:14:00 == a
328 +0:21:00 == b
329 +0:30:00    off
330 @end example
331
332 A SBG script can mix absolute and relative timestamps. If the script uses
333 either only absolute timestamps (including the script start time) or only
334 relative ones, then its layout is fixed, and the conversion is
335 straightforward. On the other hand, if the script mixes both kind of
336 timestamps, then the @var{NOW} reference for relative timestamps will be
337 taken from the current time of day at the time the script is read, and the
338 script layout will be frozen according to that reference. That means that if
339 the script is directly played, the actual times will match the absolute
340 timestamps up to the sound controller's clock accuracy, but if the user
341 somehow pauses the playback or seeks, all times will be shifted accordingly.
342
343 @section tedcaptions
344
345 JSON captions used for @url{http://www.ted.com/, TED Talks}.
346
347 TED does not provide links to the captions, but they can be guessed from the
348 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
349 contains a bookmarklet to expose them.
350
351 This demuxer accepts the following option:
352 @table @option
353 @item start_time
354 Set the start time of the TED talk, in milliseconds. The default is 15000
355 (15s). It is used to sync the captions with the downloadable videos, because
356 they include a 15s intro.
357 @end table
358
359 Example: convert the captions to a format most players understand:
360 @example
361 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
362 @end example
363
364 @c man end DEMUXERS