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.

1135 lines
34KB

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