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