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