doc: add decoders.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 [[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 The command line interface is designed to be intuitive, in the sense
30 that ffmpeg tries to figure out all parameters that can possibly be
31 derived automatically. You usually only have to specify the target
32 bitrate you want.
33
34 As a general rule, options are applied to the next specified
35 file. Therefore, order is important, and you can have the same
36 option on the command line multiple times. Each occurrence is
37 then applied to the next input or output file.
38
39 @itemize
40 @item
41 To set the video bitrate of the output file to 64kbit/s:
42 @example
43 ffmpeg -i input.avi -b 64k output.avi
44 @end example
45
46 @item
47 To force the frame rate of the output file to 24 fps:
48 @example
49 ffmpeg -i input.avi -r 24 output.avi
50 @end example
51
52 @item
53 To force the frame rate of the input file (valid for raw formats only)
54 to 1 fps and the frame rate of the output file to 24 fps:
55 @example
56 ffmpeg -r 1 -i input.m2v -r 24 output.avi
57 @end example
58 @end itemize
59
60 The format option may be needed for raw input files.
61
62 By default ffmpeg tries to convert as losslessly as possible: It
63 uses the same audio and video parameters for the outputs as the one
64 specified for the inputs.
65
66 @c man end DESCRIPTION
67
68 @chapter Options
69 @c man begin OPTIONS
70
71 @include fftools-common-opts.texi
72
73 @section Main options
74
75 @table @option
76
77 @item -f @var{fmt}
78 Force format.
79
80 @item -i @var{filename}
81 input file name
82
83 @item -y
84 Overwrite output files.
85
86 @item -t @var{duration}
87 Restrict the transcoded/captured video sequence
88 to the duration specified in seconds.
89 @code{hh:mm:ss[.xxx]} syntax is also supported.
90
91 @item -fs @var{limit_size}
92 Set the file size limit.
93
94 @item -ss @var{position}
95 Seek to given time position in seconds.
96 @code{hh:mm:ss[.xxx]} syntax is also supported.
97
98 @item -itsoffset @var{offset}
99 Set the input time offset in seconds.
100 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
101 This option affects all the input files that follow it.
102 The offset is added to the timestamps of the input files.
103 Specifying a positive offset means that the corresponding
104 streams are delayed by 'offset' seconds.
105
106 @item -timestamp @var{time}
107 Set the recording timestamp in the container.
108 The syntax for @var{time} is:
109 @example
110 now|([(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH[:MM[:SS[.m...]]])|(HH[MM[SS[.m...]]]))[Z|z])
111 @end example
112 If the value is "now" it takes the current time.
113 Time is local time unless 'Z' or 'z' is appended, in which case it is
114 interpreted as UTC.
115 If the year-month-day part is not specified it takes the current
116 year-month-day.
117
118 @item -metadata @var{key}=@var{value}
119 Set a metadata key/value pair.
120
121 For example, for setting the title in the output file:
122 @example
123 ffmpeg -i in.avi -metadata title="my title" out.flv
124 @end example
125
126 @item -v @var{number}
127 Set the logging verbosity level.
128
129 @item -target @var{type}
130 Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
131 "ntsc-svcd", ... ). All the format options (bitrate, codecs,
132 buffer sizes) are then set automatically. You can just type:
133
134 @example
135 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
136 @end example
137
138 Nevertheless you can specify additional options as long as you know
139 they do not conflict with the standard, as in:
140
141 @example
142 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
143 @end example
144
145 @item -dframes @var{number}
146 Set the number of data frames to record.
147
148 @item -scodec @var{codec}
149 Force subtitle codec ('copy' to copy stream).
150
151 @item -newsubtitle
152 Add a new subtitle stream to the current output stream.
153
154 @item -slang @var{code}
155 Set the ISO 639 language code (3 letters) of the current subtitle stream.
156
157 @end table
158
159 @section Video Options
160
161 @table @option
162 @item -b @var{bitrate}
163 Set the video bitrate in bit/s (default = 200 kb/s).
164 @item -vframes @var{number}
165 Set the number of video frames to record.
166 @item -r @var{fps}
167 Set frame rate (Hz value, fraction or abbreviation), (default = 25).
168 @item -s @var{size}
169 Set frame size. The format is @samp{wxh} (ffserver default = 160x128).
170 There is no default for input streams,
171 for output streams it is set by default to the size of the source stream.
172 If the input file has video streams with different resolutions, the behaviour is undefined.
173 The following abbreviations are recognized:
174 @table @samp
175 @item sqcif
176 128x96
177 @item qcif
178 176x144
179 @item cif
180 352x288
181 @item 4cif
182 704x576
183 @item 16cif
184 1408x1152
185 @item qqvga
186 160x120
187 @item qvga
188 320x240
189 @item vga
190 640x480
191 @item svga
192 800x600
193 @item xga
194 1024x768
195 @item uxga
196 1600x1200
197 @item qxga
198 2048x1536
199 @item sxga
200 1280x1024
201 @item qsxga
202 2560x2048
203 @item hsxga
204 5120x4096
205 @item wvga
206 852x480
207 @item wxga
208 1366x768
209 @item wsxga
210 1600x1024
211 @item wuxga
212 1920x1200
213 @item woxga
214 2560x1600
215 @item wqsxga
216 3200x2048
217 @item wquxga
218 3840x2400
219 @item whsxga
220 6400x4096
221 @item whuxga
222 7680x4800
223 @item cga
224 320x200
225 @item ega
226 640x350
227 @item hd480
228 852x480
229 @item hd720
230 1280x720
231 @item hd1080
232 1920x1080
233 @end table
234
235 @item -aspect @var{aspect}
236 Set the video display aspect ratio specified by @var{aspect}.
237
238 @var{aspect} can be a floating point number string, or a string of the
239 form @var{num}:@var{den}, where @var{num} and @var{den} are the
240 numerator and denominator of the aspect ratio. For example "4:3",
241 "16:9", "1.3333", and "1.7777" are valid argument values.
242
243 @item -croptop @var{size}
244 @item -cropbottom @var{size}
245 @item -cropleft @var{size}
246 @item -cropright @var{size}
247 All the crop options have been removed. Use -vf
248 crop=width:height:x:y instead.
249
250 @item -padtop @var{size}
251 @item -padbottom @var{size}
252 @item -padleft @var{size}
253 @item -padright @var{size}
254 @item -padcolor @var{hex_color}
255 All the pad options have been removed. Use -vf
256 pad=width:height:x:y:color instead.
257 @item -vn
258 Disable video recording.
259 @item -bt @var{tolerance}
260 Set video bitrate tolerance (in bits, default 4000k).
261 Has a minimum value of: (target_bitrate/target_framerate).
262 In 1-pass mode, bitrate tolerance specifies how far ratecontrol is
263 willing to deviate from the target average bitrate value. This is
264 not related to min/max bitrate. Lowering tolerance too much has
265 an adverse effect on quality.
266 @item -maxrate @var{bitrate}
267 Set max video bitrate (in bit/s).
268 Requires -bufsize to be set.
269 @item -minrate @var{bitrate}
270 Set min video bitrate (in bit/s).
271 Most useful in setting up a CBR encode:
272 @example
273 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
274 @end example
275 It is of little use elsewise.
276 @item -bufsize @var{size}
277 Set video buffer verifier buffer size (in bits).
278 @item -vcodec @var{codec}
279 Force video codec to @var{codec}. Use the @code{copy} special value to
280 tell that the raw codec data must be copied as is.
281 @item -sameq
282 Use same quantizer as source (implies VBR).
283
284 @item -pass @var{n}
285 Select the pass number (1 or 2). It is used to do two-pass
286 video encoding. The statistics of the video are recorded in the first
287 pass into a log file (see also the option -passlogfile),
288 and in the second pass that log file is used to generate the video
289 at the exact requested bitrate.
290 On pass 1, you may just deactivate audio and set output to null,
291 examples for Windows and Unix:
292 @example
293 ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y NUL
294 ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y /dev/null
295 @end example
296
297 @item -passlogfile @var{prefix}
298 Set two-pass log file name prefix to @var{prefix}, the default file name
299 prefix is ``ffmpeg2pass''. The complete file name will be
300 @file{PREFIX-N.log}, where N is a number specific to the output
301 stream.
302
303 @item -newvideo
304 Add a new video stream to the current output stream.
305
306 @item -vlang @var{code}
307 Set the ISO 639 language code (3 letters) of the current video stream.
308
309 @item -vf @var{filter_graph}
310 @var{filter_graph} is a description of the filter graph to apply to
311 the input video.
312 Use the option "-filters" to show all the available filters (including
313 also sources and sinks).
314
315 @item -x264opts @var{option}
316 Allows you to set any x264 option, see x264 manual for a list.
317 @example
318 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
319 @end example
320
321
322 @end table
323
324 @section Advanced Video Options
325
326 @table @option
327 @item -pix_fmt @var{format}
328 Set pixel format. Use 'list' as parameter to show all the supported
329 pixel formats.
330 @item -sws_flags @var{flags}
331 Set SwScaler flags.
332 @item -g @var{gop_size}
333 Set the group of pictures size.
334 @item -intra
335 Use only intra frames.
336 @item -vdt @var{n}
337 Discard threshold.
338 @item -qscale @var{q}
339 Use fixed video quantizer scale (VBR).
340 @item -qmin @var{q}
341 minimum video quantizer scale (VBR)
342 @item -qmax @var{q}
343 maximum video quantizer scale (VBR)
344 @item -qdiff @var{q}
345 maximum difference between the quantizer scales (VBR)
346 @item -qblur @var{blur}
347 video quantizer scale blur (VBR) (range 0.0 - 1.0)
348 @item -qcomp @var{compression}
349 video quantizer scale compression (VBR) (default 0.5).
350 Constant of ratecontrol equation. Recommended range for default rc_eq: 0.0-1.0
351
352 @item -lmin @var{lambda}
353 minimum video lagrange factor (VBR)
354 @item -lmax @var{lambda}
355 max video lagrange factor (VBR)
356 @item -mblmin @var{lambda}
357 minimum macroblock quantizer scale (VBR)
358 @item -mblmax @var{lambda}
359 maximum macroblock quantizer scale (VBR)
360
361 These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
362 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
363 @example
364 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
365 @end example
366
367 @item -rc_init_cplx @var{complexity}
368 initial complexity for single pass encoding
369 @item -b_qfactor @var{factor}
370 qp factor between P- and B-frames
371 @item -i_qfactor @var{factor}
372 qp factor between P- and I-frames
373 @item -b_qoffset @var{offset}
374 qp offset between P- and B-frames
375 @item -i_qoffset @var{offset}
376 qp offset between P- and I-frames
377 @item -rc_eq @var{equation}
378 Set rate control equation (see section "Expression Evaluation")
379 (default = @code{tex^qComp}).
380
381 When computing the rate control equation expression, besides the
382 standard functions defined in the section "Expression Evaluation", the
383 following functions are available:
384 @table @var
385 @item bits2qp(bits)
386 @item qp2bits(qp)
387 @end table
388
389 and the following constants are available:
390 @table @var
391 @item iTex
392 @item pTex
393 @item tex
394 @item mv
395 @item fCode
396 @item iCount
397 @item mcVar
398 @item var
399 @item isI
400 @item isP
401 @item isB
402 @item avgQP
403 @item qComp
404 @item avgIITex
405 @item avgPITex
406 @item avgPPTex
407 @item avgBPTex
408 @item avgTex
409 @end table
410
411 @item -rc_override @var{override}
412 Rate control override for specific intervals, formated as "int,int,int"
413 list separated with slashes. Two first values are the beginning and
414 end frame numbers, last one is quantizer to use if positive, or quality
415 factor if negative.
416 @item -me_method @var{method}
417 Set motion estimation method to @var{method}.
418 Available methods are (from lowest to best quality):
419 @table @samp
420 @item zero
421 Try just the (0, 0) vector.
422 @item phods
423 @item log
424 @item x1
425 @item hex
426 @item umh
427 @item epzs
428 (default method)
429 @item full
430 exhaustive search (slow and marginally better than epzs)
431 @end table
432
433 @item -dct_algo @var{algo}
434 Set DCT algorithm to @var{algo}. Available values are:
435 @table @samp
436 @item 0
437 FF_DCT_AUTO (default)
438 @item 1
439 FF_DCT_FASTINT
440 @item 2
441 FF_DCT_INT
442 @item 3
443 FF_DCT_MMX
444 @item 4
445 FF_DCT_MLIB
446 @item 5
447 FF_DCT_ALTIVEC
448 @end table
449
450 @item -idct_algo @var{algo}
451 Set IDCT algorithm to @var{algo}. Available values are:
452 @table @samp
453 @item 0
454 FF_IDCT_AUTO (default)
455 @item 1
456 FF_IDCT_INT
457 @item 2
458 FF_IDCT_SIMPLE
459 @item 3
460 FF_IDCT_SIMPLEMMX
461 @item 4
462 FF_IDCT_LIBMPEG2MMX
463 @item 5
464 FF_IDCT_PS2
465 @item 6
466 FF_IDCT_MLIB
467 @item 7
468 FF_IDCT_ARM
469 @item 8
470 FF_IDCT_ALTIVEC
471 @item 9
472 FF_IDCT_SH4
473 @item 10
474 FF_IDCT_SIMPLEARM
475 @end table
476
477 @item -er @var{n}
478 Set error resilience to @var{n}.
479 @table @samp
480 @item 1
481 FF_ER_CAREFUL (default)
482 @item 2
483 FF_ER_COMPLIANT
484 @item 3
485 FF_ER_AGGRESSIVE
486 @item 4
487 FF_ER_VERY_AGGRESSIVE
488 @end table
489
490 @item -ec @var{bit_mask}
491 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
492 the following values:
493 @table @samp
494 @item 1
495 FF_EC_GUESS_MVS (default = enabled)
496 @item 2
497 FF_EC_DEBLOCK (default = enabled)
498 @end table
499
500 @item -bf @var{frames}
501 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
502 @item -mbd @var{mode}
503 macroblock decision
504 @table @samp
505 @item 0
506 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in ffmpeg).
507 @item 1
508 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
509 @item 2
510 FF_MB_DECISION_RD: rate distortion
511 @end table
512
513 @item -4mv
514 Use four motion vector by macroblock (MPEG-4 only).
515 @item -part
516 Use data partitioning (MPEG-4 only).
517 @item -bug @var{param}
518 Work around encoder bugs that are not auto-detected.
519 @item -strict @var{strictness}
520 How strictly to follow the standards.
521 @item -aic
522 Enable Advanced intra coding (h263+).
523 @item -umv
524 Enable Unlimited Motion Vector (h263+)
525
526 @item -deinterlace
527 Deinterlace pictures.
528 @item -ilme
529 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
530 Use this option if your input file is interlaced and you want
531 to keep the interlaced format for minimum losses.
532 The alternative is to deinterlace the input stream with
533 @option{-deinterlace}, but deinterlacing introduces losses.
534 @item -psnr
535 Calculate PSNR of compressed frames.
536 @item -vstats
537 Dump video coding statistics to @file{vstats_HHMMSS.log}.
538 @item -vstats_file @var{file}
539 Dump video coding statistics to @var{file}.
540 @item -top @var{n}
541 top=1/bottom=0/auto=-1 field first
542 @item -dc @var{precision}
543 Intra_dc_precision.
544 @item -vtag @var{fourcc/tag}
545 Force video tag/fourcc.
546 @item -qphist
547 Show QP histogram.
548 @item -vbsf @var{bitstream_filter}
549 Bitstream filters available are "dump_extra", "remove_extra", "noise", "h264_mp4toannexb", "imxdump", "mjpegadump", "mjpeg2jpeg".
550 @example
551 ffmpeg -i h264.mp4 -vcodec copy -vbsf h264_mp4toannexb -an out.h264
552 @end example
553 @item -force_key_frames @var{time}[,@var{time}...]
554 Force key frames at the specified timestamps, more precisely at the first
555 frames after each specified time.
556 This option can be useful to ensure that a seek point is present at a
557 chapter mark or any other designated place in the output file.
558 The timestamps must be specified in ascending order.
559 @end table
560
561 @section Audio Options
562
563 @table @option
564 @item -aframes @var{number}
565 Set the number of audio frames to record.
566 @item -ar @var{freq}
567 Set the audio sampling frequency. For input streams it is set by
568 default to 44100 Hz, for output streams it is set by default to the
569 frequency of the input stream. If the input file has audio streams
570 with different frequencies, the behaviour is undefined.
571 @item -ab @var{bitrate}
572 Set the audio bitrate in bit/s (default = 64k).
573 @item -aq @var{q}
574 Set the audio quality (codec-specific, VBR).
575 @item -ac @var{channels}
576 Set the number of audio channels. For input streams it is set by
577 default to 1, for output streams it is set by default to the same
578 number of audio channels in input. If the input file has audio streams
579 with different channel count, the behaviour is undefined.
580 @item -an
581 Disable audio recording.
582 @item -acodec @var{codec}
583 Force audio codec to @var{codec}. Use the @code{copy} special value to
584 specify that the raw codec data must be copied as is.
585 @item -newaudio
586 Add a new audio track to the output file. If you want to specify parameters,
587 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
588
589 Mapping will be done automatically, if the number of output streams is equal to
590 the number of input streams, else it will pick the first one that matches. You
591 can override the mapping using @code{-map} as usual.
592
593 Example:
594 @example
595 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
596 @end example
597 @item -alang @var{code}
598 Set the ISO 639 language code (3 letters) of the current audio stream.
599 @end table
600
601 @section Advanced Audio options:
602
603 @table @option
604 @item -atag @var{fourcc/tag}
605 Force audio tag/fourcc.
606 @item -audio_service_type @var{type}
607 Set the type of service that the audio stream contains.
608 @table @option
609 @item ma
610 Main Audio Service (default)
611 @item ef
612 Effects
613 @item vi
614 Visually Impaired
615 @item hi
616 Hearing Impaired
617 @item di
618 Dialogue
619 @item co
620 Commentary
621 @item em
622 Emergency
623 @item vo
624 Voice Over
625 @item ka
626 Karaoke
627 @end table
628 @item -absf @var{bitstream_filter}
629 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
630 @end table
631
632 @section Subtitle options:
633
634 @table @option
635 @item -scodec @var{codec}
636 Force subtitle codec ('copy' to copy stream).
637 @item -newsubtitle
638 Add a new subtitle stream to the current output stream.
639 @item -slang @var{code}
640 Set the ISO 639 language code (3 letters) of the current subtitle stream.
641 @item -sn
642 Disable subtitle recording.
643 @item -sbsf @var{bitstream_filter}
644 Bitstream filters available are "mov2textsub", "text2movsub".
645 @example
646 ffmpeg -i file.mov -an -vn -sbsf mov2textsub -scodec copy -f rawvideo sub.txt
647 @end example
648 @end table
649
650 @section Audio/Video grab options
651
652 @table @option
653 @item -vc @var{channel}
654 Set video grab channel (DV1394 only).
655 @item -tvstd @var{standard}
656 Set television standard (NTSC, PAL (SECAM)).
657 @item -isync
658 Synchronize read on input.
659 @end table
660
661 @section Advanced options
662
663 @table @option
664 @item -map @var{input_file_id}.@var{input_stream_id}[:@var{sync_file_id}.@var{sync_stream_id}]
665
666 Designate an input stream as a source for the output file. Each input
667 stream is identified by the input file index @var{input_file_id} and
668 the input stream index @var{input_stream_id} within the input
669 file. Both indexes start at 0. If specified,
670 @var{sync_file_id}.@var{sync_stream_id} sets which input stream
671 is used as a presentation sync reference.
672
673 The @code{-map} options must be specified just after the output file.
674 If any @code{-map} options are used, the number of @code{-map} options
675 on the command line must match the number of streams in the output
676 file. The first @code{-map} option on the command line specifies the
677 source for output stream 0, the second @code{-map} option specifies
678 the source for output stream 1, etc.
679
680 For example, if you have two audio streams in the first input file,
681 these streams are identified by "0.0" and "0.1". You can use
682 @code{-map} to select which stream to place in an output file. For
683 example:
684 @example
685 ffmpeg -i INPUT out.wav -map 0.1
686 @end example
687 will map the input stream in @file{INPUT} identified by "0.1" to
688 the (single) output stream in @file{out.wav}.
689
690 For example, to select the stream with index 2 from input file
691 @file{a.mov} (specified by the identifier "0.2"), and stream with
692 index 6 from input @file{b.mov} (specified by the identifier "1.6"),
693 and copy them to the output file @file{out.mov}:
694 @example
695 ffmpeg -i a.mov -i b.mov -vcodec copy -acodec copy out.mov -map 0.2 -map 1.6
696 @end example
697
698 To add more streams to the output file, you can use the
699 @code{-newaudio}, @code{-newvideo}, @code{-newsubtitle} options.
700
701 @item -map_meta_data @var{outfile}[,@var{metadata}]:@var{infile}[,@var{metadata}]
702 Deprecated, use @var{-map_metadata} instead.
703
704 @item -map_metadata @var{outfile}[,@var{metadata}]:@var{infile}[,@var{metadata}]
705 Set metadata information of @var{outfile} from @var{infile}. Note that those
706 are file indices (zero-based), not filenames.
707 Optional @var{metadata} parameters specify, which metadata to copy - (g)lobal
708 (i.e. metadata that applies to the whole file), per-(s)tream, per-(c)hapter or
709 per-(p)rogram. All metadata specifiers other than global must be followed by the
710 stream/chapter/program number. If metadata specifier is omitted, it defaults to
711 global.
712
713 By default, global metadata is copied from the first input file to all output files,
714 per-stream and per-chapter metadata is copied along with streams/chapters. These
715 default mappings are disabled by creating any mapping of the relevant type. A negative
716 file index can be used to create a dummy mapping that just disables automatic copying.
717
718 For example to copy metadata from the first stream of the input file to global metadata
719 of the output file:
720 @example
721 ffmpeg -i in.ogg -map_metadata 0:0,s0 out.mp3
722 @end example
723 @item -map_chapters @var{outfile}:@var{infile}
724 Copy chapters from @var{infile} to @var{outfile}. If no chapter mapping is specified,
725 then chapters are copied from the first input file with at least one chapter to all
726 output files. Use a negative file index to disable any chapter copying.
727 @item -debug
728 Print specific debug info.
729 @item -benchmark
730 Show benchmarking information at the end of an encode.
731 Shows CPU time used and maximum memory consumption.
732 Maximum memory consumption is not supported on all systems,
733 it will usually display as 0 if not supported.
734 @item -dump
735 Dump each input packet.
736 @item -hex
737 When dumping packets, also dump the payload.
738 @item -bitexact
739 Only use bit exact algorithms (for codec testing).
740 @item -ps @var{size}
741 Set RTP payload size in bytes.
742 @item -re
743 Read input at native frame rate. Mainly used to simulate a grab device.
744 @item -loop_input
745 Loop over the input stream. Currently it works only for image
746 streams. This option is used for automatic FFserver testing.
747 @item -loop_output @var{number_of_times}
748 Repeatedly loop output for formats that support looping such as animated GIF
749 (0 will loop the output infinitely).
750 @item -threads @var{count}
751 Thread count.
752 @item -vsync @var{parameter}
753 Video sync method.
754
755 @table @option
756 @item 0
757 Each frame is passed with its timestamp from the demuxer to the muxer.
758 @item 1
759 Frames will be duplicated and dropped to achieve exactly the requested
760 constant framerate.
761 @item 2
762 Frames are passed through with their timestamp or dropped so as to
763 prevent 2 frames from having the same timestamp.
764 @item -1
765 Chooses between 1 and 2 depending on muxer capabilities. This is the
766 default method.
767 @end table
768
769 With -map you can select from which stream the timestamps should be
770 taken. You can leave either video or audio unchanged and sync the
771 remaining stream(s) to the unchanged one.
772
773 @item -async @var{samples_per_second}
774 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
775 the parameter is the maximum samples per second by which the audio is changed.
776 -async 1 is a special case where only the start of the audio stream is corrected
777 without any later correction.
778 @item -copyts
779 Copy timestamps from input to output.
780 @item -copytb
781 Copy input stream time base from input to output when stream copying.
782 @item -shortest
783 Finish encoding when the shortest input stream ends.
784 @item -dts_delta_threshold
785 Timestamp discontinuity delta threshold.
786 @item -muxdelay @var{seconds}
787 Set the maximum demux-decode delay.
788 @item -muxpreload @var{seconds}
789 Set the initial demux-decode delay.
790 @item -streamid @var{output-stream-index}:@var{new-value}
791 Assign a new stream-id value to an output stream. This option should be
792 specified prior to the output filename to which it applies.
793 For the situation where multiple output files exist, a streamid
794 may be reassigned to a different value.
795
796 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
797 an output mpegts file:
798 @example
799 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
800 @end example
801 @end table
802
803 @section Preset files
804
805 A preset file contains a sequence of @var{option}=@var{value} pairs,
806 one for each line, specifying a sequence of options which would be
807 awkward to specify on the command line. Lines starting with the hash
808 ('#') character are ignored and are used to provide comments. Check
809 the @file{ffpresets} directory in the FFmpeg source tree for examples.
810
811 Preset files are specified with the @code{vpre}, @code{apre},
812 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
813 filename of the preset instead of a preset name as input and can be
814 used for any kind of codec. For the @code{vpre}, @code{apre}, and
815 @code{spre} options, the options specified in a preset file are
816 applied to the currently selected codec of the same type as the preset
817 option.
818
819 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
820 preset options identifies the preset file to use according to the
821 following rules:
822
823 First ffmpeg searches for a file named @var{arg}.ffpreset in the
824 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
825 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
826 in that order. For example, if the argument is @code{libx264-max}, it will
827 search for the file @file{libx264-max.ffpreset}.
828
829 If no such file is found, then ffmpeg will search for a file named
830 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
831 directories, where @var{codec_name} is the name of the codec to which
832 the preset file options will be applied. For example, if you select
833 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
834 then it will search for the file @file{libx264-max.ffpreset}.
835 @c man end
836
837 @chapter Tips
838 @c man begin TIPS
839
840 @itemize
841 @item
842 For streaming at very low bitrate application, use a low frame rate
843 and a small GOP size. This is especially true for RealVideo where
844 the Linux player does not seem to be very fast, so it can miss
845 frames. An example is:
846
847 @example
848 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
849 @end example
850
851 @item
852 The parameter 'q' which is displayed while encoding is the current
853 quantizer. The value 1 indicates that a very good quality could
854 be achieved. The value 31 indicates the worst quality. If q=31 appears
855 too often, it means that the encoder cannot compress enough to meet
856 your bitrate. You must either increase the bitrate, decrease the
857 frame rate or decrease the frame size.
858
859 @item
860 If your computer is not fast enough, you can speed up the
861 compression at the expense of the compression ratio. You can use
862 '-me zero' to speed up motion estimation, and '-intra' to disable
863 motion estimation completely (you have only I-frames, which means it
864 is about as good as JPEG compression).
865
866 @item
867 To have very low audio bitrates, reduce the sampling frequency
868 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
869
870 @item
871 To have a constant quality (but a variable bitrate), use the option
872 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
873 quality).
874
875 @item
876 When converting video files, you can use the '-sameq' option which
877 uses the same quality factor in the encoder as in the decoder.
878 It allows almost lossless encoding.
879
880 @end itemize
881 @c man end TIPS
882
883 @chapter Examples
884 @c man begin EXAMPLES
885
886 @section Video and Audio grabbing
887
888 If you specify the input format and device then ffmpeg can grab video
889 and audio directly.
890
891 @example
892 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
893 @end example
894
895 Note that you must activate the right video source and channel before
896 launching ffmpeg with any TV viewer such as xawtv
897 (@url{http://linux.bytesex.org/xawtv/}) by Gerd Knorr. You also
898 have to set the audio recording levels correctly with a
899 standard mixer.
900
901 @section X11 grabbing
902
903 Grab the X11 display with ffmpeg via
904
905 @example
906 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
907 @end example
908
909 0.0 is display.screen number of your X11 server, same as
910 the DISPLAY environment variable.
911
912 @example
913 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
914 @end example
915
916 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
917 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
918
919 @section Video and Audio file format conversion
920
921 Any supported file format and protocol can serve as input to ffmpeg:
922
923 Examples:
924 @itemize
925 @item
926 You can use YUV files as input:
927
928 @example
929 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
930 @end example
931
932 It will use the files:
933 @example
934 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
935 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
936 @end example
937
938 The Y files use twice the resolution of the U and V files. They are
939 raw files, without header. They can be generated by all decent video
940 decoders. You must specify the size of the image with the @option{-s} option
941 if ffmpeg cannot guess it.
942
943 @item
944 You can input from a raw YUV420P file:
945
946 @example
947 ffmpeg -i /tmp/test.yuv /tmp/out.avi
948 @end example
949
950 test.yuv is a file containing raw YUV planar data. Each frame is composed
951 of the Y plane followed by the U and V planes at half vertical and
952 horizontal resolution.
953
954 @item
955 You can output to a raw YUV420P file:
956
957 @example
958 ffmpeg -i mydivx.avi hugefile.yuv
959 @end example
960
961 @item
962 You can set several input files and output files:
963
964 @example
965 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
966 @end example
967
968 Converts the audio file a.wav and the raw YUV video file a.yuv
969 to MPEG file a.mpg.
970
971 @item
972 You can also do audio and video conversions at the same time:
973
974 @example
975 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
976 @end example
977
978 Converts a.wav to MPEG audio at 22050 Hz sample rate.
979
980 @item
981 You can encode to several formats at the same time and define a
982 mapping from input stream to output streams:
983
984 @example
985 ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
986 @end example
987
988 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
989 file:index' specifies which input stream is used for each output
990 stream, in the order of the definition of output streams.
991
992 @item
993 You can transcode decrypted VOBs:
994
995 @example
996 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
997 @end example
998
999 This is a typical DVD ripping example; the input is a VOB file, the
1000 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1001 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1002 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1003 input video. Furthermore, the audio stream is MP3-encoded so you need
1004 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1005 The mapping is particularly useful for DVD transcoding
1006 to get the desired audio language.
1007
1008 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1009
1010 @item
1011 You can extract images from a video, or create a video from many images:
1012
1013 For extracting images from a video:
1014 @example
1015 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1016 @end example
1017
1018 This will extract one video frame per second from the video and will
1019 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1020 etc. Images will be rescaled to fit the new WxH values.
1021
1022 If you want to extract just a limited number of frames, you can use the
1023 above command in combination with the -vframes or -t option, or in
1024 combination with -ss to start extracting from a certain point in time.
1025
1026 For creating a video from many images:
1027 @example
1028 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1029 @end example
1030
1031 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1032 composed of three digits padded with zeroes to express the sequence
1033 number. It is the same syntax supported by the C printf function, but
1034 only formats accepting a normal integer are suitable.
1035
1036 @item
1037 You can put many streams of the same type in the output:
1038
1039 @example
1040 ffmpeg -i test1.avi -i test2.avi -vcodec copy -acodec copy -vcodec copy -acodec copy test12.avi -newvideo -newaudio
1041 @end example
1042
1043 In addition to the first video and audio streams, the resulting
1044 output file @file{test12.avi} will contain the second video
1045 and the second audio stream found in the input streams list.
1046
1047 The @code{-newvideo}, @code{-newaudio} and @code{-newsubtitle}
1048 options have to be specified immediately after the name of the output
1049 file to which you want to add them.
1050
1051 @end itemize
1052 @c man end EXAMPLES
1053
1054 @include eval.texi
1055 @include decoders.texi
1056 @include encoders.texi
1057 @include demuxers.texi
1058 @include muxers.texi
1059 @include indevs.texi
1060 @include outdevs.texi
1061 @include protocols.texi
1062 @include bitstream_filters.texi
1063 @include filters.texi
1064 @include metadata.texi
1065
1066 @ignore
1067
1068 @setfilename ffmpeg
1069 @settitle ffmpeg video converter
1070
1071 @c man begin SEEALSO
1072 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1073 @c man end
1074
1075 @c man begin AUTHORS
1076 The FFmpeg developers
1077 @c man end
1078
1079 @end ignore
1080
1081 @bye