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.

1700 lines
64KB

  1. \input texinfo @c -*- texinfo -*-
  2. @documentencoding UTF-8
  3. @settitle ffmpeg Documentation
  4. @titlepage
  5. @center @titlefont{ffmpeg Documentation}
  6. @end titlepage
  7. @top
  8. @contents
  9. @chapter Synopsis
  10. ffmpeg [@var{global_options}] @{[@var{input_file_options}] -i @file{input_url}@} ... @{[@var{output_file_options}] @file{output_url}@} ...
  11. @chapter Description
  12. @c man begin DESCRIPTION
  13. @command{ffmpeg} is a very fast video and audio converter that can also grab from
  14. a live audio/video source. It can also convert between arbitrary sample
  15. rates and resize video on the fly with a high quality polyphase filter.
  16. @command{ffmpeg} reads from an arbitrary number of input "files" (which can be regular
  17. files, pipes, network streams, grabbing devices, etc.), specified by the
  18. @code{-i} option, and writes to an arbitrary number of output "files", which are
  19. specified by a plain output url. Anything found on the command line which
  20. cannot be interpreted as an option is considered to be an output url.
  21. Each input or output url can, in principle, contain any number of streams of
  22. different types (video/audio/subtitle/attachment/data). The allowed number and/or
  23. types of streams may be limited by the container format. Selecting which
  24. streams from which inputs will go into which output is either done automatically
  25. or with the @code{-map} option (see the Stream selection chapter).
  26. To refer to input files in options, you must use their indices (0-based). E.g.
  27. the first input file is @code{0}, the second is @code{1}, etc. Similarly, streams
  28. within a file are referred to by their indices. E.g. @code{2:3} refers to the
  29. fourth stream in the third input file. Also see the Stream specifiers chapter.
  30. As a general rule, options are applied to the next specified
  31. file. Therefore, order is important, and you can have the same
  32. option on the command line multiple times. Each occurrence is
  33. then applied to the next input or output file.
  34. Exceptions from this rule are the global options (e.g. verbosity level),
  35. which should be specified first.
  36. Do not mix input and output files -- first specify all input files, then all
  37. output files. Also do not mix options which belong to different files. All
  38. options apply ONLY to the next input or output file and are reset between files.
  39. @itemize
  40. @item
  41. To set the video bitrate of the output file to 64 kbit/s:
  42. @example
  43. ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
  44. @end example
  45. @item
  46. To force the frame rate of the output file to 24 fps:
  47. @example
  48. ffmpeg -i input.avi -r 24 output.avi
  49. @end example
  50. @item
  51. To force the frame rate of the input file (valid for raw formats only)
  52. to 1 fps and the frame rate of the output file to 24 fps:
  53. @example
  54. ffmpeg -r 1 -i input.m2v -r 24 output.avi
  55. @end example
  56. @end itemize
  57. The format option may be needed for raw input files.
  58. @c man end DESCRIPTION
  59. @chapter Detailed description
  60. @c man begin DETAILED DESCRIPTION
  61. The transcoding process in @command{ffmpeg} for each output can be described by
  62. the following diagram:
  63. @verbatim
  64. _______ ______________
  65. | | | |
  66. | input | demuxer | encoded data | decoder
  67. | file | ---------> | packets | -----+
  68. |_______| |______________| |
  69. v
  70. _________
  71. | |
  72. | decoded |
  73. | frames |
  74. |_________|
  75. ________ ______________ |
  76. | | | | |
  77. | output | <-------- | encoded data | <----+
  78. | file | muxer | packets | encoder
  79. |________| |______________|
  80. @end verbatim
  81. @command{ffmpeg} calls the libavformat library (containing demuxers) to read
  82. input files and get packets containing encoded data from them. When there are
  83. multiple input files, @command{ffmpeg} tries to keep them synchronized by
  84. tracking lowest timestamp on any active input stream.
  85. Encoded packets are then passed to the decoder (unless streamcopy is selected
  86. for the stream, see further for a description). The decoder produces
  87. uncompressed frames (raw video/PCM audio/...) which can be processed further by
  88. filtering (see next section). After filtering, the frames are passed to the
  89. encoder, which encodes them and outputs encoded packets. Finally those are
  90. passed to the muxer, which writes the encoded packets to the output file.
  91. @section Filtering
  92. Before encoding, @command{ffmpeg} can process raw audio and video frames using
  93. filters from the libavfilter library. Several chained filters form a filter
  94. graph. @command{ffmpeg} distinguishes between two types of filtergraphs:
  95. simple and complex.
  96. @subsection Simple filtergraphs
  97. Simple filtergraphs are those that have exactly one input and output, both of
  98. the same type. In the above diagram they can be represented by simply inserting
  99. an additional step between decoding and encoding:
  100. @verbatim
  101. _________ ______________
  102. | | | |
  103. | decoded | | encoded data |
  104. | frames |\ _ | packets |
  105. |_________| \ /||______________|
  106. \ __________ /
  107. simple _\|| | / encoder
  108. filtergraph | filtered |/
  109. | frames |
  110. |__________|
  111. @end verbatim
  112. Simple filtergraphs are configured with the per-stream @option{-filter} option
  113. (with @option{-vf} and @option{-af} aliases for video and audio respectively).
  114. A simple filtergraph for video can look for example like this:
  115. @verbatim
  116. _______ _____________ _______ ________
  117. | | | | | | | |
  118. | input | ---> | deinterlace | ---> | scale | ---> | output |
  119. |_______| |_____________| |_______| |________|
  120. @end verbatim
  121. Note that some filters change frame properties but not frame contents. E.g. the
  122. @code{fps} filter in the example above changes number of frames, but does not
  123. touch the frame contents. Another example is the @code{setpts} filter, which
  124. only sets timestamps and otherwise passes the frames unchanged.
  125. @subsection Complex filtergraphs
  126. Complex filtergraphs are those which cannot be described as simply a linear
  127. processing chain applied to one stream. This is the case, for example, when the graph has
  128. more than one input and/or output, or when output stream type is different from
  129. input. They can be represented with the following diagram:
  130. @verbatim
  131. _________
  132. | |
  133. | input 0 |\ __________
  134. |_________| \ | |
  135. \ _________ /| output 0 |
  136. \ | | / |__________|
  137. _________ \| complex | /
  138. | | | |/
  139. | input 1 |---->| filter |\
  140. |_________| | | \ __________
  141. /| graph | \ | |
  142. / | | \| output 1 |
  143. _________ / |_________| |__________|
  144. | | /
  145. | input 2 |/
  146. |_________|
  147. @end verbatim
  148. Complex filtergraphs are configured with the @option{-filter_complex} option.
  149. Note that this option is global, since a complex filtergraph, by its nature,
  150. cannot be unambiguously associated with a single stream or file.
  151. The @option{-lavfi} option is equivalent to @option{-filter_complex}.
  152. A trivial example of a complex filtergraph is the @code{overlay} filter, which
  153. has two video inputs and one video output, containing one video overlaid on top
  154. of the other. Its audio counterpart is the @code{amix} filter.
  155. @section Stream copy
  156. Stream copy is a mode selected by supplying the @code{copy} parameter to the
  157. @option{-codec} option. It makes @command{ffmpeg} omit the decoding and encoding
  158. step for the specified stream, so it does only demuxing and muxing. It is useful
  159. for changing the container format or modifying container-level metadata. The
  160. diagram above will, in this case, simplify to this:
  161. @verbatim
  162. _______ ______________ ________
  163. | | | | | |
  164. | input | demuxer | encoded data | muxer | output |
  165. | file | ---------> | packets | -------> | file |
  166. |_______| |______________| |________|
  167. @end verbatim
  168. Since there is no decoding or encoding, it is very fast and there is no quality
  169. loss. However, it might not work in some cases because of many factors. Applying
  170. filters is obviously also impossible, since filters work on uncompressed data.
  171. @c man end DETAILED DESCRIPTION
  172. @chapter Stream selection
  173. @c man begin STREAM SELECTION
  174. By default, @command{ffmpeg} includes only one stream of each type (video, audio, subtitle)
  175. present in the input files and adds them to each output file. It picks the
  176. "best" of each based upon the following criteria: for video, it is the stream
  177. with the highest resolution, for audio, it is the stream with the most channels, for
  178. subtitles, it is the first subtitle stream. In the case where several streams of
  179. the same type rate equally, the stream with the lowest index is chosen.
  180. You can disable some of those defaults by using the @code{-vn/-an/-sn/-dn} options. For
  181. full manual control, use the @code{-map} option, which disables the defaults just
  182. described.
  183. @c man end STREAM SELECTION
  184. @chapter Options
  185. @c man begin OPTIONS
  186. @include fftools-common-opts.texi
  187. @section Main options
  188. @table @option
  189. @item -f @var{fmt} (@emph{input/output})
  190. Force input or output file format. The format is normally auto detected for input
  191. files and guessed from the file extension for output files, so this option is not
  192. needed in most cases.
  193. @item -i @var{url} (@emph{input})
  194. input file url
  195. @item -y (@emph{global})
  196. Overwrite output files without asking.
  197. @item -n (@emph{global})
  198. Do not overwrite output files, and exit immediately if a specified
  199. output file already exists.
  200. @item -stream_loop @var{number} (@emph{input})
  201. Set number of times input stream shall be looped. Loop 0 means no loop,
  202. loop -1 means infinite loop.
  203. @item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
  204. @itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
  205. Select an encoder (when used before an output file) or a decoder (when used
  206. before an input file) for one or more streams. @var{codec} is the name of a
  207. decoder/encoder or a special value @code{copy} (output only) to indicate that
  208. the stream is not to be re-encoded.
  209. For example
  210. @example
  211. ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
  212. @end example
  213. encodes all video streams with libx264 and copies all audio streams.
  214. For each stream, the last matching @code{c} option is applied, so
  215. @example
  216. ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
  217. @end example
  218. will copy all the streams except the second video, which will be encoded with
  219. libx264, and the 138th audio, which will be encoded with libvorbis.
  220. @item -t @var{duration} (@emph{input/output})
  221. When used as an input option (before @code{-i}), limit the @var{duration} of
  222. data read from the input file.
  223. When used as an output option (before an output url), stop writing the
  224. output after its duration reaches @var{duration}.
  225. @var{duration} must be a time duration specification,
  226. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  227. -to and -t are mutually exclusive and -t has priority.
  228. @item -to @var{position} (@emph{output})
  229. Stop writing the output at @var{position}.
  230. @var{position} must be a time duration specification,
  231. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  232. -to and -t are mutually exclusive and -t has priority.
  233. @item -fs @var{limit_size} (@emph{output})
  234. Set the file size limit, expressed in bytes. No further chunk of bytes is written
  235. after the limit is exceeded. The size of the output file is slightly more than the
  236. requested file size.
  237. @item -ss @var{position} (@emph{input/output})
  238. When used as an input option (before @code{-i}), seeks in this input file to
  239. @var{position}. Note that in most formats it is not possible to seek exactly,
  240. so @command{ffmpeg} will seek to the closest seek point before @var{position}.
  241. When transcoding and @option{-accurate_seek} is enabled (the default), this
  242. extra segment between the seek point and @var{position} will be decoded and
  243. discarded. When doing stream copy or when @option{-noaccurate_seek} is used, it
  244. will be preserved.
  245. When used as an output option (before an output url), decodes but discards
  246. input until the timestamps reach @var{position}.
  247. @var{position} must be a time duration specification,
  248. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  249. @item -sseof @var{position} (@emph{input/output})
  250. Like the @code{-ss} option but relative to the "end of file". That is negative
  251. values are earlier in the file, 0 is at EOF.
  252. @item -itsoffset @var{offset} (@emph{input})
  253. Set the input time offset.
  254. @var{offset} must be a time duration specification,
  255. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  256. The offset is added to the timestamps of the input files. Specifying
  257. a positive offset means that the corresponding streams are delayed by
  258. the time duration specified in @var{offset}.
  259. @item -timestamp @var{date} (@emph{output})
  260. Set the recording timestamp in the container.
  261. @var{date} must be a date specification,
  262. see @ref{date syntax,,the Date section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  263. @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
  264. Set a metadata key/value pair.
  265. An optional @var{metadata_specifier} may be given to set metadata
  266. on streams, chapters or programs. See @code{-map_metadata}
  267. documentation for details.
  268. This option overrides metadata set with @code{-map_metadata}. It is
  269. also possible to delete metadata by using an empty value.
  270. For example, for setting the title in the output file:
  271. @example
  272. ffmpeg -i in.avi -metadata title="my title" out.flv
  273. @end example
  274. To set the language of the first audio stream:
  275. @example
  276. ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
  277. @end example
  278. @item -disposition[:stream_specifier] @var{value} (@emph{output,per-stream})
  279. Sets the disposition for a stream.
  280. This option overrides the disposition copied from the input stream. It is also
  281. possible to delete the disposition by setting it to 0.
  282. The following dispositions are recognized:
  283. @table @option
  284. @item default
  285. @item dub
  286. @item original
  287. @item comment
  288. @item lyrics
  289. @item karaoke
  290. @item forced
  291. @item hearing_impaired
  292. @item visual_impaired
  293. @item clean_effects
  294. @item captions
  295. @item descriptions
  296. @item metadata
  297. @end table
  298. For example, to make the second audio stream the default stream:
  299. @example
  300. ffmpeg -i in.mkv -disposition:a:1 default out.mkv
  301. @end example
  302. To make the second subtitle stream the default stream and remove the default
  303. disposition from the first subtitle stream:
  304. @example
  305. ffmpeg -i INPUT -disposition:s:0 0 -disposition:s:1 default OUTPUT
  306. @end example
  307. @item -program [title=@var{title}:][program_num=@var{program_num}:]st=@var{stream}[:st=@var{stream}...] (@emph{output})
  308. Creates a program with the specified @var{title}, @var{program_num} and adds the specified
  309. @var{stream}(s) to it.
  310. @item -target @var{type} (@emph{output})
  311. Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
  312. @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
  313. @code{film-} to use the corresponding standard. All the format options
  314. (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
  315. @example
  316. ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
  317. @end example
  318. Nevertheless you can specify additional options as long as you know
  319. they do not conflict with the standard, as in:
  320. @example
  321. ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
  322. @end example
  323. @item -dframes @var{number} (@emph{output})
  324. Set the number of data frames to output. This is an obsolete alias for
  325. @code{-frames:d}, which you should use instead.
  326. @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
  327. Stop writing to the stream after @var{framecount} frames.
  328. @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
  329. @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
  330. Use fixed quality scale (VBR). The meaning of @var{q}/@var{qscale} is
  331. codec-dependent.
  332. If @var{qscale} is used without a @var{stream_specifier} then it applies only
  333. to the video stream, this is to maintain compatibility with previous behavior
  334. and as specifying the same codec specific value to 2 different codecs that is
  335. audio and video generally is not what is intended when no stream_specifier is
  336. used.
  337. @anchor{filter_option}
  338. @item -filter[:@var{stream_specifier}] @var{filtergraph} (@emph{output,per-stream})
  339. Create the filtergraph specified by @var{filtergraph} and use it to
  340. filter the stream.
  341. @var{filtergraph} is a description of the filtergraph to apply to
  342. the stream, and must have a single input and a single output of the
  343. same type of the stream. In the filtergraph, the input is associated
  344. to the label @code{in}, and the output to the label @code{out}. See
  345. the ffmpeg-filters manual for more information about the filtergraph
  346. syntax.
  347. See the @ref{filter_complex_option,,-filter_complex option} if you
  348. want to create filtergraphs with multiple inputs and/or outputs.
  349. @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
  350. This option is similar to @option{-filter}, the only difference is that its
  351. argument is the name of the file from which a filtergraph description is to be
  352. read.
  353. @item -filter_threads @var{nb_threads} (@emph{global})
  354. Defines how many threads are used to process a filter pipeline. Each pipeline
  355. will produce a thread pool with this many threads available for parallel processing.
  356. The default is the number of available CPUs.
  357. @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
  358. Specify the preset for matching stream(s).
  359. @item -stats (@emph{global})
  360. Print encoding progress/statistics. It is on by default, to explicitly
  361. disable it you need to specify @code{-nostats}.
  362. @item -progress @var{url} (@emph{global})
  363. Send program-friendly progress information to @var{url}.
  364. Progress information is written approximately every second and at the end of
  365. the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
  366. consists of only alphanumeric characters. The last key of a sequence of
  367. progress information is always "progress".
  368. @item -stdin
  369. Enable interaction on standard input. On by default unless standard input is
  370. used as an input. To explicitly disable interaction you need to specify
  371. @code{-nostdin}.
  372. Disabling interaction on standard input is useful, for example, if
  373. ffmpeg is in the background process group. Roughly the same result can
  374. be achieved with @code{ffmpeg ... < /dev/null} but it requires a
  375. shell.
  376. @item -debug_ts (@emph{global})
  377. Print timestamp information. It is off by default. This option is
  378. mostly useful for testing and debugging purposes, and the output
  379. format may change from one version to another, so it should not be
  380. employed by portable scripts.
  381. See also the option @code{-fdebug ts}.
  382. @item -attach @var{filename} (@emph{output})
  383. Add an attachment to the output file. This is supported by a few formats
  384. like Matroska for e.g. fonts used in rendering subtitles. Attachments
  385. are implemented as a specific type of stream, so this option will add
  386. a new stream to the file. It is then possible to use per-stream options
  387. on this stream in the usual way. Attachment streams created with this
  388. option will be created after all the other streams (i.e. those created
  389. with @code{-map} or automatic mappings).
  390. Note that for Matroska you also have to set the mimetype metadata tag:
  391. @example
  392. ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
  393. @end example
  394. (assuming that the attachment stream will be third in the output file).
  395. @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
  396. Extract the matching attachment stream into a file named @var{filename}. If
  397. @var{filename} is empty, then the value of the @code{filename} metadata tag
  398. will be used.
  399. E.g. to extract the first attachment to a file named 'out.ttf':
  400. @example
  401. ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
  402. @end example
  403. To extract all attachments to files determined by the @code{filename} tag:
  404. @example
  405. ffmpeg -dump_attachment:t "" -i INPUT
  406. @end example
  407. Technical note -- attachments are implemented as codec extradata, so this
  408. option can actually be used to extract extradata from any stream, not just
  409. attachments.
  410. @item -noautorotate
  411. Disable automatically rotating video based on file metadata.
  412. @end table
  413. @section Video Options
  414. @table @option
  415. @item -vframes @var{number} (@emph{output})
  416. Set the number of video frames to output. This is an obsolete alias for
  417. @code{-frames:v}, which you should use instead.
  418. @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
  419. Set frame rate (Hz value, fraction or abbreviation).
  420. As an input option, ignore any timestamps stored in the file and instead
  421. generate timestamps assuming constant frame rate @var{fps}.
  422. This is not the same as the @option{-framerate} option used for some input formats
  423. like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
  424. If in doubt use @option{-framerate} instead of the input option @option{-r}.
  425. As an output option, duplicate or drop input frames to achieve constant output
  426. frame rate @var{fps}.
  427. @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
  428. Set frame size.
  429. As an input option, this is a shortcut for the @option{video_size} private
  430. option, recognized by some demuxers for which the frame size is either not
  431. stored in the file or is configurable -- e.g. raw video or video grabbers.
  432. As an output option, this inserts the @code{scale} video filter to the
  433. @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
  434. directly to insert it at the beginning or some other place.
  435. The format is @samp{wxh} (default - same as source).
  436. @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
  437. Set the video display aspect ratio specified by @var{aspect}.
  438. @var{aspect} can be a floating point number string, or a string of the
  439. form @var{num}:@var{den}, where @var{num} and @var{den} are the
  440. numerator and denominator of the aspect ratio. For example "4:3",
  441. "16:9", "1.3333", and "1.7777" are valid argument values.
  442. If used together with @option{-vcodec copy}, it will affect the aspect ratio
  443. stored at container level, but not the aspect ratio stored in encoded
  444. frames, if it exists.
  445. @item -vn (@emph{output})
  446. Disable video recording.
  447. @item -vcodec @var{codec} (@emph{output})
  448. Set the video codec. This is an alias for @code{-codec:v}.
  449. @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
  450. Select the pass number (1 or 2). It is used to do two-pass
  451. video encoding. The statistics of the video are recorded in the first
  452. pass into a log file (see also the option -passlogfile),
  453. and in the second pass that log file is used to generate the video
  454. at the exact requested bitrate.
  455. On pass 1, you may just deactivate audio and set output to null,
  456. examples for Windows and Unix:
  457. @example
  458. ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
  459. ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
  460. @end example
  461. @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
  462. Set two-pass log file name prefix to @var{prefix}, the default file name
  463. prefix is ``ffmpeg2pass''. The complete file name will be
  464. @file{PREFIX-N.log}, where N is a number specific to the output
  465. stream
  466. @item -vf @var{filtergraph} (@emph{output})
  467. Create the filtergraph specified by @var{filtergraph} and use it to
  468. filter the stream.
  469. This is an alias for @code{-filter:v}, see the @ref{filter_option,,-filter option}.
  470. @end table
  471. @section Advanced Video options
  472. @table @option
  473. @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
  474. Set pixel format. Use @code{-pix_fmts} to show all the supported
  475. pixel formats.
  476. If the selected pixel format can not be selected, ffmpeg will print a
  477. warning and select the best pixel format supported by the encoder.
  478. If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
  479. if the requested pixel format can not be selected, and automatic conversions
  480. inside filtergraphs are disabled.
  481. If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
  482. as the input (or graph output) and automatic conversions are disabled.
  483. @item -sws_flags @var{flags} (@emph{input/output})
  484. Set SwScaler flags.
  485. @item -vdt @var{n}
  486. Discard threshold.
  487. @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
  488. Rate control override for specific intervals, formatted as "int,int,int"
  489. list separated with slashes. Two first values are the beginning and
  490. end frame numbers, last one is quantizer to use if positive, or quality
  491. factor if negative.
  492. @item -ilme
  493. Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
  494. Use this option if your input file is interlaced and you want
  495. to keep the interlaced format for minimum losses.
  496. The alternative is to deinterlace the input stream with
  497. @option{-deinterlace}, but deinterlacing introduces losses.
  498. @item -psnr
  499. Calculate PSNR of compressed frames.
  500. @item -vstats
  501. Dump video coding statistics to @file{vstats_HHMMSS.log}.
  502. @item -vstats_file @var{file}
  503. Dump video coding statistics to @var{file}.
  504. @item -vstats_version @var{file}
  505. Specifies which version of the vstats format to use. Default is 2.
  506. version = 1 :
  507. @code{frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
  508. version > 1:
  509. @code{out= %2d st= %2d frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
  510. @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
  511. top=1/bottom=0/auto=-1 field first
  512. @item -dc @var{precision}
  513. Intra_dc_precision.
  514. @item -vtag @var{fourcc/tag} (@emph{output})
  515. Force video tag/fourcc. This is an alias for @code{-tag:v}.
  516. @item -qphist (@emph{global})
  517. Show QP histogram
  518. @item -vbsf @var{bitstream_filter}
  519. Deprecated see -bsf
  520. @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
  521. @item -force_key_frames[:@var{stream_specifier}] expr:@var{expr} (@emph{output,per-stream})
  522. Force key frames at the specified timestamps, more precisely at the first
  523. frames after each specified time.
  524. If the argument is prefixed with @code{expr:}, the string @var{expr}
  525. is interpreted like an expression and is evaluated for each frame. A
  526. key frame is forced in case the evaluation is non-zero.
  527. If one of the times is "@code{chapters}[@var{delta}]", it is expanded into
  528. the time of the beginning of all chapters in the file, shifted by
  529. @var{delta}, expressed as a time in seconds.
  530. This option can be useful to ensure that a seek point is present at a
  531. chapter mark or any other designated place in the output file.
  532. For example, to insert a key frame at 5 minutes, plus key frames 0.1 second
  533. before the beginning of every chapter:
  534. @example
  535. -force_key_frames 0:05:00,chapters-0.1
  536. @end example
  537. The expression in @var{expr} can contain the following constants:
  538. @table @option
  539. @item n
  540. the number of current processed frame, starting from 0
  541. @item n_forced
  542. the number of forced frames
  543. @item prev_forced_n
  544. the number of the previous forced frame, it is @code{NAN} when no
  545. keyframe was forced yet
  546. @item prev_forced_t
  547. the time of the previous forced frame, it is @code{NAN} when no
  548. keyframe was forced yet
  549. @item t
  550. the time of the current processed frame
  551. @end table
  552. For example to force a key frame every 5 seconds, you can specify:
  553. @example
  554. -force_key_frames expr:gte(t,n_forced*5)
  555. @end example
  556. To force a key frame 5 seconds after the time of the last forced one,
  557. starting from second 13:
  558. @example
  559. -force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
  560. @end example
  561. Note that forcing too many keyframes is very harmful for the lookahead
  562. algorithms of certain encoders: using fixed-GOP options or similar
  563. would be more efficient.
  564. @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
  565. When doing stream copy, copy also non-key frames found at the
  566. beginning.
  567. @item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
  568. Use hardware acceleration to decode the matching stream(s). The allowed values
  569. of @var{hwaccel} are:
  570. @table @option
  571. @item none
  572. Do not use any hardware acceleration (the default).
  573. @item auto
  574. Automatically select the hardware acceleration method.
  575. @item vda
  576. Use Apple VDA hardware acceleration.
  577. @item vdpau
  578. Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
  579. @item dxva2
  580. Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
  581. @item qsv
  582. Use the Intel QuickSync Video acceleration for video transcoding.
  583. Unlike most other values, this option does not enable accelerated decoding (that
  584. is used automatically whenever a qsv decoder is selected), but accelerated
  585. transcoding, without copying the frames into the system memory.
  586. For it to work, both the decoder and the encoder must support QSV acceleration
  587. and no filters must be used.
  588. @end table
  589. This option has no effect if the selected hwaccel is not available or not
  590. supported by the chosen decoder.
  591. Note that most acceleration methods are intended for playback and will not be
  592. faster than software decoding on modern CPUs. Additionally, @command{ffmpeg}
  593. will usually need to copy the decoded frames from the GPU memory into the system
  594. memory, resulting in further performance loss. This option is thus mainly
  595. useful for testing.
  596. @item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
  597. Select a device to use for hardware acceleration.
  598. This option only makes sense when the @option{-hwaccel} option is also
  599. specified. Its exact meaning depends on the specific hardware acceleration
  600. method chosen.
  601. @table @option
  602. @item vdpau
  603. For VDPAU, this option specifies the X11 display/screen to use. If this option
  604. is not specified, the value of the @var{DISPLAY} environment variable is used
  605. @item dxva2
  606. For DXVA2, this option should contain the number of the display adapter to use.
  607. If this option is not specified, the default adapter is used.
  608. @item qsv
  609. For QSV, this option corresponds to the values of MFX_IMPL_* . Allowed values
  610. are:
  611. @table @option
  612. @item auto
  613. @item sw
  614. @item hw
  615. @item auto_any
  616. @item hw_any
  617. @item hw2
  618. @item hw3
  619. @item hw4
  620. @end table
  621. @end table
  622. @item -hwaccels
  623. List all hardware acceleration methods supported in this build of ffmpeg.
  624. @end table
  625. @section Audio Options
  626. @table @option
  627. @item -aframes @var{number} (@emph{output})
  628. Set the number of audio frames to output. This is an obsolete alias for
  629. @code{-frames:a}, which you should use instead.
  630. @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
  631. Set the audio sampling frequency. For output streams it is set by
  632. default to the frequency of the corresponding input stream. For input
  633. streams this option only makes sense for audio grabbing devices and raw
  634. demuxers and is mapped to the corresponding demuxer options.
  635. @item -aq @var{q} (@emph{output})
  636. Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
  637. @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
  638. Set the number of audio channels. For output streams it is set by
  639. default to the number of input audio channels. For input streams
  640. this option only makes sense for audio grabbing devices and raw demuxers
  641. and is mapped to the corresponding demuxer options.
  642. @item -an (@emph{output})
  643. Disable audio recording.
  644. @item -acodec @var{codec} (@emph{input/output})
  645. Set the audio codec. This is an alias for @code{-codec:a}.
  646. @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
  647. Set the audio sample format. Use @code{-sample_fmts} to get a list
  648. of supported sample formats.
  649. @item -af @var{filtergraph} (@emph{output})
  650. Create the filtergraph specified by @var{filtergraph} and use it to
  651. filter the stream.
  652. This is an alias for @code{-filter:a}, see the @ref{filter_option,,-filter option}.
  653. @end table
  654. @section Advanced Audio options
  655. @table @option
  656. @item -atag @var{fourcc/tag} (@emph{output})
  657. Force audio tag/fourcc. This is an alias for @code{-tag:a}.
  658. @item -absf @var{bitstream_filter}
  659. Deprecated, see -bsf
  660. @item -guess_layout_max @var{channels} (@emph{input,per-stream})
  661. If some input channel layout is not known, try to guess only if it
  662. corresponds to at most the specified number of channels. For example, 2
  663. tells to @command{ffmpeg} to recognize 1 channel as mono and 2 channels as
  664. stereo but not 6 channels as 5.1. The default is to always try to guess. Use
  665. 0 to disable all guessing.
  666. @end table
  667. @section Subtitle options
  668. @table @option
  669. @item -scodec @var{codec} (@emph{input/output})
  670. Set the subtitle codec. This is an alias for @code{-codec:s}.
  671. @item -sn (@emph{output})
  672. Disable subtitle recording.
  673. @item -sbsf @var{bitstream_filter}
  674. Deprecated, see -bsf
  675. @end table
  676. @section Advanced Subtitle options
  677. @table @option
  678. @item -fix_sub_duration
  679. Fix subtitles durations. For each subtitle, wait for the next packet in the
  680. same stream and adjust the duration of the first to avoid overlap. This is
  681. necessary with some subtitles codecs, especially DVB subtitles, because the
  682. duration in the original packet is only a rough estimate and the end is
  683. actually marked by an empty subtitle frame. Failing to use this option when
  684. necessary can result in exaggerated durations or muxing failures due to
  685. non-monotonic timestamps.
  686. Note that this option will delay the output of all data until the next
  687. subtitle packet is decoded: it may increase memory consumption and latency a
  688. lot.
  689. @item -canvas_size @var{size}
  690. Set the size of the canvas used to render subtitles.
  691. @end table
  692. @section Advanced options
  693. @table @option
  694. @item -map [-]@var{input_file_id}[:@var{stream_specifier}][?][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
  695. Designate one or more input streams as a source for the output file. Each input
  696. stream is identified by the input file index @var{input_file_id} and
  697. the input stream index @var{input_stream_id} within the input
  698. file. Both indices start at 0. If specified,
  699. @var{sync_file_id}:@var{stream_specifier} sets which input stream
  700. is used as a presentation sync reference.
  701. The first @code{-map} option on the command line specifies the
  702. source for output stream 0, the second @code{-map} option specifies
  703. the source for output stream 1, etc.
  704. A @code{-} character before the stream identifier creates a "negative" mapping.
  705. It disables matching streams from already created mappings.
  706. A trailing @code{?} after the stream index will allow the map to be
  707. optional: if the map matches no streams the map will be ignored instead
  708. of failing. Note the map will still fail if an invalid input file index
  709. is used; such as if the map refers to a non-existant input.
  710. An alternative @var{[linklabel]} form will map outputs from complex filter
  711. graphs (see the @option{-filter_complex} option) to the output file.
  712. @var{linklabel} must correspond to a defined output link label in the graph.
  713. For example, to map ALL streams from the first input file to output
  714. @example
  715. ffmpeg -i INPUT -map 0 output
  716. @end example
  717. For example, if you have two audio streams in the first input file,
  718. these streams are identified by "0:0" and "0:1". You can use
  719. @code{-map} to select which streams to place in an output file. For
  720. example:
  721. @example
  722. ffmpeg -i INPUT -map 0:1 out.wav
  723. @end example
  724. will map the input stream in @file{INPUT} identified by "0:1" to
  725. the (single) output stream in @file{out.wav}.
  726. For example, to select the stream with index 2 from input file
  727. @file{a.mov} (specified by the identifier "0:2"), and stream with
  728. index 6 from input @file{b.mov} (specified by the identifier "1:6"),
  729. and copy them to the output file @file{out.mov}:
  730. @example
  731. ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
  732. @end example
  733. To select all video and the third audio stream from an input file:
  734. @example
  735. ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
  736. @end example
  737. To map all the streams except the second audio, use negative mappings
  738. @example
  739. ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
  740. @end example
  741. To map the video and audio streams from the first input, and using the
  742. trailing @code{?}, ignore the audio mapping if no audio streams exist in
  743. the first input:
  744. @example
  745. ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
  746. @end example
  747. To pick the English audio stream:
  748. @example
  749. ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
  750. @end example
  751. Note that using this option disables the default mappings for this output file.
  752. @item -ignore_unknown
  753. Ignore input streams with unknown type instead of failing if copying
  754. such streams is attempted.
  755. @item -copy_unknown
  756. Allow input streams with unknown type to be copied instead of failing if copying
  757. such streams is attempted.
  758. @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][:@var{output_file_id}.@var{stream_specifier}]
  759. Map an audio channel from a given input to an output. If
  760. @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
  761. be mapped on all the audio streams.
  762. Using "-1" instead of
  763. @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
  764. channel.
  765. For example, assuming @var{INPUT} is a stereo audio file, you can switch the
  766. two audio channels with the following command:
  767. @example
  768. ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
  769. @end example
  770. If you want to mute the first channel and keep the second:
  771. @example
  772. ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
  773. @end example
  774. The order of the "-map_channel" option specifies the order of the channels in
  775. the output stream. The output channel layout is guessed from the number of
  776. channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
  777. in combination of "-map_channel" makes the channel gain levels to be updated if
  778. input and output channel layouts don't match (for instance two "-map_channel"
  779. options and "-ac 6").
  780. You can also extract each channel of an input to specific outputs; the following
  781. command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
  782. to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
  783. @example
  784. ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
  785. @end example
  786. The following example splits the channels of a stereo input into two separate
  787. streams, which are put into the same output file:
  788. @example
  789. 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
  790. @end example
  791. Note that currently each output stream can only contain channels from a single
  792. input stream; you can't for example use "-map_channel" to pick multiple input
  793. audio channels contained in different streams (from the same or different files)
  794. and merge them into a single output stream. It is therefore not currently
  795. possible, for example, to turn two separate mono streams into a single stereo
  796. stream. However splitting a stereo stream into two single channel mono streams
  797. is possible.
  798. If you need this feature, a possible workaround is to use the @emph{amerge}
  799. filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
  800. mono audio streams into one single stereo channel audio stream (and keep the
  801. video stream), you can use the following command:
  802. @example
  803. ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
  804. @end example
  805. @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
  806. Set metadata information of the next output file from @var{infile}. Note that
  807. those are file indices (zero-based), not filenames.
  808. Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
  809. A metadata specifier can have the following forms:
  810. @table @option
  811. @item @var{g}
  812. global metadata, i.e. metadata that applies to the whole file
  813. @item @var{s}[:@var{stream_spec}]
  814. per-stream metadata. @var{stream_spec} is a stream specifier as described
  815. in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
  816. matching stream is copied from. In an output metadata specifier, all matching
  817. streams are copied to.
  818. @item @var{c}:@var{chapter_index}
  819. per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
  820. @item @var{p}:@var{program_index}
  821. per-program metadata. @var{program_index} is the zero-based program index.
  822. @end table
  823. If metadata specifier is omitted, it defaults to global.
  824. By default, global metadata is copied from the first input file,
  825. per-stream and per-chapter metadata is copied along with streams/chapters. These
  826. default mappings are disabled by creating any mapping of the relevant type. A negative
  827. file index can be used to create a dummy mapping that just disables automatic copying.
  828. For example to copy metadata from the first stream of the input file to global metadata
  829. of the output file:
  830. @example
  831. ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
  832. @end example
  833. To do the reverse, i.e. copy global metadata to all audio streams:
  834. @example
  835. ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
  836. @end example
  837. Note that simple @code{0} would work as well in this example, since global
  838. metadata is assumed by default.
  839. @item -map_chapters @var{input_file_index} (@emph{output})
  840. Copy chapters from input file with index @var{input_file_index} to the next
  841. output file. If no chapter mapping is specified, then chapters are copied from
  842. the first input file with at least one chapter. Use a negative file index to
  843. disable any chapter copying.
  844. @item -benchmark (@emph{global})
  845. Show benchmarking information at the end of an encode.
  846. Shows CPU time used and maximum memory consumption.
  847. Maximum memory consumption is not supported on all systems,
  848. it will usually display as 0 if not supported.
  849. @item -benchmark_all (@emph{global})
  850. Show benchmarking information during the encode.
  851. Shows CPU time used in various steps (audio/video encode/decode).
  852. @item -timelimit @var{duration} (@emph{global})
  853. Exit after ffmpeg has been running for @var{duration} seconds.
  854. @item -dump (@emph{global})
  855. Dump each input packet to stderr.
  856. @item -hex (@emph{global})
  857. When dumping packets, also dump the payload.
  858. @item -re (@emph{input})
  859. Read input at native frame rate. Mainly used to simulate a grab device,
  860. or live input stream (e.g. when reading from a file). Should not be used
  861. with actual grab devices or live input streams (where it can cause packet
  862. loss).
  863. By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
  864. This option will slow down the reading of the input(s) to the native frame rate
  865. of the input(s). It is useful for real-time output (e.g. live streaming).
  866. @item -loop_input
  867. Loop over the input stream. Currently it works only for image
  868. streams. This option is used for automatic FFserver testing.
  869. This option is deprecated, use -loop 1.
  870. @item -loop_output @var{number_of_times}
  871. Repeatedly loop output for formats that support looping such as animated GIF
  872. (0 will loop the output infinitely).
  873. This option is deprecated, use -loop.
  874. @item -vsync @var{parameter}
  875. Video sync method.
  876. For compatibility reasons old values can be specified as numbers.
  877. Newly added values will have to be specified as strings always.
  878. @table @option
  879. @item 0, passthrough
  880. Each frame is passed with its timestamp from the demuxer to the muxer.
  881. @item 1, cfr
  882. Frames will be duplicated and dropped to achieve exactly the requested
  883. constant frame rate.
  884. @item 2, vfr
  885. Frames are passed through with their timestamp or dropped so as to
  886. prevent 2 frames from having the same timestamp.
  887. @item drop
  888. As passthrough but destroys all timestamps, making the muxer generate
  889. fresh timestamps based on frame-rate.
  890. @item -1, auto
  891. Chooses between 1 and 2 depending on muxer capabilities. This is the
  892. default method.
  893. @end table
  894. Note that the timestamps may be further modified by the muxer, after this.
  895. For example, in the case that the format option @option{avoid_negative_ts}
  896. is enabled.
  897. With -map you can select from which stream the timestamps should be
  898. taken. You can leave either video or audio unchanged and sync the
  899. remaining stream(s) to the unchanged one.
  900. @item -frame_drop_threshold @var{parameter}
  901. Frame drop threshold, which specifies how much behind video frames can
  902. be before they are dropped. In frame rate units, so 1.0 is one frame.
  903. The default is -1.1. One possible usecase is to avoid framedrops in case
  904. of noisy timestamps or to increase frame drop precision in case of exact
  905. timestamps.
  906. @item -async @var{samples_per_second}
  907. Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
  908. the parameter is the maximum samples per second by which the audio is changed.
  909. -async 1 is a special case where only the start of the audio stream is corrected
  910. without any later correction.
  911. Note that the timestamps may be further modified by the muxer, after this.
  912. For example, in the case that the format option @option{avoid_negative_ts}
  913. is enabled.
  914. This option has been deprecated. Use the @code{aresample} audio filter instead.
  915. @item -copyts
  916. Do not process input timestamps, but keep their values without trying
  917. to sanitize them. In particular, do not remove the initial start time
  918. offset value.
  919. Note that, depending on the @option{vsync} option or on specific muxer
  920. processing (e.g. in case the format option @option{avoid_negative_ts}
  921. is enabled) the output timestamps may mismatch with the input
  922. timestamps even when this option is selected.
  923. @item -start_at_zero
  924. When used with @option{copyts}, shift input timestamps so they start at zero.
  925. This means that using e.g. @code{-ss 50} will make output timestamps start at
  926. 50 seconds, regardless of what timestamp the input file started at.
  927. @item -copytb @var{mode}
  928. Specify how to set the encoder timebase when stream copying. @var{mode} is an
  929. integer numeric value, and can assume one of the following values:
  930. @table @option
  931. @item 1
  932. Use the demuxer timebase.
  933. The time base is copied to the output encoder from the corresponding input
  934. demuxer. This is sometimes required to avoid non monotonically increasing
  935. timestamps when copying video streams with variable frame rate.
  936. @item 0
  937. Use the decoder timebase.
  938. The time base is copied to the output encoder from the corresponding input
  939. decoder.
  940. @item -1
  941. Try to make the choice automatically, in order to generate a sane output.
  942. @end table
  943. Default value is -1.
  944. @item -shortest (@emph{output})
  945. Finish encoding when the shortest input stream ends.
  946. @item -dts_delta_threshold
  947. Timestamp discontinuity delta threshold.
  948. @item -muxdelay @var{seconds} (@emph{input})
  949. Set the maximum demux-decode delay.
  950. @item -muxpreload @var{seconds} (@emph{input})
  951. Set the initial demux-decode delay.
  952. @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
  953. Assign a new stream-id value to an output stream. This option should be
  954. specified prior to the output filename to which it applies.
  955. For the situation where multiple output files exist, a streamid
  956. may be reassigned to a different value.
  957. For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
  958. an output mpegts file:
  959. @example
  960. ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
  961. @end example
  962. @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
  963. Set bitstream filters for matching streams. @var{bitstream_filters} is
  964. a comma-separated list of bitstream filters. Use the @code{-bsfs} option
  965. to get the list of bitstream filters.
  966. @example
  967. ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
  968. @end example
  969. @example
  970. ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
  971. @end example
  972. @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
  973. Force a tag/fourcc for matching streams.
  974. @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
  975. Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
  976. (or '.') for drop.
  977. @example
  978. ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
  979. @end example
  980. @anchor{filter_complex_option}
  981. @item -filter_complex @var{filtergraph} (@emph{global})
  982. Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
  983. outputs. For simple graphs -- those with one input and one output of the same
  984. type -- see the @option{-filter} options. @var{filtergraph} is a description of
  985. the filtergraph, as described in the ``Filtergraph syntax'' section of the
  986. ffmpeg-filters manual.
  987. Input link labels must refer to input streams using the
  988. @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
  989. uses). If @var{stream_specifier} matches multiple streams, the first one will be
  990. used. An unlabeled input will be connected to the first unused input stream of
  991. the matching type.
  992. Output link labels are referred to with @option{-map}. Unlabeled outputs are
  993. added to the first output file.
  994. Note that with this option it is possible to use only lavfi sources without
  995. normal input files.
  996. For example, to overlay an image over video
  997. @example
  998. ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
  999. '[out]' out.mkv
  1000. @end example
  1001. Here @code{[0:v]} refers to the first video stream in the first input file,
  1002. which is linked to the first (main) input of the overlay filter. Similarly the
  1003. first video stream in the second input is linked to the second (overlay) input
  1004. of overlay.
  1005. Assuming there is only one video stream in each input file, we can omit input
  1006. labels, so the above is equivalent to
  1007. @example
  1008. ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
  1009. '[out]' out.mkv
  1010. @end example
  1011. Furthermore we can omit the output label and the single output from the filter
  1012. graph will be added to the output file automatically, so we can simply write
  1013. @example
  1014. ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
  1015. @end example
  1016. To generate 5 seconds of pure red video using lavfi @code{color} source:
  1017. @example
  1018. ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
  1019. @end example
  1020. @item -filter_complex_threads @var{nb_threads} (@emph{global})
  1021. Defines how many threads are used to process a filter_complex graph.
  1022. Similar to filter_threads but used for @code{-filter_complex} graphs only.
  1023. The default is the number of available CPUs.
  1024. @item -lavfi @var{filtergraph} (@emph{global})
  1025. Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
  1026. outputs. Equivalent to @option{-filter_complex}.
  1027. @item -filter_complex_script @var{filename} (@emph{global})
  1028. This option is similar to @option{-filter_complex}, the only difference is that
  1029. its argument is the name of the file from which a complex filtergraph
  1030. description is to be read.
  1031. @item -accurate_seek (@emph{input})
  1032. This option enables or disables accurate seeking in input files with the
  1033. @option{-ss} option. It is enabled by default, so seeking is accurate when
  1034. transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
  1035. e.g. when copying some streams and transcoding the others.
  1036. @item -seek_timestamp (@emph{input})
  1037. This option enables or disables seeking by timestamp in input files with the
  1038. @option{-ss} option. It is disabled by default. If enabled, the argument
  1039. to the @option{-ss} option is considered an actual timestamp, and is not
  1040. offset by the start time of the file. This matters only for files which do
  1041. not start from timestamp 0, such as transport streams.
  1042. @item -thread_queue_size @var{size} (@emph{input})
  1043. This option sets the maximum number of queued packets when reading from the
  1044. file or device. With low latency / high rate live streams, packets may be
  1045. discarded if they are not read in a timely manner; raising this value can
  1046. avoid it.
  1047. @item -override_ffserver (@emph{global})
  1048. Overrides the input specifications from @command{ffserver}. Using this
  1049. option you can map any input stream to @command{ffserver} and control
  1050. many aspects of the encoding from @command{ffmpeg}. Without this
  1051. option @command{ffmpeg} will transmit to @command{ffserver} what is
  1052. requested by @command{ffserver}.
  1053. The option is intended for cases where features are needed that cannot be
  1054. specified to @command{ffserver} but can be to @command{ffmpeg}.
  1055. @item -sdp_file @var{file} (@emph{global})
  1056. Print sdp information for an output stream to @var{file}.
  1057. This allows dumping sdp information when at least one output isn't an
  1058. rtp stream. (Requires at least one of the output formats to be rtp).
  1059. @item -discard (@emph{input})
  1060. Allows discarding specific streams or frames of streams at the demuxer.
  1061. Not all demuxers support this.
  1062. @table @option
  1063. @item none
  1064. Discard no frame.
  1065. @item default
  1066. Default, which discards no frames.
  1067. @item noref
  1068. Discard all non-reference frames.
  1069. @item bidir
  1070. Discard all bidirectional frames.
  1071. @item nokey
  1072. Discard all frames excepts keyframes.
  1073. @item all
  1074. Discard all frames.
  1075. @end table
  1076. @item -abort_on @var{flags} (@emph{global})
  1077. Stop and abort on various conditions. The following flags are available:
  1078. @table @option
  1079. @item empty_output
  1080. No packets were passed to the muxer, the output is empty.
  1081. @end table
  1082. @item -xerror (@emph{global})
  1083. Stop and exit on error
  1084. @item -max_muxing_queue_size @var{packets} (@emph{output,per-stream})
  1085. When transcoding audio and/or video streams, ffmpeg will not begin writing into
  1086. the output until it has one packet for each such stream. While waiting for that
  1087. to happen, packets for other streams are buffered. This option sets the size of
  1088. this buffer, in packets, for the matching output stream.
  1089. The default value of this option should be high enough for most uses, so only
  1090. touch this option if you are sure that you need it.
  1091. @end table
  1092. As a special exception, you can use a bitmap subtitle stream as input: it
  1093. will be converted into a video with the same size as the largest video in
  1094. the file, or 720x576 if no video is present. Note that this is an
  1095. experimental and temporary solution. It will be removed once libavfilter has
  1096. proper support for subtitles.
  1097. For example, to hardcode subtitles on top of a DVB-T recording stored in
  1098. MPEG-TS format, delaying the subtitles by 1 second:
  1099. @example
  1100. ffmpeg -i input.ts -filter_complex \
  1101. '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
  1102. -sn -map '#0x2dc' output.mkv
  1103. @end example
  1104. (0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video,
  1105. audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too)
  1106. @section Preset files
  1107. A preset file contains a sequence of @var{option}=@var{value} pairs,
  1108. one for each line, specifying a sequence of options which would be
  1109. awkward to specify on the command line. Lines starting with the hash
  1110. ('#') character are ignored and are used to provide comments. Check
  1111. the @file{presets} directory in the FFmpeg source tree for examples.
  1112. There are two types of preset files: ffpreset and avpreset files.
  1113. @subsection ffpreset files
  1114. ffpreset files are specified with the @code{vpre}, @code{apre},
  1115. @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
  1116. filename of the preset instead of a preset name as input and can be
  1117. used for any kind of codec. For the @code{vpre}, @code{apre}, and
  1118. @code{spre} options, the options specified in a preset file are
  1119. applied to the currently selected codec of the same type as the preset
  1120. option.
  1121. The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
  1122. preset options identifies the preset file to use according to the
  1123. following rules:
  1124. First ffmpeg searches for a file named @var{arg}.ffpreset in the
  1125. directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
  1126. the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
  1127. or in a @file{ffpresets} folder along the executable on win32,
  1128. in that order. For example, if the argument is @code{libvpx-1080p}, it will
  1129. search for the file @file{libvpx-1080p.ffpreset}.
  1130. If no such file is found, then ffmpeg will search for a file named
  1131. @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
  1132. directories, where @var{codec_name} is the name of the codec to which
  1133. the preset file options will be applied. For example, if you select
  1134. the video codec with @code{-vcodec libvpx} and use @code{-vpre 1080p},
  1135. then it will search for the file @file{libvpx-1080p.ffpreset}.
  1136. @subsection avpreset files
  1137. avpreset files are specified with the @code{pre} option. They work similar to
  1138. ffpreset files, but they only allow encoder- specific options. Therefore, an
  1139. @var{option}=@var{value} pair specifying an encoder cannot be used.
  1140. When the @code{pre} option is specified, ffmpeg will look for files with the
  1141. suffix .avpreset in the directories @file{$AVCONV_DATADIR} (if set), and
  1142. @file{$HOME/.avconv}, and in the datadir defined at configuration time (usually
  1143. @file{PREFIX/share/ffmpeg}), in that order.
  1144. First ffmpeg searches for a file named @var{codec_name}-@var{arg}.avpreset in
  1145. the above-mentioned directories, where @var{codec_name} is the name of the codec
  1146. to which the preset file options will be applied. For example, if you select the
  1147. video codec with @code{-vcodec libvpx} and use @code{-pre 1080p}, then it will
  1148. search for the file @file{libvpx-1080p.avpreset}.
  1149. If no such file is found, then ffmpeg will search for a file named
  1150. @var{arg}.avpreset in the same directories.
  1151. @c man end OPTIONS
  1152. @chapter Examples
  1153. @c man begin EXAMPLES
  1154. @section Video and Audio grabbing
  1155. If you specify the input format and device then ffmpeg can grab video
  1156. and audio directly.
  1157. @example
  1158. ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
  1159. @end example
  1160. Or with an ALSA audio source (mono input, card id 1) instead of OSS:
  1161. @example
  1162. ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
  1163. @end example
  1164. Note that you must activate the right video source and channel before
  1165. launching ffmpeg with any TV viewer such as
  1166. @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
  1167. have to set the audio recording levels correctly with a
  1168. standard mixer.
  1169. @section X11 grabbing
  1170. Grab the X11 display with ffmpeg via
  1171. @example
  1172. ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
  1173. @end example
  1174. 0.0 is display.screen number of your X11 server, same as
  1175. the DISPLAY environment variable.
  1176. @example
  1177. ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
  1178. @end example
  1179. 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
  1180. variable. 10 is the x-offset and 20 the y-offset for the grabbing.
  1181. @section Video and Audio file format conversion
  1182. Any supported file format and protocol can serve as input to ffmpeg:
  1183. Examples:
  1184. @itemize
  1185. @item
  1186. You can use YUV files as input:
  1187. @example
  1188. ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
  1189. @end example
  1190. It will use the files:
  1191. @example
  1192. /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
  1193. /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
  1194. @end example
  1195. The Y files use twice the resolution of the U and V files. They are
  1196. raw files, without header. They can be generated by all decent video
  1197. decoders. You must specify the size of the image with the @option{-s} option
  1198. if ffmpeg cannot guess it.
  1199. @item
  1200. You can input from a raw YUV420P file:
  1201. @example
  1202. ffmpeg -i /tmp/test.yuv /tmp/out.avi
  1203. @end example
  1204. test.yuv is a file containing raw YUV planar data. Each frame is composed
  1205. of the Y plane followed by the U and V planes at half vertical and
  1206. horizontal resolution.
  1207. @item
  1208. You can output to a raw YUV420P file:
  1209. @example
  1210. ffmpeg -i mydivx.avi hugefile.yuv
  1211. @end example
  1212. @item
  1213. You can set several input files and output files:
  1214. @example
  1215. ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
  1216. @end example
  1217. Converts the audio file a.wav and the raw YUV video file a.yuv
  1218. to MPEG file a.mpg.
  1219. @item
  1220. You can also do audio and video conversions at the same time:
  1221. @example
  1222. ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
  1223. @end example
  1224. Converts a.wav to MPEG audio at 22050 Hz sample rate.
  1225. @item
  1226. You can encode to several formats at the same time and define a
  1227. mapping from input stream to output streams:
  1228. @example
  1229. ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
  1230. @end example
  1231. Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
  1232. file:index' specifies which input stream is used for each output
  1233. stream, in the order of the definition of output streams.
  1234. @item
  1235. You can transcode decrypted VOBs:
  1236. @example
  1237. 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
  1238. @end example
  1239. This is a typical DVD ripping example; the input is a VOB file, the
  1240. output an AVI file with MPEG-4 video and MP3 audio. Note that in this
  1241. command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
  1242. GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
  1243. input video. Furthermore, the audio stream is MP3-encoded so you need
  1244. to enable LAME support by passing @code{--enable-libmp3lame} to configure.
  1245. The mapping is particularly useful for DVD transcoding
  1246. to get the desired audio language.
  1247. NOTE: To see the supported input formats, use @code{ffmpeg -demuxers}.
  1248. @item
  1249. You can extract images from a video, or create a video from many images:
  1250. For extracting images from a video:
  1251. @example
  1252. ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
  1253. @end example
  1254. This will extract one video frame per second from the video and will
  1255. output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
  1256. etc. Images will be rescaled to fit the new WxH values.
  1257. If you want to extract just a limited number of frames, you can use the
  1258. above command in combination with the @code{-frames:v} or @code{-t} option,
  1259. or in combination with -ss to start extracting from a certain point in time.
  1260. For creating a video from many images:
  1261. @example
  1262. ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
  1263. @end example
  1264. The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
  1265. composed of three digits padded with zeroes to express the sequence
  1266. number. It is the same syntax supported by the C printf function, but
  1267. only formats accepting a normal integer are suitable.
  1268. When importing an image sequence, -i also supports expanding
  1269. shell-like wildcard patterns (globbing) internally, by selecting the
  1270. image2-specific @code{-pattern_type glob} option.
  1271. For example, for creating a video from filenames matching the glob pattern
  1272. @code{foo-*.jpeg}:
  1273. @example
  1274. ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
  1275. @end example
  1276. @item
  1277. You can put many streams of the same type in the output:
  1278. @example
  1279. ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
  1280. @end example
  1281. The resulting output file @file{test12.nut} will contain the first four streams
  1282. from the input files in reverse order.
  1283. @item
  1284. To force CBR video output:
  1285. @example
  1286. ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
  1287. @end example
  1288. @item
  1289. The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
  1290. but you may use the QP2LAMBDA constant to easily convert from 'q' units:
  1291. @example
  1292. ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
  1293. @end example
  1294. @end itemize
  1295. @c man end EXAMPLES
  1296. @include config.texi
  1297. @ifset config-all
  1298. @ifset config-avutil
  1299. @include utils.texi
  1300. @end ifset
  1301. @ifset config-avcodec
  1302. @include codecs.texi
  1303. @include bitstream_filters.texi
  1304. @end ifset
  1305. @ifset config-avformat
  1306. @include formats.texi
  1307. @include protocols.texi
  1308. @end ifset
  1309. @ifset config-avdevice
  1310. @include devices.texi
  1311. @end ifset
  1312. @ifset config-swresample
  1313. @include resampler.texi
  1314. @end ifset
  1315. @ifset config-swscale
  1316. @include scaler.texi
  1317. @end ifset
  1318. @ifset config-avfilter
  1319. @include filters.texi
  1320. @end ifset
  1321. @end ifset
  1322. @chapter See Also
  1323. @ifhtml
  1324. @ifset config-all
  1325. @url{ffmpeg.html,ffmpeg}
  1326. @end ifset
  1327. @ifset config-not-all
  1328. @url{ffmpeg-all.html,ffmpeg-all},
  1329. @end ifset
  1330. @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
  1331. @url{ffmpeg-utils.html,ffmpeg-utils},
  1332. @url{ffmpeg-scaler.html,ffmpeg-scaler},
  1333. @url{ffmpeg-resampler.html,ffmpeg-resampler},
  1334. @url{ffmpeg-codecs.html,ffmpeg-codecs},
  1335. @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
  1336. @url{ffmpeg-formats.html,ffmpeg-formats},
  1337. @url{ffmpeg-devices.html,ffmpeg-devices},
  1338. @url{ffmpeg-protocols.html,ffmpeg-protocols},
  1339. @url{ffmpeg-filters.html,ffmpeg-filters}
  1340. @end ifhtml
  1341. @ifnothtml
  1342. @ifset config-all
  1343. ffmpeg(1),
  1344. @end ifset
  1345. @ifset config-not-all
  1346. ffmpeg-all(1),
  1347. @end ifset
  1348. ffplay(1), ffprobe(1), ffserver(1),
  1349. ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
  1350. ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
  1351. ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
  1352. @end ifnothtml
  1353. @include authors.texi
  1354. @ignore
  1355. @setfilename ffmpeg
  1356. @settitle ffmpeg video converter
  1357. @end ignore
  1358. @bye