ffmpeg-doc.texi 27 KB

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