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.

1567 lines
59KB

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