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