Merge remote-tracking branch 'qatar/master'
[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...]]])|(HH[MM[SS[.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 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
228 Specify the preset for matching stream(s).
229
230 @item -stats (@emph{global})
231 Print encoding progress/statistics. On by default.
232
233 @item -debug_ts (@emph{global})
234 Print timestamp information. It is off by default. This option is
235 mostly useful for testing and debugging purposes, and the output
236 format may change from one version to another, so it should not be
237 employed by portable scripts.
238
239 See also the option @code{-fdebug ts}.
240
241 @item -attach @var{filename} (@emph{output})
242 Add an attachment to the output file. This is supported by a few formats
243 like Matroska for e.g. fonts used in rendering subtitles. Attachments
244 are implemented as a specific type of stream, so this option will add
245 a new stream to the file. It is then possible to use per-stream options
246 on this stream in the usual way. Attachment streams created with this
247 option will be created after all the other streams (i.e. those created
248 with @code{-map} or automatic mappings).
249
250 Note that for Matroska you also have to set the mimetype metadata tag:
251 @example
252 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
253 @end example
254 (assuming that the attachment stream will be third in the output file).
255
256 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
257 Extract the matching attachment stream into a file named @var{filename}. If
258 @var{filename} is empty, then the value of the @code{filename} metadata tag
259 will be used.
260
261 E.g. to extract the first attachment to a file named 'out.ttf':
262 @example
263 ffmpeg -dump_attachment:t:0 out.ttf INPUT
264 @end example
265 To extract all attachments to files determined by the @code{filename} tag:
266 @example
267 ffmpeg -dump_attachment:t "" INPUT
268 @end example
269
270 Technical note -- attachments are implemented as codec extradata, so this
271 option can actually be used to extract extradata from any stream, not just
272 attachments.
273
274 @end table
275
276 @section Video Options
277
278 @table @option
279 @item -vframes @var{number} (@emph{output})
280 Set the number of video frames to record. This is an alias for @code{-frames:v}.
281 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
282 Set frame rate (Hz value, fraction or abbreviation), (default = 25). For output
283 streams implies @code{-vsync cfr}.
284 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
285 Set frame size. The format is @samp{wxh} (default - same as source).
286 The following abbreviations are recognized:
287 @table @samp
288 @item sqcif
289 128x96
290 @item qcif
291 176x144
292 @item cif
293 352x288
294 @item 4cif
295 704x576
296 @item 16cif
297 1408x1152
298 @item qqvga
299 160x120
300 @item qvga
301 320x240
302 @item vga
303 640x480
304 @item svga
305 800x600
306 @item xga
307 1024x768
308 @item uxga
309 1600x1200
310 @item qxga
311 2048x1536
312 @item sxga
313 1280x1024
314 @item qsxga
315 2560x2048
316 @item hsxga
317 5120x4096
318 @item wvga
319 852x480
320 @item wxga
321 1366x768
322 @item wsxga
323 1600x1024
324 @item wuxga
325 1920x1200
326 @item woxga
327 2560x1600
328 @item wqsxga
329 3200x2048
330 @item wquxga
331 3840x2400
332 @item whsxga
333 6400x4096
334 @item whuxga
335 7680x4800
336 @item cga
337 320x200
338 @item ega
339 640x350
340 @item hd480
341 852x480
342 @item hd720
343 1280x720
344 @item hd1080
345 1920x1080
346 @end table
347
348 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
349 Set the video display aspect ratio specified by @var{aspect}.
350
351 @var{aspect} can be a floating point number string, or a string of the
352 form @var{num}:@var{den}, where @var{num} and @var{den} are the
353 numerator and denominator of the aspect ratio. For example "4:3",
354 "16:9", "1.3333", and "1.7777" are valid argument values.
355
356 @item -croptop @var{size}
357 @item -cropbottom @var{size}
358 @item -cropleft @var{size}
359 @item -cropright @var{size}
360 All the crop options have been removed. Use -vf
361 crop=width:height:x:y instead.
362
363 @item -padtop @var{size}
364 @item -padbottom @var{size}
365 @item -padleft @var{size}
366 @item -padright @var{size}
367 @item -padcolor @var{hex_color}
368 All the pad options have been removed. Use -vf
369 pad=width:height:x:y:color instead.
370
371 @item -vn (@emph{output})
372 Disable video recording.
373
374 @item -vcodec @var{codec} (@emph{output})
375 Set the video codec. This is an alias for @code{-codec:v}.
376 @item -same_quant
377 Use same quantizer as source (implies VBR).
378
379 Note that this is NOT SAME QUALITY. Do not use this option unless you know you
380 need it.
381
382 @item -pass @var{n}
383 Select the pass number (1 or 2). It is used to do two-pass
384 video encoding. The statistics of the video are recorded in the first
385 pass into a log file (see also the option -passlogfile),
386 and in the second pass that log file is used to generate the video
387 at the exact requested bitrate.
388 On pass 1, you may just deactivate audio and set output to null,
389 examples for Windows and Unix:
390 @example
391 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
392 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
393 @end example
394
395 @item -passlogfile @var{prefix} (@emph{global})
396 Set two-pass log file name prefix to @var{prefix}, the default file name
397 prefix is ``ffmpeg2pass''. The complete file name will be
398 @file{PREFIX-N.log}, where N is a number specific to the output
399 stream
400
401 @item -vlang @var{code}
402 Set the ISO 639 language code (3 letters) of the current video stream.
403
404 @item -vf @var{filter_graph} (@emph{output})
405 @var{filter_graph} is a description of the filter graph to apply to
406 the input video.
407 Use the option "-filters" to show all the available filters (including
408 also sources and sinks).  This is an alias for @code{-filter:v}.
409
410 @end table
411
412 @section Advanced Video Options
413
414 @table @option
415 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
416 Set pixel format. Use @code{-pix_fmts} to show all the supported
417 pixel formats.
418 @item -sws_flags @var{flags} (@emph{input/output})
419 Set SwScaler flags.
420 @item -vdt @var{n}
421 Discard threshold.
422
423 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
424 Rate control override for specific intervals, formatted as "int,int,int"
425 list separated with slashes. Two first values are the beginning and
426 end frame numbers, last one is quantizer to use if positive, or quality
427 factor if negative.
428
429 @item -deinterlace
430 Deinterlace pictures.
431 This option is deprecated since the deinterlacing is very low quality.
432 Use the yadif filter with @code{-filter:v yadif}.
433 @item -ilme
434 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
435 Use this option if your input file is interlaced and you want
436 to keep the interlaced format for minimum losses.
437 The alternative is to deinterlace the input stream with
438 @option{-deinterlace}, but deinterlacing introduces losses.
439 @item -psnr
440 Calculate PSNR of compressed frames.
441 @item -vstats
442 Dump video coding statistics to @file{vstats_HHMMSS.log}.
443 @item -vstats_file @var{file}
444 Dump video coding statistics to @var{file}.
445 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
446 top=1/bottom=0/auto=-1 field first
447 @item -dc @var{precision}
448 Intra_dc_precision.
449 @item -vtag @var{fourcc/tag} (@emph{output})
450 Force video tag/fourcc. This is an alias for @code{-tag:v}.
451 @item -qphist (@emph{global})
452 Show QP histogram
453 @item -vbsf @var{bitstream_filter}
454 Deprecated see -bsf
455 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
456 Force key frames at the specified timestamps, more precisely at the first
457 frames after each specified time.
458 This option can be useful to ensure that a seek point is present at a
459 chapter mark or any other designated place in the output file.
460 The timestamps must be specified in ascending order.
461
462 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
463 When doing stream copy, copy also non-key frames found at the
464 beginning.
465 @end table
466
467 @section Audio Options
468
469 @table @option
470 @item -aframes @var{number} (@emph{output})
471 Set the number of audio frames to record. This is an alias for @code{-frames:a}.
472 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
473 Set the audio sampling frequency. For output streams it is set by
474 default to the frequency of the corresponding input stream. For input
475 streams this option only makes sense for audio grabbing devices and raw
476 demuxers and is mapped to the corresponding demuxer options.
477 @item -aq @var{q} (@emph{output})
478 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
479 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
480 Set the number of audio channels. For output streams it is set by
481 default to the number of input audio channels. For input streams
482 this option only makes sense for audio grabbing devices and raw demuxers
483 and is mapped to the corresponding demuxer options.
484 @item -an (@emph{output})
485 Disable audio recording.
486 @item -acodec @var{codec} (@emph{input/output})
487 Set the audio codec. This is an alias for @code{-codec:a}.
488 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
489 Set the audio sample format. Use @code{-sample_fmts} to get a list
490 of supported sample formats.
491 @end table
492
493 @section Advanced Audio options:
494
495 @table @option
496 @item -atag @var{fourcc/tag} (@emph{output})
497 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
498 @item -absf @var{bitstream_filter}
499 Deprecated, see -bsf
500 @end table
501
502 @section Subtitle options:
503
504 @table @option
505 @item -slang @var{code}
506 Set the ISO 639 language code (3 letters) of the current subtitle stream.
507 @item -scodec @var{codec} (@emph{input/output})
508 Set the subtitle codec. This is an alias for @code{-codec:s}.
509 @item -sn (@emph{output})
510 Disable subtitle recording.
511 @item -sbsf @var{bitstream_filter}
512 Deprecated, see -bsf
513 @end table
514
515 @section Audio/Video grab options
516
517 @table @option
518 @item -isync (@emph{global})
519 Synchronize read on input.
520 @end table
521
522 @section Advanced options
523
524 @table @option
525 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] (@emph{output})
526
527 Designate one or more input streams as a source for the output file. Each input
528 stream is identified by the input file index @var{input_file_id} and
529 the input stream index @var{input_stream_id} within the input
530 file. Both indices start at 0. If specified,
531 @var{sync_file_id}:@var{stream_specifier} sets which input stream
532 is used as a presentation sync reference.
533
534 The first @code{-map} option on the command line specifies the
535 source for output stream 0, the second @code{-map} option specifies
536 the source for output stream 1, etc.
537
538 A @code{-} character before the stream identifier creates a "negative" mapping.
539 It disables matching streams from already created mappings.
540
541 For example, to map ALL streams from the first input file to output
542 @example
543 ffmpeg -i INPUT -map 0 output
544 @end example
545
546 For example, if you have two audio streams in the first input file,
547 these streams are identified by "0:0" and "0:1". You can use
548 @code{-map} to select which streams to place in an output file. For
549 example:
550 @example
551 ffmpeg -i INPUT -map 0:1 out.wav
552 @end example
553 will map the input stream in @file{INPUT} identified by "0:1" to
554 the (single) output stream in @file{out.wav}.
555
556 For example, to select the stream with index 2 from input file
557 @file{a.mov} (specified by the identifier "0:2"), and stream with
558 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
559 and copy them to the output file @file{out.mov}:
560 @example
561 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
562 @end example
563
564 To select all video and the third audio stream from an input file:
565 @example
566 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
567 @end example
568
569 To map all the streams except the second audio, use negative mappings
570 @example
571 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
572 @end example
573
574 Note that using this option disables the default mappings for this output file.
575
576 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][:@var{output_file_id}.@var{stream_specifier}]
577 Map an audio channel from a given input to an output. If
578 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
579 be mapped on all the audio streams.
580
581 Using "-1" instead of
582 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
583 channel.
584
585 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
586 two audio channels with the following command:
587 @example
588 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
589 @end example
590
591 If you want to mute the first channel and keep the second:
592 @example
593 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
594 @end example
595
596 The order of the "-map_channel" option specifies the order of the channels in
597 the output stream. The output channel layout is guessed from the number of
598 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
599 in combination of "-map_channel" makes the channel gain levels to be updated if
600 input and output channel layouts don't match (for instance two "-map_channel"
601 options and "-ac 6").
602
603 You can also extract each channel of an input to specific outputs; the following
604 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
605 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
606 @example
607 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
608 @end example
609
610 The following example splits the channels of a stereo input into two separate
611 streams, which are put into the same output file:
612 @example
613 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
614 @end example
615
616 Note that currently each output stream can only contain channels from a single
617 input stream; you can't for example use "-map_channel" to pick multiple input
618 audio channels contained in different streams (from the same or different files)
619 and merge them into a single output stream. It is therefore not currently
620 possible, for example, to turn two separate mono streams into a single stereo
621 stream. However splitting a stereo stream into two single channel mono streams
622 is possible.
623
624 If you need this feature, a possible workaround is to use the @emph{amerge}
625 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
626 mono audio streams into one single stereo channel audio stream (and keep the
627 video stream), you can use the following command:
628 @example
629 ffmpeg -i input.mkv -f lavfi -i "
630 amovie=input.mkv:si=1 [a1];
631 amovie=input.mkv:si=2 [a2];
632 [a1][a2] amerge" -c:a pcm_s16le -c:v copy output.mkv
633 @end example
634
635 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
636 Set metadata information of the next output file from @var{infile}. Note that
637 those are file indices (zero-based), not filenames.
638 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
639 A metadata specifier can have the following forms:
640 @table @option
641 @item @var{g}
642 global metadata, i.e. metadata that applies to the whole file
643
644 @item @var{s}[:@var{stream_spec}]
645 per-stream metadata. @var{stream_spec} is a stream specifier as described
646 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
647 matching stream is copied from. In an output metadata specifier, all matching
648 streams are copied to.
649
650 @item @var{c}:@var{chapter_index}
651 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
652
653 @item @var{p}:@var{program_index}
654 per-program metadata. @var{program_index} is the zero-based program index.
655 @end table
656 If metadata specifier is omitted, it defaults to global.
657
658 By default, global metadata is copied from the first input file,
659 per-stream and per-chapter metadata is copied along with streams/chapters. These
660 default mappings are disabled by creating any mapping of the relevant type. A negative
661 file index can be used to create a dummy mapping that just disables automatic copying.
662
663 For example to copy metadata from the first stream of the input file to global metadata
664 of the output file:
665 @example
666 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
667 @end example
668
669 To do the reverse, i.e. copy global metadata to all audio streams:
670 @example
671 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
672 @end example
673 Note that simple @code{0} would work as well in this example, since global
674 metadata is assumed by default.
675
676 @item -map_chapters @var{input_file_index} (@emph{output})
677 Copy chapters from input file with index @var{input_file_index} to the next
678 output file. If no chapter mapping is specified, then chapters are copied from
679 the first input file with at least one chapter. Use a negative file index to
680 disable any chapter copying.
681 @item -debug @var{category}
682 Print specific debug info.
683 @var{category} is a number or a string containing one of the following values:
684 @table @samp
685 @item bitstream
686 @item buffers
687 picture buffer allocations
688 @item bugs
689 @item dct_coeff
690 @item er
691 error recognition
692 @item mb_type
693 macroblock (MB) type
694 @item mmco
695 memory management control operations (H.264)
696 @item mv
697 motion vector
698 @item pict
699 picture info
700 @item pts
701 @item qp
702 per-block quantization parameter (QP)
703 @item rc
704 rate control
705 @item skip
706 @item startcode
707 @item thread_ops
708 threading operations
709 @item vis_mb_type
710 visualize block types
711 @item vis_qp
712 visualize quantization parameter (QP), lower QP are tinted greener
713 @end table
714 @item -benchmark (@emph{global})
715 Show benchmarking information at the end of an encode.
716 Shows CPU time used and maximum memory consumption.
717 Maximum memory consumption is not supported on all systems,
718 it will usually display as 0 if not supported.
719 @item -timelimit @var{duration} (@emph{global})
720 Exit after ffmpeg has been running for @var{duration} seconds.
721 @item -dump (@emph{global})
722 Dump each input packet to stderr.
723 @item -hex (@emph{global})
724 When dumping packets, also dump the payload.
725 @item -re (@emph{input})
726 Read input at native frame rate. Mainly used to simulate a grab device.
727 @item -loop_input
728 Loop over the input stream. Currently it works only for image
729 streams. This option is used for automatic FFserver testing.
730 This option is deprecated, use -loop 1.
731 @item -loop_output @var{number_of_times}
732 Repeatedly loop output for formats that support looping such as animated GIF
733 (0 will loop the output infinitely).
734 This option is deprecated, use -loop.
735 @item -vsync @var{parameter}
736 Video sync method.
737 For compatibility reasons old values can be specified as numbers.
738 Newly added values will have to be specified as strings always.
739
740 @table @option
741 @item 0, passthrough
742 Each frame is passed with its timestamp from the demuxer to the muxer.
743 @item 1, cfr
744 Frames will be duplicated and dropped to achieve exactly the requested
745 constant framerate.
746 @item 2, vfr
747 Frames are passed through with their timestamp or dropped so as to
748 prevent 2 frames from having the same timestamp.
749 @item drop
750 As passthrough but destroys all timestamps, making the muxer generate
751 fresh timestamps based on frame-rate.
752 @item -1, auto
753 Chooses between 1 and 2 depending on muxer capabilities. This is the
754 default method.
755 @end table
756
757 With -map you can select from which stream the timestamps should be
758 taken. You can leave either video or audio unchanged and sync the
759 remaining stream(s) to the unchanged one.
760
761 @item -async @var{samples_per_second}
762 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
763 the parameter is the maximum samples per second by which the audio is changed.
764 -async 1 is a special case where only the start of the audio stream is corrected
765 without any later correction.
766 @item -copyts
767 Copy timestamps from input to output.
768 @item -copytb
769 Copy input stream time base from input to output when stream copying.
770 @item -shortest
771 Finish encoding when the shortest input stream ends.
772 @item -dts_delta_threshold
773 Timestamp discontinuity delta threshold.
774 @item -muxdelay @var{seconds} (@emph{input})
775 Set the maximum demux-decode delay.
776 @item -muxpreload @var{seconds} (@emph{input})
777 Set the initial demux-decode delay.
778 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
779 Assign a new stream-id value to an output stream. This option should be
780 specified prior to the output filename to which it applies.
781 For the situation where multiple output files exist, a streamid
782 may be reassigned to a different value.
783
784 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
785 an output mpegts file:
786 @example
787 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
788 @end example
789
790 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
791 Set bitstream filters for matching streams. @var{bistream_filters} is
792 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
793 to get the list of bitstream filters.
794 @example
795 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
796 @end example
797 @example
798 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
799 @end example
800
801 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{per-stream})
802 Force a tag/fourcc for matching streams.
803
804 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
805 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
806 (or '.') for drop.
807 @example
808 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
809 @end example
810 @end table
811
812 @section Preset files
813 A preset file contains a sequence of @var{option}=@var{value} pairs,
814 one for each line, specifying a sequence of options which would be
815 awkward to specify on the command line. Lines starting with the hash
816 ('#') character are ignored and are used to provide comments. Check
817 the @file{presets} directory in the FFmpeg source tree for examples.
818
819 Preset files are specified with the @code{vpre}, @code{apre},
820 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
821 filename of the preset instead of a preset name as input and can be
822 used for any kind of codec. For the @code{vpre}, @code{apre}, and
823 @code{spre} options, the options specified in a preset file are
824 applied to the currently selected codec of the same type as the preset
825 option.
826
827 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
828 preset options identifies the preset file to use according to the
829 following rules:
830
831 First ffmpeg searches for a file named @var{arg}.ffpreset in the
832 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
833 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
834 or in a @file{ffpresets} folder along the executable on win32,
835 in that order. For example, if the argument is @code{libx264-max}, it will
836 search for the file @file{libx264-max.ffpreset}.
837
838 If no such file is found, then ffmpeg will search for a file named
839 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
840 directories, where @var{codec_name} is the name of the codec to which
841 the preset file options will be applied. For example, if you select
842 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
843 then it will search for the file @file{libx264-max.ffpreset}.
844 @c man end OPTIONS
845
846 @chapter Tips
847 @c man begin TIPS
848
849 @itemize
850 @item
851 For streaming at very low bitrate application, use a low frame rate
852 and a small GOP size. This is especially true for RealVideo where
853 the Linux player does not seem to be very fast, so it can miss
854 frames. An example is:
855
856 @example
857 ffmpeg -g 3 -r 3 -t 10 -b:v 50k -s qcif -f rv10 /tmp/b.rm
858 @end example
859
860 @item
861 The parameter 'q' which is displayed while encoding is the current
862 quantizer. The value 1 indicates that a very good quality could
863 be achieved. The value 31 indicates the worst quality. If q=31 appears
864 too often, it means that the encoder cannot compress enough to meet
865 your bitrate. You must either increase the bitrate, decrease the
866 frame rate or decrease the frame size.
867
868 @item
869 If your computer is not fast enough, you can speed up the
870 compression at the expense of the compression ratio. You can use
871 '-me zero' to speed up motion estimation, and '-intra' to disable
872 motion estimation completely (you have only I-frames, which means it
873 is about as good as JPEG compression).
874
875 @item
876 To have very low audio bitrates, reduce the sampling frequency
877 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
878
879 @item
880 To have a constant quality (but a variable bitrate), use the option
881 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
882 quality).
883
884 @end itemize
885 @c man end TIPS
886
887 @chapter Examples
888 @c man begin EXAMPLES
889
890 @section Preset files
891
892 A preset file contains a sequence of @var{option=value} pairs, one for
893 each line, specifying a sequence of options which can be specified also on
894 the command line. Lines starting with the hash ('#') character are ignored and
895 are used to provide comments. Empty lines are also ignored. Check the
896 @file{presets} directory in the FFmpeg source tree for examples.
897
898 Preset files are specified with the @code{pre} option, this option takes a
899 preset name as input.  FFmpeg searches for a file named @var{preset_name}.avpreset in
900 the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
901 the data directory defined at configuration time (usually @file{$PREFIX/share/ffmpeg})
902 in that order.  For example, if the argument is @code{libx264-max}, it will
903 search for the file @file{libx264-max.avpreset}.
904
905 @section Video and Audio grabbing
906
907 If you specify the input format and device then ffmpeg can grab video
908 and audio directly.
909
910 @example
911 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
912 @end example
913
914 Or with an ALSA audio source (mono input, card id 1) instead of OSS:
915 @example
916 ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
917 @end example
918
919 Note that you must activate the right video source and channel before
920 launching ffmpeg with any TV viewer such as
921 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
922 have to set the audio recording levels correctly with a
923 standard mixer.
924
925 @section X11 grabbing
926
927 Grab the X11 display with ffmpeg via
928
929 @example
930 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
931 @end example
932
933 0.0 is display.screen number of your X11 server, same as
934 the DISPLAY environment variable.
935
936 @example
937 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
938 @end example
939
940 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
941 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
942
943 @section Video and Audio file format conversion
944
945 Any supported file format and protocol can serve as input to ffmpeg:
946
947 Examples:
948 @itemize
949 @item
950 You can use YUV files as input:
951
952 @example
953 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
954 @end example
955
956 It will use the files:
957 @example
958 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
959 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
960 @end example
961
962 The Y files use twice the resolution of the U and V files. They are
963 raw files, without header. They can be generated by all decent video
964 decoders. You must specify the size of the image with the @option{-s} option
965 if ffmpeg cannot guess it.
966
967 @item
968 You can input from a raw YUV420P file:
969
970 @example
971 ffmpeg -i /tmp/test.yuv /tmp/out.avi
972 @end example
973
974 test.yuv is a file containing raw YUV planar data. Each frame is composed
975 of the Y plane followed by the U and V planes at half vertical and
976 horizontal resolution.
977
978 @item
979 You can output to a raw YUV420P file:
980
981 @example
982 ffmpeg -i mydivx.avi hugefile.yuv
983 @end example
984
985 @item
986 You can set several input files and output files:
987
988 @example
989 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
990 @end example
991
992 Converts the audio file a.wav and the raw YUV video file a.yuv
993 to MPEG file a.mpg.
994
995 @item
996 You can also do audio and video conversions at the same time:
997
998 @example
999 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1000 @end example
1001
1002 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1003
1004 @item
1005 You can encode to several formats at the same time and define a
1006 mapping from input stream to output streams:
1007
1008 @example
1009 ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1010 @end example
1011
1012 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1013 file:index' specifies which input stream is used for each output
1014 stream, in the order of the definition of output streams.
1015
1016 @item
1017 You can transcode decrypted VOBs:
1018
1019 @example
1020 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
1021 @end example
1022
1023 This is a typical DVD ripping example; the input is a VOB file, the
1024 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1025 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1026 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1027 input video. Furthermore, the audio stream is MP3-encoded so you need
1028 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1029 The mapping is particularly useful for DVD transcoding
1030 to get the desired audio language.
1031
1032 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1033
1034 @item
1035 You can extract images from a video, or create a video from many images:
1036
1037 For extracting images from a video:
1038 @example
1039 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1040 @end example
1041
1042 This will extract one video frame per second from the video and will
1043 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1044 etc. Images will be rescaled to fit the new WxH values.
1045
1046 If you want to extract just a limited number of frames, you can use the
1047 above command in combination with the -vframes or -t option, or in
1048 combination with -ss to start extracting from a certain point in time.
1049
1050 For creating a video from many images:
1051 @example
1052 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1053 @end example
1054
1055 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1056 composed of three digits padded with zeroes to express the sequence
1057 number. It is the same syntax supported by the C printf function, but
1058 only formats accepting a normal integer are suitable.
1059
1060 @item
1061 You can put many streams of the same type in the output:
1062
1063 @example
1064 ffmpeg -i test1.avi -i test2.avi -map 0.3 -map 0.2 -map 0.1 -map 0.0 -c copy test12.nut
1065 @end example
1066
1067 The resulting output file @file{test12.avi} will contain first four streams from
1068 the input file in reverse order.
1069
1070 @item
1071 To force CBR video output:
1072 @example
1073 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1074 @end example
1075
1076 @item
1077 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1078 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1079 @example
1080 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
1081 @end example
1082
1083 @end itemize
1084 @c man end EXAMPLES
1085
1086 @include eval.texi
1087 @include decoders.texi
1088 @include encoders.texi
1089 @include demuxers.texi
1090 @include muxers.texi
1091 @include indevs.texi
1092 @include outdevs.texi
1093 @include protocols.texi
1094 @include bitstream_filters.texi
1095 @include filters.texi
1096 @include metadata.texi
1097
1098 @ignore
1099
1100 @setfilename ffmpeg
1101 @settitle ffmpeg video converter
1102
1103 @c man begin SEEALSO
1104 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1105 @c man end
1106
1107 @c man begin AUTHORS
1108 See git history
1109 @c man end
1110
1111 @end ignore
1112
1113 @bye