ffmpeg.texi 58 KB

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