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