You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

963 lines
28KB

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