875edde03c298b7cff009e1b3f0e936033e62052
[ffmpeg.git] / doc / ffmpeg-doc.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 (@pxref{FFmpeg formula
358 evaluator}) (default = @code{tex^qComp}).
359 @item -rc_override @var{override}
360 rate control override for specific intervals
361 @item -me_method @var{method}
362 Set motion estimation method to @var{method}.
363 Available methods are (from lowest to best quality):
364 @table @samp
365 @item zero
366 Try just the (0, 0) vector.
367 @item phods
368 @item log
369 @item x1
370 @item hex
371 @item umh
372 @item epzs
373 (default method)
374 @item full
375 exhaustive search (slow and marginally better than epzs)
376 @end table
377
378 @item -dct_algo @var{algo}
379 Set DCT algorithm to @var{algo}. Available values are:
380 @table @samp
381 @item 0
382 FF_DCT_AUTO (default)
383 @item 1
384 FF_DCT_FASTINT
385 @item 2
386 FF_DCT_INT
387 @item 3
388 FF_DCT_MMX
389 @item 4
390 FF_DCT_MLIB
391 @item 5
392 FF_DCT_ALTIVEC
393 @end table
394
395 @item -idct_algo @var{algo}
396 Set IDCT algorithm to @var{algo}. Available values are:
397 @table @samp
398 @item 0
399 FF_IDCT_AUTO (default)
400 @item 1
401 FF_IDCT_INT
402 @item 2
403 FF_IDCT_SIMPLE
404 @item 3
405 FF_IDCT_SIMPLEMMX
406 @item 4
407 FF_IDCT_LIBMPEG2MMX
408 @item 5
409 FF_IDCT_PS2
410 @item 6
411 FF_IDCT_MLIB
412 @item 7
413 FF_IDCT_ARM
414 @item 8
415 FF_IDCT_ALTIVEC
416 @item 9
417 FF_IDCT_SH4
418 @item 10
419 FF_IDCT_SIMPLEARM
420 @end table
421
422 @item -er @var{n}
423 Set error resilience to @var{n}.
424 @table @samp
425 @item 1
426 FF_ER_CAREFUL (default)
427 @item 2
428 FF_ER_COMPLIANT
429 @item 3
430 FF_ER_AGGRESSIVE
431 @item 4
432 FF_ER_VERY_AGGRESSIVE
433 @end table
434
435 @item -ec @var{bit_mask}
436 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
437 the following values:
438 @table @samp
439 @item 1
440 FF_EC_GUESS_MVS (default = enabled)
441 @item 2
442 FF_EC_DEBLOCK (default = enabled)
443 @end table
444
445 @item -bf @var{frames}
446 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
447 @item -mbd @var{mode}
448 macroblock decision
449 @table @samp
450 @item 0
451 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
452 @item 1
453 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
454 @item 2
455 FF_MB_DECISION_RD: rate distortion
456 @end table
457
458 @item -4mv
459 Use four motion vector by macroblock (MPEG-4 only).
460 @item -part
461 Use data partitioning (MPEG-4 only).
462 @item -bug @var{param}
463 Work around encoder bugs that are not auto-detected.
464 @item -strict @var{strictness}
465 How strictly to follow the standards.
466 @item -aic
467 Enable Advanced intra coding (h263+).
468 @item -umv
469 Enable Unlimited Motion Vector (h263+)
470
471 @item -deinterlace
472 Deinterlace pictures.
473 @item -ilme
474 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
475 Use this option if your input file is interlaced and you want
476 to keep the interlaced format for minimum losses.
477 The alternative is to deinterlace the input stream with
478 @option{-deinterlace}, but deinterlacing introduces losses.
479 @item -psnr
480 Calculate PSNR of compressed frames.
481 @item -vstats
482 Dump video coding statistics to @file{vstats_HHMMSS.log}.
483 @item -vstats_file @var{file}
484 Dump video coding statistics to @var{file}.
485 @item -top @var{n}
486 top=1/bottom=0/auto=-1 field first
487 @item -dc @var{precision}
488 Intra_dc_precision.
489 @item -vtag @var{fourcc/tag}
490 Force video tag/fourcc.
491 @item -qphist
492 Show QP histogram.
493 @item -vbsf @var{bitstream_filter}
494 Bitstream filters available are "dump_extra", "remove_extra", "noise", "h264_mp4toannexb", "imxdump", "mjpegadump".
495 @example
496 ffmpeg -i h264.mp4 -vcodec copy -vbsf h264_mp4toannexb -an out.h264
497 @end example
498 @end table
499
500 @section Audio Options
501
502 @table @option
503 @item -aframes @var{number}
504 Set the number of audio frames to record.
505 @item -ar @var{freq}
506 Set the audio sampling frequency (default = 44100 Hz).
507 @item -ab @var{bitrate}
508 Set the audio bitrate in bit/s (default = 64k).
509 @item -aq @var{q}
510 Set the audio quality (codec-specific, VBR).
511 @item -ac @var{channels}
512 Set the number of audio channels. For input streams it is set by
513 default to 1, for output streams it is set by default to the same
514 number of audio channels in input. If the input file has audio streams
515 with different channel count, the behaviour is undefined.
516 @item -an
517 Disable audio recording.
518 @item -acodec @var{codec}
519 Force audio codec to @var{codec}. Use the @code{copy} special value to
520 specify that the raw codec data must be copied as is.
521 @item -newaudio
522 Add a new audio track to the output file. If you want to specify parameters,
523 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
524
525 Mapping will be done automatically, if the number of output streams is equal to
526 the number of input streams, else it will pick the first one that matches. You
527 can override the mapping using @code{-map} as usual.
528
529 Example:
530 @example
531 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
532 @end example
533 @item -alang @var{code}
534 Set the ISO 639 language code (3 letters) of the current audio stream.
535 @end table
536
537 @section Advanced Audio options:
538
539 @table @option
540 @item -atag @var{fourcc/tag}
541 Force audio tag/fourcc.
542 @item -absf @var{bitstream_filter}
543 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
544 @end table
545
546 @section Subtitle options:
547
548 @table @option
549 @item -scodec @var{codec}
550 Force subtitle codec ('copy' to copy stream).
551 @item -newsubtitle
552 Add a new subtitle stream to the current output stream.
553 @item -slang @var{code}
554 Set the ISO 639 language code (3 letters) of the current subtitle stream.
555 @item -sn
556 Disable subtitle recording.
557 @item -sbsf @var{bitstream_filter}
558 Bitstream filters available are "mov2textsub", "text2movsub".
559 @example
560 ffmpeg -i file.mov -an -vn -sbsf mov2textsub -scodec copy -f rawvideo sub.txt
561 @end example
562 @end table
563
564 @section Audio/Video grab options
565
566 @table @option
567 @item -vc @var{channel}
568 Set video grab channel (DV1394 only).
569 @item -tvstd @var{standard}
570 Set television standard (NTSC, PAL (SECAM)).
571 @item -isync
572 Synchronize read on input.
573 @end table
574
575 @section Advanced options
576
577 @table @option
578 @item -map @var{input_stream_id}[:@var{sync_stream_id}]
579 Set stream mapping from input streams to output streams.
580 Just enumerate the input streams in the order you want them in the output.
581 @var{sync_stream_id} if specified sets the input stream to sync
582 against.
583 @item -map_meta_data @var{outfile}:@var{infile}
584 Set meta data information of @var{outfile} from @var{infile}.
585 @item -debug
586 Print specific debug info.
587 @item -benchmark
588 Show benchmarking information at the end of an encode.
589 Shows CPU time used and maximum memory consumption.
590 Maximum memory consumption is not supported on all systems,
591 it will usually display as 0 if not supported.
592 @item -dump
593 Dump each input packet.
594 @item -hex
595 When dumping packets, also dump the payload.
596 @item -bitexact
597 Only use bit exact algorithms (for codec testing).
598 @item -ps @var{size}
599 Set RTP payload size in bytes.
600 @item -re
601 Read input at native frame rate. Mainly used to simulate a grab device.
602 @item -loop_input
603 Loop over the input stream. Currently it works only for image
604 streams. This option is used for automatic FFserver testing.
605 @item -loop_output @var{number_of_times}
606 Repeatedly loop output for formats that support looping such as animated GIF
607 (0 will loop the output infinitely).
608 @item -threads @var{count}
609 Thread count.
610 @item -vsync @var{parameter}
611 Video sync method.
612 0   Each frame is passed with its timestamp from the demuxer to the muxer
613 1   Frames will be duplicated and dropped to achieve exactly the requested
614     constant framerate.
615 2   Frames are passed through with their timestamp or dropped so as to prevent
616     2 frames from having the same timestamp
617 -1  Chooses between 1 and 2 depending on muxer capabilities. This is the default method.
618
619 With -map you can select from
620 which stream the timestamps should be taken. You can leave either video or
621 audio unchanged and sync the remaining stream(s) to the unchanged one.
622 @item -async @var{samples_per_second}
623 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
624 the parameter is the maximum samples per second by which the audio is changed.
625 -async 1 is a special case where only the start of the audio stream is corrected
626 without any later correction.
627 @item -copyts
628 Copy timestamps from input to output.
629 @item -shortest
630 Finish encoding when the shortest input stream ends.
631 @item -dts_delta_threshold
632 Timestamp discontinuity delta threshold.
633 @item -muxdelay @var{seconds}
634 Set the maximum demux-decode delay.
635 @item -muxpreload @var{seconds}
636 Set the initial demux-decode delay.
637 @item -streamid @var{output-stream-index}:@var{new-value}
638 Assign a new value to a stream's stream-id field in the next output file.
639 All stream-id fields are reset to default for each output file.
640
641 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
642 an output mpegts file:
643 @example
644 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
645 @end example
646 @end table
647
648 @section Preset files
649
650 A preset file contains a sequence of @var{option}=@var{value} pairs,
651 one for each line, specifying a sequence of options which would be
652 awkward to specify on the command line. Lines starting with the hash
653 ('#') character are ignored and are used to provide comments. Check
654 the @file{ffpresets} directory in the FFmpeg source tree for examples.
655
656 Preset files are specified with the @code{vpre}, @code{apre},
657 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
658 filename of the preset instead of a preset name as input and can be
659 used for any kind of codec. For the @code{vpre}, @code{apre}, and
660 @code{spre} options, the options specified in a preset file are
661 applied to the currently selected codec of the same type as the preset
662 option.
663
664 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
665 preset options identifies the preset file to use according to the
666 following rules:
667
668 First ffmpeg searches for a file named @var{arg}.ffpreset in the
669 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
670 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
671 in that order. For example, if the argument is @code{libx264-max}, it will
672 search for the file @file{libx264-max.ffpreset}.
673
674 If no such file is found, then ffmpeg will search for a file named
675 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
676 directories, where @var{codec_name} is the name of the codec to which
677 the preset file options will be applied. For example, if you select
678 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
679 then it will search for the file @file{libx264-max.ffpreset}.
680
681 @anchor{FFmpeg formula evaluator}
682 @section FFmpeg formula evaluator
683
684 When evaluating a rate control string, FFmpeg uses an internal formula
685 evaluator.
686
687 The following binary operators are available: @code{+}, @code{-},
688 @code{*}, @code{/}, @code{^}.
689
690 The following unary operators are available: @code{+}, @code{-},
691 @code{(...)}.
692
693 The following statements are available: @code{ld}, @code{st},
694 @code{while}.
695
696 The following functions are available:
697 @table @var
698 @item sinh(x)
699 @item cosh(x)
700 @item tanh(x)
701 @item sin(x)
702 @item cos(x)
703 @item tan(x)
704 @item atan(x)
705 @item asin(x)
706 @item acos(x)
707 @item exp(x)
708 @item log(x)
709 @item abs(x)
710 @item squish(x)
711 @item gauss(x)
712 @item mod(x, y)
713 @item max(x, y)
714 @item min(x, y)
715 @item eq(x, y)
716 @item gte(x, y)
717 @item gt(x, y)
718 @item lte(x, y)
719 @item lt(x, y)
720 @item bits2qp(bits)
721 @item qp2bits(qp)
722 @end table
723
724 The following constants are available:
725 @table @var
726 @item PI
727 @item E
728 @item iTex
729 @item pTex
730 @item tex
731 @item mv
732 @item fCode
733 @item iCount
734 @item mcVar
735 @item var
736 @item isI
737 @item isP
738 @item isB
739 @item avgQP
740 @item qComp
741 @item avgIITex
742 @item avgPITex
743 @item avgPPTex
744 @item avgBPTex
745 @item avgTex
746 @end table
747
748 @c man end
749
750 @chapter Tips
751 @c man begin TIPS
752
753 @itemize
754 @item
755 For streaming at very low bitrate application, use a low frame rate
756 and a small GOP size. This is especially true for RealVideo where
757 the Linux player does not seem to be very fast, so it can miss
758 frames. An example is:
759
760 @example
761 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
762 @end example
763
764 @item
765 The parameter 'q' which is displayed while encoding is the current
766 quantizer. The value 1 indicates that a very good quality could
767 be achieved. The value 31 indicates the worst quality. If q=31 appears
768 too often, it means that the encoder cannot compress enough to meet
769 your bitrate. You must either increase the bitrate, decrease the
770 frame rate or decrease the frame size.
771
772 @item
773 If your computer is not fast enough, you can speed up the
774 compression at the expense of the compression ratio. You can use
775 '-me zero' to speed up motion estimation, and '-intra' to disable
776 motion estimation completely (you have only I-frames, which means it
777 is about as good as JPEG compression).
778
779 @item
780 To have very low audio bitrates, reduce the sampling frequency
781 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
782
783 @item
784 To have a constant quality (but a variable bitrate), use the option
785 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
786 quality).
787
788 @item
789 When converting video files, you can use the '-sameq' option which
790 uses the same quality factor in the encoder as in the decoder.
791 It allows almost lossless encoding.
792
793 @end itemize
794 @c man end TIPS
795
796 @chapter Examples
797 @c man begin EXAMPLES
798
799 @section Video and Audio grabbing
800
801 FFmpeg can grab video and audio from devices given that you specify the input
802 format and device.
803
804 @example
805 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
806 @end example
807
808 Note that you must activate the right video source and channel before
809 launching FFmpeg with any TV viewer such as xawtv
810 (@url{http://linux.bytesex.org/xawtv/}) by Gerd Knorr. You also
811 have to set the audio recording levels correctly with a
812 standard mixer.
813
814 @section X11 grabbing
815
816 FFmpeg can grab the X11 display.
817
818 @example
819 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
820 @end example
821
822 0.0 is display.screen number of your X11 server, same as
823 the DISPLAY environment variable.
824
825 @example
826 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
827 @end example
828
829 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
830 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
831
832 @section Video and Audio file format conversion
833
834 * FFmpeg can use any supported file format and protocol as input:
835
836 Examples:
837
838 * You can use YUV files as input:
839
840 @example
841 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
842 @end example
843
844 It will use the files:
845 @example
846 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
847 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
848 @end example
849
850 The Y files use twice the resolution of the U and V files. They are
851 raw files, without header. They can be generated by all decent video
852 decoders. You must specify the size of the image with the @option{-s} option
853 if FFmpeg cannot guess it.
854
855 * You can input from a raw YUV420P file:
856
857 @example
858 ffmpeg -i /tmp/test.yuv /tmp/out.avi
859 @end example
860
861 test.yuv is a file containing raw YUV planar data. Each frame is composed
862 of the Y plane followed by the U and V planes at half vertical and
863 horizontal resolution.
864
865 * You can output to a raw YUV420P file:
866
867 @example
868 ffmpeg -i mydivx.avi hugefile.yuv
869 @end example
870
871 * You can set several input files and output files:
872
873 @example
874 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
875 @end example
876
877 Converts the audio file a.wav and the raw YUV video file a.yuv
878 to MPEG file a.mpg.
879
880 * You can also do audio and video conversions at the same time:
881
882 @example
883 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
884 @end example
885
886 Converts a.wav to MPEG audio at 22050 Hz sample rate.
887
888 * You can encode to several formats at the same time and define a
889 mapping from input stream to output streams:
890
891 @example
892 ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
893 @end example
894
895 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
896 file:index' specifies which input stream is used for each output
897 stream, in the order of the definition of output streams.
898
899 * You can transcode decrypted VOBs:
900
901 @example
902 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
903 @end example
904
905 This is a typical DVD ripping example; the input is a VOB file, the
906 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
907 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
908 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
909 input video. Furthermore, the audio stream is MP3-encoded so you need
910 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
911 The mapping is particularly useful for DVD transcoding
912 to get the desired audio language.
913
914 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
915
916 * You can extract images from a video, or create a video from many images:
917
918 For extracting images from a video:
919 @example
920 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
921 @end example
922
923 This will extract one video frame per second from the video and will
924 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
925 etc. Images will be rescaled to fit the new WxH values.
926
927 If you want to extract just a limited number of frames, you can use the
928 above command in combination with the -vframes or -t option, or in
929 combination with -ss to start extracting from a certain point in time.
930
931 For creating a video from many images:
932 @example
933 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
934 @end example
935
936 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
937 composed of three digits padded with zeroes to express the sequence
938 number. It is the same syntax supported by the C printf function, but
939 only formats accepting a normal integer are suitable.
940
941 * You can put many streams of the same type in the output:
942
943 @example
944 ffmpeg -i test1.avi -i test2.avi -vcodec copy -acodec copy -vcodec copy -acodec copy test12.avi -newvideo -newaudio
945 @end example
946
947 In addition to the first video and audio streams, the resulting
948 output file @file{test12.avi} will contain the second video
949 and the second audio stream found in the input streams list.
950
951 The @code{-newvideo}, @code{-newaudio} and @code{-newsubtitle}
952 options have to be specified immediately after the name of the output
953 file to which you want to add them.
954 @c man end EXAMPLES
955
956 @include indevs.texi
957 @include outdevs.texi
958 @include protocols.texi
959 @include filters.texi
960
961 @ignore
962
963 @setfilename ffmpeg
964 @settitle FFmpeg video converter
965
966 @c man begin SEEALSO
967 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
968 @c man end
969
970 @c man begin AUTHORS
971 The FFmpeg developers
972 @c man end
973
974 @end ignore
975
976 @bye