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