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.

1140 lines
39KB

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