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