ffmpeg.texi 57 KB

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