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