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