doc: add syntax.texi file
[ffmpeg.git] / doc / ffmpeg.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle ffmpeg Documentation
4 @titlepage
5 @center @titlefont{ffmpeg Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Synopsis
13
14 The generic syntax is:
15
16 @example
17 @c man begin SYNOPSIS
18 ffmpeg [global options] [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 ffmpeg is a very fast video and audio converter that can also grab from
26 a live audio/video source. It can also convert between arbitrary sample
27 rates and resize video on the fly with a high quality polyphase filter.
28
29 ffmpeg reads from an arbitrary number of input "files" (which can be regular
30 files, pipes, network streams, grabbing devices, etc.), specified by the
31 @code{-i} option, and writes to an arbitrary number of output "files", which are
32 specified by a plain output filename. Anything found on the command line which
33 cannot be interpreted as an option is considered to be an output filename.
34
35 Each input or output file can in principle contain any number of streams of
36 different types (video/audio/subtitle/attachment/data). Allowed number and/or
37 types of streams can be limited by the container format. Selecting, which
38 streams from which inputs go into output, is done either automatically or with
39 the @code{-map} option (see the Stream selection chapter).
40
41 To refer to input files in options, you must use their indices (0-based). E.g.
42 the first input file is @code{0}, the second is @code{1} etc. Similarly, streams
43 within a file are referred to by their indices. E.g. @code{2:3} refers to the
44 fourth stream in the third input file. See also the Stream specifiers chapter.
45
46 As a general rule, options are applied to the next specified
47 file. Therefore, order is important, and you can have the same
48 option on the command line multiple times. Each occurrence is
49 then applied to the next input or output file.
50 Exceptions from this rule are the global options (e.g. verbosity level),
51 which should be specified first.
52
53 Do not mix input and output files -- first specify all input files, then all
54 output files. Also do not mix options which belong to different files. All
55 options apply ONLY to the next input or output file and are reset between files.
56
57 @itemize
58 @item
59 To set the video bitrate of the output file to 64kbit/s:
60 @example
61 ffmpeg -i input.avi -b:v 64k output.avi
62 @end example
63
64 @item
65 To force the frame rate of the output file to 24 fps:
66 @example
67 ffmpeg -i input.avi -r 24 output.avi
68 @end example
69
70 @item
71 To force the frame rate of the input file (valid for raw formats only)
72 to 1 fps and the frame rate of the output file to 24 fps:
73 @example
74 ffmpeg -r 1 -i input.m2v -r 24 output.avi
75 @end example
76 @end itemize
77
78 The format option may be needed for raw input files.
79
80 @c man end DESCRIPTION
81
82 @chapter Stream selection
83 @c man begin STREAM SELECTION
84
85 By default ffmpeg includes only one stream of each type (video, audio, subtitle)
86 present in the input files and adds them to each output file.  It picks the
87 "best" of each based upon the following criteria; for video it is the stream
88 with the highest resolution, for audio the stream with the most channels, for
89 subtitle it's the first subtitle stream. In the case where several streams of
90 the same type rate equally, the lowest numbered stream is chosen.
91
92 You can disable some of those defaults by using @code{-vn/-an/-sn} options. For
93 full manual control, use the @code{-map} option, which disables the defaults just
94 described.
95
96 @c man end STREAM SELECTION
97
98 @chapter Options
99 @c man begin OPTIONS
100
101 @include avtools-common-opts.texi
102
103 @section Main options
104
105 @table @option
106
107 @item -f @var{fmt} (@emph{input/output})
108 Force input or output file format. The format is normally auto detected for input
109 files and guessed from file extension for output files, so this option is not
110 needed in most cases.
111
112 @item -i @var{filename} (@emph{input})
113 input file name
114
115 @item -y (@emph{global})
116 Overwrite output files without asking.
117
118 @item -n (@emph{global})
119 Do not overwrite output files but exit if file exists.
120
121 @item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
122 @itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
123 Select an encoder (when used before an output file) or a decoder (when used
124 before an input file) for one or more streams. @var{codec} is the name of a
125 decoder/encoder or a special value @code{copy} (output only) to indicate that
126 the stream is not to be re-encoded.
127
128 For example
129 @example
130 ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
131 @end example
132 encodes all video streams with libx264 and copies all audio streams.
133
134 For each stream, the last matching @code{c} option is applied, so
135 @example
136 ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
137 @end example
138 will copy all the streams except the second video, which will be encoded with
139 libx264, and the 138th audio, which will be encoded with libvorbis.
140
141 @item -t @var{duration} (@emph{output})
142 Stop writing the output after its duration reaches @var{duration}.
143 @var{duration} may be a number in seconds, or in @code{hh:mm:ss[.xxx]} form.
144
145 @item -fs @var{limit_size} (@emph{output})
146 Set the file size limit, expressed in bytes.
147
148 @item -ss @var{position} (@emph{input/output})
149 When used as an input option (before @code{-i}), seeks in this input file to
150 @var{position}. When used as an output option (before an output filename),
151 decodes but discards input until the timestamps reach @var{position}. This is
152 slower, but more accurate.
153
154 @var{position} may be either in seconds or in @code{hh:mm:ss[.xxx]} form.
155
156 @item -itsoffset @var{offset} (@emph{input})
157 Set the input time offset in seconds.
158 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
159 The offset is added to the timestamps of the input files.
160 Specifying a positive offset means that the corresponding
161 streams are delayed by @var{offset} seconds.
162
163 @item -timestamp @var{time} (@emph{output})
164 Set the recording timestamp in the container.
165 The syntax for @var{time} is:
166 @example
167 now|([(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...])|(HHMMSS[.m...]))[Z|z])
168 @end example
169 If the value is "now" it takes the current time.
170 Time is local time unless 'Z' or 'z' is appended, in which case it is
171 interpreted as UTC.
172 If the year-month-day part is not specified it takes the current
173 year-month-day.
174
175 @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
176 Set a metadata key/value pair.
177
178 An optional @var{metadata_specifier} may be given to set metadata
179 on streams or chapters. See @code{-map_metadata} documentation for
180 details.
181
182 This option overrides metadata set with @code{-map_metadata}. It is
183 also possible to delete metadata by using an empty value.
184
185 For example, for setting the title in the output file:
186 @example
187 ffmpeg -i in.avi -metadata title="my title" out.flv
188 @end example
189
190 To set the language of the first audio stream:
191 @example
192 ffmpeg -i INPUT -metadata:s:a:1 language=eng OUTPUT
193 @end example
194
195 @item -target @var{type} (@emph{output})
196 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
197 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
198 @code{film-} to use the corresponding standard. All the format options
199 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
200
201 @example
202 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
203 @end example
204
205 Nevertheless you can specify additional options as long as you know
206 they do not conflict with the standard, as in:
207
208 @example
209 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
210 @end example
211
212 @item -dframes @var{number} (@emph{output})
213 Set the number of data frames to record. This is an alias for @code{-frames:d}.
214
215 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
216 Stop writing to the stream after @var{framecount} frames.
217
218 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
219 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
220 Use fixed quality scale (VBR). The meaning of @var{q} is
221 codec-dependent.
222
223 @item -filter[:@var{stream_specifier}] @var{filter_graph} (@emph{output,per-stream})
224 @var{filter_graph} is a description of the filter graph to apply to
225 the stream. Use @code{-filters} to show all the available filters
226 (including also sources and sinks).
227
228 See also the @option{-filter_complex} option if you want to create filter graphs
229 with multiple inputs and/or outputs.
230 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
231 Specify the preset for matching stream(s).
232
233 @item -stats (@emph{global})
234 Print encoding progress/statistics. On by default.
235
236 @item -debug_ts (@emph{global})
237 Print timestamp information. It is off by default. This option is
238 mostly useful for testing and debugging purposes, and the output
239 format may change from one version to another, so it should not be
240 employed by portable scripts.
241
242 See also the option @code{-fdebug ts}.
243
244 @item -attach @var{filename} (@emph{output})
245 Add an attachment to the output file. This is supported by a few formats
246 like Matroska for e.g. fonts used in rendering subtitles. Attachments
247 are implemented as a specific type of stream, so this option will add
248 a new stream to the file. It is then possible to use per-stream options
249 on this stream in the usual way. Attachment streams created with this
250 option will be created after all the other streams (i.e. those created
251 with @code{-map} or automatic mappings).
252
253 Note that for Matroska you also have to set the mimetype metadata tag:
254 @example
255 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
256 @end example
257 (assuming that the attachment stream will be third in the output file).
258
259 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
260 Extract the matching attachment stream into a file named @var{filename}. If
261 @var{filename} is empty, then the value of the @code{filename} metadata tag
262 will be used.
263
264 E.g. to extract the first attachment to a file named 'out.ttf':
265 @example
266 ffmpeg -dump_attachment:t:0 out.ttf INPUT
267 @end example
268 To extract all attachments to files determined by the @code{filename} tag:
269 @example
270 ffmpeg -dump_attachment:t "" INPUT
271 @end example
272
273 Technical note -- attachments are implemented as codec extradata, so this
274 option can actually be used to extract extradata from any stream, not just
275 attachments.
276
277 @end table
278
279 @section Video Options
280
281 @table @option
282 @item -vframes @var{number} (@emph{output})
283 Set the number of video frames to record. This is an alias for @code{-frames:v}.
284 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
285 Set frame rate (Hz value, fraction or abbreviation), (default = 25). For output
286 streams implies @code{-vsync cfr}.
287 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
288 Set frame size. The format is @samp{wxh} (default - same as source).
289
290 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
291 Set the video display aspect ratio specified by @var{aspect}.
292
293 @var{aspect} can be a floating point number string, or a string of the
294 form @var{num}:@var{den}, where @var{num} and @var{den} are the
295 numerator and denominator of the aspect ratio. For example "4:3",
296 "16:9", "1.3333", and "1.7777" are valid argument values.
297
298 @item -croptop @var{size}
299 @item -cropbottom @var{size}
300 @item -cropleft @var{size}
301 @item -cropright @var{size}
302 All the crop options have been removed. Use -vf
303 crop=width:height:x:y instead.
304
305 @item -padtop @var{size}
306 @item -padbottom @var{size}
307 @item -padleft @var{size}
308 @item -padright @var{size}
309 @item -padcolor @var{hex_color}
310 All the pad options have been removed. Use -vf
311 pad=width:height:x:y:color instead.
312
313 @item -vn (@emph{output})
314 Disable video recording.
315
316 @item -vcodec @var{codec} (@emph{output})
317 Set the video codec. This is an alias for @code{-codec:v}.
318 @item -same_quant
319 Use same quantizer as source (implies VBR).
320
321 Note that this is NOT SAME QUALITY. Do not use this option unless you know you
322 need it.
323
324 @item -pass @var{n}
325 Select the pass number (1 or 2). It is used to do two-pass
326 video encoding. The statistics of the video are recorded in the first
327 pass into a log file (see also the option -passlogfile),
328 and in the second pass that log file is used to generate the video
329 at the exact requested bitrate.
330 On pass 1, you may just deactivate audio and set output to null,
331 examples for Windows and Unix:
332 @example
333 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
334 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
335 @end example
336
337 @item -passlogfile @var{prefix} (@emph{global})
338 Set two-pass log file name prefix to @var{prefix}, the default file name
339 prefix is ``ffmpeg2pass''. The complete file name will be
340 @file{PREFIX-N.log}, where N is a number specific to the output
341 stream
342
343 @item -vlang @var{code}
344 Set the ISO 639 language code (3 letters) of the current video stream.
345
346 @item -vf @var{filter_graph} (@emph{output})
347 @var{filter_graph} is a description of the filter graph to apply to
348 the input video.
349 Use the option "-filters" to show all the available filters (including
350 also sources and sinks).  This is an alias for @code{-filter:v}.
351
352 @end table
353
354 @section Advanced Video Options
355
356 @table @option
357 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
358 Set pixel format. Use @code{-pix_fmts} to show all the supported
359 pixel formats.
360 If the selected pixel format can not be selected, ffmpeg will print a
361 warning and select the best pixel format supported by the encoder.
362 If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
363 if the requested pixel format can not be selected, and automatic conversions
364 inside filter graphs are disabled.
365 If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
366 as the input (or graph output) and automatic conversions are disabled.
367
368 @item -sws_flags @var{flags} (@emph{input/output})
369 Set SwScaler flags.
370 @item -vdt @var{n}
371 Discard threshold.
372
373 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
374 Rate control override for specific intervals, formatted as "int,int,int"
375 list separated with slashes. Two first values are the beginning and
376 end frame numbers, last one is quantizer to use if positive, or quality
377 factor if negative.
378
379 @item -deinterlace
380 Deinterlace pictures.
381 This option is deprecated since the deinterlacing is very low quality.
382 Use the yadif filter with @code{-filter:v yadif}.
383 @item -ilme
384 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
385 Use this option if your input file is interlaced and you want
386 to keep the interlaced format for minimum losses.
387 The alternative is to deinterlace the input stream with
388 @option{-deinterlace}, but deinterlacing introduces losses.
389 @item -psnr
390 Calculate PSNR of compressed frames.
391 @item -vstats
392 Dump video coding statistics to @file{vstats_HHMMSS.log}.
393 @item -vstats_file @var{file}
394 Dump video coding statistics to @var{file}.
395 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
396 top=1/bottom=0/auto=-1 field first
397 @item -dc @var{precision}
398 Intra_dc_precision.
399 @item -vtag @var{fourcc/tag} (@emph{output})
400 Force video tag/fourcc. This is an alias for @code{-tag:v}.
401 @item -qphist (@emph{global})
402 Show QP histogram
403 @item -vbsf @var{bitstream_filter}
404 Deprecated see -bsf
405 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
406 Force key frames at the specified timestamps, more precisely at the first
407 frames after each specified time.
408 This option can be useful to ensure that a seek point is present at a
409 chapter mark or any other designated place in the output file.
410 The timestamps must be specified in ascending order.
411
412 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
413 When doing stream copy, copy also non-key frames found at the
414 beginning.
415 @end table
416
417 @section Audio Options
418
419 @table @option
420 @item -aframes @var{number} (@emph{output})
421 Set the number of audio frames to record. This is an alias for @code{-frames:a}.
422 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
423 Set the audio sampling frequency. For output streams it is set by
424 default to the frequency of the corresponding input stream. For input
425 streams this option only makes sense for audio grabbing devices and raw
426 demuxers and is mapped to the corresponding demuxer options.
427 @item -aq @var{q} (@emph{output})
428 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
429 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
430 Set the number of audio channels. For output streams it is set by
431 default to the number of input audio channels. For input streams
432 this option only makes sense for audio grabbing devices and raw demuxers
433 and is mapped to the corresponding demuxer options.
434 @item -an (@emph{output})
435 Disable audio recording.
436 @item -acodec @var{codec} (@emph{input/output})
437 Set the audio codec. This is an alias for @code{-codec:a}.
438 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
439 Set the audio sample format. Use @code{-sample_fmts} to get a list
440 of supported sample formats.
441 @item -af @var{filter_graph} (@emph{output})
442 @var{filter_graph} is a description of the filter graph to apply to
443 the input audio.
444 Use the option "-filters" to show all the available filters (including
445 also sources and sinks).  This is an alias for @code{-filter:a}.
446 @end table
447
448 @section Advanced Audio options:
449
450 @table @option
451 @item -atag @var{fourcc/tag} (@emph{output})
452 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
453 @item -absf @var{bitstream_filter}
454 Deprecated, see -bsf
455 @end table
456
457 @section Subtitle options:
458
459 @table @option
460 @item -slang @var{code}
461 Set the ISO 639 language code (3 letters) of the current subtitle stream.
462 @item -scodec @var{codec} (@emph{input/output})
463 Set the subtitle codec. This is an alias for @code{-codec:s}.
464 @item -sn (@emph{output})
465 Disable subtitle recording.
466 @item -sbsf @var{bitstream_filter}
467 Deprecated, see -bsf
468 @end table
469
470 @section Audio/Video grab options
471
472 @table @option
473 @item -isync (@emph{global})
474 Synchronize read on input.
475 @end table
476
477 @section Advanced options
478
479 @table @option
480 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
481
482 Designate one or more input streams as a source for the output file. Each input
483 stream is identified by the input file index @var{input_file_id} and
484 the input stream index @var{input_stream_id} within the input
485 file. Both indices start at 0. If specified,
486 @var{sync_file_id}:@var{stream_specifier} sets which input stream
487 is used as a presentation sync reference.
488
489 The first @code{-map} option on the command line specifies the
490 source for output stream 0, the second @code{-map} option specifies
491 the source for output stream 1, etc.
492
493 A @code{-} character before the stream identifier creates a "negative" mapping.
494 It disables matching streams from already created mappings.
495
496 An alternative @var{[linklabel]} form will map outputs from complex filter
497 graphs (see the @option{-filter_complex} option) to the output file.
498 @var{linklabel} must correspond to a defined output link label in the graph.
499
500 For example, to map ALL streams from the first input file to output
501 @example
502 ffmpeg -i INPUT -map 0 output
503 @end example
504
505 For example, if you have two audio streams in the first input file,
506 these streams are identified by "0:0" and "0:1". You can use
507 @code{-map} to select which streams to place in an output file. For
508 example:
509 @example
510 ffmpeg -i INPUT -map 0:1 out.wav
511 @end example
512 will map the input stream in @file{INPUT} identified by "0:1" to
513 the (single) output stream in @file{out.wav}.
514
515 For example, to select the stream with index 2 from input file
516 @file{a.mov} (specified by the identifier "0:2"), and stream with
517 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
518 and copy them to the output file @file{out.mov}:
519 @example
520 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
521 @end example
522
523 To select all video and the third audio stream from an input file:
524 @example
525 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
526 @end example
527
528 To map all the streams except the second audio, use negative mappings
529 @example
530 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
531 @end example
532
533 Note that using this option disables the default mappings for this output file.
534
535 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][:@var{output_file_id}.@var{stream_specifier}]
536 Map an audio channel from a given input to an output. If
537 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
538 be mapped on all the audio streams.
539
540 Using "-1" instead of
541 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
542 channel.
543
544 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
545 two audio channels with the following command:
546 @example
547 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
548 @end example
549
550 If you want to mute the first channel and keep the second:
551 @example
552 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
553 @end example
554
555 The order of the "-map_channel" option specifies the order of the channels in
556 the output stream. The output channel layout is guessed from the number of
557 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
558 in combination of "-map_channel" makes the channel gain levels to be updated if
559 input and output channel layouts don't match (for instance two "-map_channel"
560 options and "-ac 6").
561
562 You can also extract each channel of an input to specific outputs; the following
563 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
564 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
565 @example
566 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
567 @end example
568
569 The following example splits the channels of a stereo input into two separate
570 streams, which are put into the same output file:
571 @example
572 ffmpeg -i stereo.wav -map 0:0 -map 0:0 -map_channel 0.0.0:0.0 -map_channel 0.0.1:0.1 -y out.ogg
573 @end example
574
575 Note that currently each output stream can only contain channels from a single
576 input stream; you can't for example use "-map_channel" to pick multiple input
577 audio channels contained in different streams (from the same or different files)
578 and merge them into a single output stream. It is therefore not currently
579 possible, for example, to turn two separate mono streams into a single stereo
580 stream. However splitting a stereo stream into two single channel mono streams
581 is possible.
582
583 If you need this feature, a possible workaround is to use the @emph{amerge}
584 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
585 mono audio streams into one single stereo channel audio stream (and keep the
586 video stream), you can use the following command:
587 @example
588 ffmpeg -i input.mkv -f lavfi -i "
589 amovie=input.mkv:si=1 [a1];
590 amovie=input.mkv:si=2 [a2];
591 [a1][a2] amerge" -c:a pcm_s16le -c:v copy output.mkv
592 @end example
593
594 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
595 Set metadata information of the next output file from @var{infile}. Note that
596 those are file indices (zero-based), not filenames.
597 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
598 A metadata specifier can have the following forms:
599 @table @option
600 @item @var{g}
601 global metadata, i.e. metadata that applies to the whole file
602
603 @item @var{s}[:@var{stream_spec}]
604 per-stream metadata. @var{stream_spec} is a stream specifier as described
605 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
606 matching stream is copied from. In an output metadata specifier, all matching
607 streams are copied to.
608
609 @item @var{c}:@var{chapter_index}
610 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
611
612 @item @var{p}:@var{program_index}
613 per-program metadata. @var{program_index} is the zero-based program index.
614 @end table
615 If metadata specifier is omitted, it defaults to global.
616
617 By default, global metadata is copied from the first input file,
618 per-stream and per-chapter metadata is copied along with streams/chapters. These
619 default mappings are disabled by creating any mapping of the relevant type. A negative
620 file index can be used to create a dummy mapping that just disables automatic copying.
621
622 For example to copy metadata from the first stream of the input file to global metadata
623 of the output file:
624 @example
625 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
626 @end example
627
628 To do the reverse, i.e. copy global metadata to all audio streams:
629 @example
630 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
631 @end example
632 Note that simple @code{0} would work as well in this example, since global
633 metadata is assumed by default.
634
635 @item -map_chapters @var{input_file_index} (@emph{output})
636 Copy chapters from input file with index @var{input_file_index} to the next
637 output file. If no chapter mapping is specified, then chapters are copied from
638 the first input file with at least one chapter. Use a negative file index to
639 disable any chapter copying.
640 @item -debug @var{category}
641 Print specific debug info.
642 @var{category} is a number or a string containing one of the following values:
643 @table @samp
644 @item bitstream
645 @item buffers
646 picture buffer allocations
647 @item bugs
648 @item dct_coeff
649 @item er
650 error recognition
651 @item mb_type
652 macroblock (MB) type
653 @item mmco
654 memory management control operations (H.264)
655 @item mv
656 motion vector
657 @item pict
658 picture info
659 @item pts
660 @item qp
661 per-block quantization parameter (QP)
662 @item rc
663 rate control
664 @item skip
665 @item startcode
666 @item thread_ops
667 threading operations
668 @item vis_mb_type
669 visualize block types
670 @item vis_qp
671 visualize quantization parameter (QP), lower QP are tinted greener
672 @end table
673 @item -benchmark (@emph{global})
674 Show benchmarking information at the end of an encode.
675 Shows CPU time used and maximum memory consumption.
676 Maximum memory consumption is not supported on all systems,
677 it will usually display as 0 if not supported.
678 @item -benchmark_all (@emph{global})
679 Show benchmarking information during the encode.
680 Shows CPU time used in various steps (audio/video encode/decode).
681 @item -timelimit @var{duration} (@emph{global})
682 Exit after ffmpeg has been running for @var{duration} seconds.
683 @item -dump (@emph{global})
684 Dump each input packet to stderr.
685 @item -hex (@emph{global})
686 When dumping packets, also dump the payload.
687 @item -re (@emph{input})
688 Read input at native frame rate. Mainly used to simulate a grab device.
689 @item -loop_input
690 Loop over the input stream. Currently it works only for image
691 streams. This option is used for automatic FFserver testing.
692 This option is deprecated, use -loop 1.
693 @item -loop_output @var{number_of_times}
694 Repeatedly loop output for formats that support looping such as animated GIF
695 (0 will loop the output infinitely).
696 This option is deprecated, use -loop.
697 @item -vsync @var{parameter}
698 Video sync method.
699 For compatibility reasons old values can be specified as numbers.
700 Newly added values will have to be specified as strings always.
701
702 @table @option
703 @item 0, passthrough
704 Each frame is passed with its timestamp from the demuxer to the muxer.
705 @item 1, cfr
706 Frames will be duplicated and dropped to achieve exactly the requested
707 constant framerate.
708 @item 2, vfr
709 Frames are passed through with their timestamp or dropped so as to
710 prevent 2 frames from having the same timestamp.
711 @item drop
712 As passthrough but destroys all timestamps, making the muxer generate
713 fresh timestamps based on frame-rate.
714 @item -1, auto
715 Chooses between 1 and 2 depending on muxer capabilities. This is the
716 default method.
717 @end table
718
719 With -map you can select from which stream the timestamps should be
720 taken. You can leave either video or audio unchanged and sync the
721 remaining stream(s) to the unchanged one.
722
723 @item -async @var{samples_per_second}
724 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
725 the parameter is the maximum samples per second by which the audio is changed.
726 -async 1 is a special case where only the start of the audio stream is corrected
727 without any later correction.
728 This option has been deprecated. Use the @code{asyncts} audio filter instead.
729 @item -copyts
730 Copy timestamps from input to output.
731 @item -copytb @var{mode}
732 Specify how to set the encoder timebase when stream copying.  @var{mode} is an
733 integer numeric value, and can assume one of the following values:
734
735 @table @option
736 @item 1
737 Use the demuxer timebase.
738
739 The time base is copied to the output encoder from the corresponding input
740 demuxer. This is sometimes required to avoid non monotonically increasing
741 timestamps when copying video streams with variable frame rate.
742
743 @item 0
744 Use the decoder timebase.
745
746 The time base is copied to the output encoder from the corresponding input
747 decoder.
748
749 @item -1
750 Try to make the choice automatically, in order to generate a sane output.
751 @end table
752
753 Default value is -1.
754
755 @item -shortest
756 Finish encoding when the shortest input stream ends.
757 @item -dts_delta_threshold
758 Timestamp discontinuity delta threshold.
759 @item -muxdelay @var{seconds} (@emph{input})
760 Set the maximum demux-decode delay.
761 @item -muxpreload @var{seconds} (@emph{input})
762 Set the initial demux-decode delay.
763 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
764 Assign a new stream-id value to an output stream. This option should be
765 specified prior to the output filename to which it applies.
766 For the situation where multiple output files exist, a streamid
767 may be reassigned to a different value.
768
769 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
770 an output mpegts file:
771 @example
772 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
773 @end example
774
775 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
776 Set bitstream filters for matching streams. @var{bistream_filters} is
777 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
778 to get the list of bitstream filters.
779 @example
780 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
781 @end example
782 @example
783 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
784 @end example
785
786 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{per-stream})
787 Force a tag/fourcc for matching streams.
788
789 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
790 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
791 (or '.') for drop.
792 @example
793 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
794 @end example
795
796 @item -filter_complex @var{filtergraph} (@emph{global})
797 Define a complex filter graph, i.e. one with arbitrary number of inputs and/or
798 outputs. For simple graphs -- those with one input and one output of the same
799 type -- see the @option{-filter} options. @var{filtergraph} is a description of
800 the filter graph, as described in @ref{Filtergraph syntax}.
801
802 Input link labels must refer to input streams using the
803 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
804 uses). If @var{stream_specifier} matches multiple streams, the first one will be
805 used. An unlabeled input will be connected to the first unused input stream of
806 the matching type.
807
808 Output link labels are referred to with @option{-map}. Unlabeled outputs are
809 added to the first output file.
810
811 For example, to overlay an image over video
812 @example
813 ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
814 '[out]' out.mkv
815 @end example
816 Here @code{[0:v]} refers to the first video stream in the first input file,
817 which is linked to the first (main) input of the overlay filter. Similarly the
818 first video stream in the second input is linked to the second (overlay) input
819 of overlay.
820
821 Assuming there is only one video stream in each input file, we can omit input
822 labels, so the above is equivalent to
823 @example
824 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
825 '[out]' out.mkv
826 @end example
827
828 Furthermore we can omit the output label and the single output from the filter
829 graph will be added to the output file automatically, so we can simply write
830 @example
831 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
832 @end example
833 @end table
834
835 @section Preset files
836 A preset file contains a sequence of @var{option}=@var{value} pairs,
837 one for each line, specifying a sequence of options which would be
838 awkward to specify on the command line. Lines starting with the hash
839 ('#') character are ignored and are used to provide comments. Check
840 the @file{presets} directory in the FFmpeg source tree for examples.
841
842 Preset files are specified with the @code{vpre}, @code{apre},
843 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
844 filename of the preset instead of a preset name as input and can be
845 used for any kind of codec. For the @code{vpre}, @code{apre}, and
846 @code{spre} options, the options specified in a preset file are
847 applied to the currently selected codec of the same type as the preset
848 option.
849
850 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
851 preset options identifies the preset file to use according to the
852 following rules:
853
854 First ffmpeg searches for a file named @var{arg}.ffpreset in the
855 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
856 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
857 or in a @file{ffpresets} folder along the executable on win32,
858 in that order. For example, if the argument is @code{libx264-max}, it will
859 search for the file @file{libx264-max.ffpreset}.
860
861 If no such file is found, then ffmpeg will search for a file named
862 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
863 directories, where @var{codec_name} is the name of the codec to which
864 the preset file options will be applied. For example, if you select
865 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
866 then it will search for the file @file{libx264-max.ffpreset}.
867 @c man end OPTIONS
868
869 @chapter Tips
870 @c man begin TIPS
871
872 @itemize
873 @item
874 For streaming at very low bitrate application, use a low frame rate
875 and a small GOP size. This is especially true for RealVideo where
876 the Linux player does not seem to be very fast, so it can miss
877 frames. An example is:
878
879 @example
880 ffmpeg -g 3 -r 3 -t 10 -b:v 50k -s qcif -f rv10 /tmp/b.rm
881 @end example
882
883 @item
884 The parameter 'q' which is displayed while encoding is the current
885 quantizer. The value 1 indicates that a very good quality could
886 be achieved. The value 31 indicates the worst quality. If q=31 appears
887 too often, it means that the encoder cannot compress enough to meet
888 your bitrate. You must either increase the bitrate, decrease the
889 frame rate or decrease the frame size.
890
891 @item
892 If your computer is not fast enough, you can speed up the
893 compression at the expense of the compression ratio. You can use
894 '-me zero' to speed up motion estimation, and '-g 0' to disable
895 motion estimation completely (you have only I-frames, which means it
896 is about as good as JPEG compression).
897
898 @item
899 To have very low audio bitrates, reduce the sampling frequency
900 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
901
902 @item
903 To have a constant quality (but a variable bitrate), use the option
904 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
905 quality).
906
907 @end itemize
908 @c man end TIPS
909
910 @chapter Examples
911 @c man begin EXAMPLES
912
913 @section Preset files
914
915 A preset file contains a sequence of @var{option=value} pairs, one for
916 each line, specifying a sequence of options which can be specified also on
917 the command line. Lines starting with the hash ('#') character are ignored and
918 are used to provide comments. Empty lines are also ignored. Check the
919 @file{presets} directory in the FFmpeg source tree for examples.
920
921 Preset files are specified with the @code{pre} option, this option takes a
922 preset name as input.  FFmpeg searches for a file named @var{preset_name}.avpreset in
923 the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
924 the data directory defined at configuration time (usually @file{$PREFIX/share/ffmpeg})
925 in that order.  For example, if the argument is @code{libx264-max}, it will
926 search for the file @file{libx264-max.avpreset}.
927
928 @section Video and Audio grabbing
929
930 If you specify the input format and device then ffmpeg can grab video
931 and audio directly.
932
933 @example
934 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
935 @end example
936
937 Or with an ALSA audio source (mono input, card id 1) instead of OSS:
938 @example
939 ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
940 @end example
941
942 Note that you must activate the right video source and channel before
943 launching ffmpeg with any TV viewer such as
944 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
945 have to set the audio recording levels correctly with a
946 standard mixer.
947
948 @section X11 grabbing
949
950 Grab the X11 display with ffmpeg via
951
952 @example
953 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
954 @end example
955
956 0.0 is display.screen number of your X11 server, same as
957 the DISPLAY environment variable.
958
959 @example
960 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
961 @end example
962
963 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
964 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
965
966 @section Video and Audio file format conversion
967
968 Any supported file format and protocol can serve as input to ffmpeg:
969
970 Examples:
971 @itemize
972 @item
973 You can use YUV files as input:
974
975 @example
976 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
977 @end example
978
979 It will use the files:
980 @example
981 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
982 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
983 @end example
984
985 The Y files use twice the resolution of the U and V files. They are
986 raw files, without header. They can be generated by all decent video
987 decoders. You must specify the size of the image with the @option{-s} option
988 if ffmpeg cannot guess it.
989
990 @item
991 You can input from a raw YUV420P file:
992
993 @example
994 ffmpeg -i /tmp/test.yuv /tmp/out.avi
995 @end example
996
997 test.yuv is a file containing raw YUV planar data. Each frame is composed
998 of the Y plane followed by the U and V planes at half vertical and
999 horizontal resolution.
1000
1001 @item
1002 You can output to a raw YUV420P file:
1003
1004 @example
1005 ffmpeg -i mydivx.avi hugefile.yuv
1006 @end example
1007
1008 @item
1009 You can set several input files and output files:
1010
1011 @example
1012 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1013 @end example
1014
1015 Converts the audio file a.wav and the raw YUV video file a.yuv
1016 to MPEG file a.mpg.
1017
1018 @item
1019 You can also do audio and video conversions at the same time:
1020
1021 @example
1022 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1023 @end example
1024
1025 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1026
1027 @item
1028 You can encode to several formats at the same time and define a
1029 mapping from input stream to output streams:
1030
1031 @example
1032 ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1033 @end example
1034
1035 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1036 file:index' specifies which input stream is used for each output
1037 stream, in the order of the definition of output streams.
1038
1039 @item
1040 You can transcode decrypted VOBs:
1041
1042 @example
1043 ffmpeg -i snatch_1.vob -f avi -c:v mpeg4 -b:v 800k -g 300 -bf 2 -c:a libmp3lame -b:a 128k snatch.avi
1044 @end example
1045
1046 This is a typical DVD ripping example; the input is a VOB file, the
1047 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1048 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1049 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1050 input video. Furthermore, the audio stream is MP3-encoded so you need
1051 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1052 The mapping is particularly useful for DVD transcoding
1053 to get the desired audio language.
1054
1055 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1056
1057 @item
1058 You can extract images from a video, or create a video from many images:
1059
1060 For extracting images from a video:
1061 @example
1062 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1063 @end example
1064
1065 This will extract one video frame per second from the video and will
1066 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1067 etc. Images will be rescaled to fit the new WxH values.
1068
1069 If you want to extract just a limited number of frames, you can use the
1070 above command in combination with the -vframes or -t option, or in
1071 combination with -ss to start extracting from a certain point in time.
1072
1073 For creating a video from many images:
1074 @example
1075 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1076 @end example
1077
1078 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1079 composed of three digits padded with zeroes to express the sequence
1080 number. It is the same syntax supported by the C printf function, but
1081 only formats accepting a normal integer are suitable.
1082
1083 When importing an image sequence, -i also supports expanding shell-like
1084 wildcard patterns (globbing) internally. To lower the chance of interfering
1085 with your actual file names and the shell's glob expansion, you are required
1086 to activate glob meta characters by prefixing them with a single @code{%}
1087 character, like in @code{foo-%*.jpeg}, @code{foo-%?%?%?.jpeg} or
1088 @code{foo-00%[234%]%*.jpeg}.
1089 If your filename actually contains a character sequence of a @code{%} character
1090 followed by a glob character, you must double the @code{%} character to escape
1091 it. Imagine your files begin with @code{%?-foo-}, then you could use a glob
1092 pattern like @code{%%?-foo-%*.jpeg}. For input patterns that could be both a
1093 printf or a glob pattern, ffmpeg will assume it is a glob pattern.
1094
1095 @item
1096 You can put many streams of the same type in the output:
1097
1098 @example
1099 ffmpeg -i test1.avi -i test2.avi -map 0.3 -map 0.2 -map 0.1 -map 0.0 -c copy test12.nut
1100 @end example
1101
1102 The resulting output file @file{test12.avi} will contain first four streams from
1103 the input file in reverse order.
1104
1105 @item
1106 To force CBR video output:
1107 @example
1108 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1109 @end example
1110
1111 @item
1112 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1113 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1114 @example
1115 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
1116 @end example
1117
1118 @end itemize
1119 @c man end EXAMPLES
1120
1121 @include syntax.texi
1122 @include eval.texi
1123 @include decoders.texi
1124 @include encoders.texi
1125 @include demuxers.texi
1126 @include muxers.texi
1127 @include indevs.texi
1128 @include outdevs.texi
1129 @include protocols.texi
1130 @include bitstream_filters.texi
1131 @include filters.texi
1132 @include metadata.texi
1133
1134 @ignore
1135
1136 @setfilename ffmpeg
1137 @settitle ffmpeg video converter
1138
1139 @c man begin SEEALSO
1140 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1141 @c man end
1142
1143 @c man begin AUTHORS
1144 See git history
1145 @c man end
1146
1147 @end ignore
1148
1149 @bye