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.

1117 lines
40KB

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