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