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