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