You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1103 lines
39KB

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