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