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