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