jpegls: K&R formatting cosmetics
[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
334 @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
335 This option is similar to @option{-filter}, the only difference is that its
336 argument is the name of the file from which a filtergraph description is to be
337 read.
338
339 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
340 Specify the preset for matching stream(s).
341
342 @item -stats (@emph{global})
343 Print encoding progress/statistics. On by default.
344
345 @item -attach @var{filename} (@emph{output})
346 Add an attachment to the output file. This is supported by a few formats
347 like Matroska for e.g. fonts used in rendering subtitles. Attachments
348 are implemented as a specific type of stream, so this option will add
349 a new stream to the file. It is then possible to use per-stream options
350 on this stream in the usual way. Attachment streams created with this
351 option will be created after all the other streams (i.e. those created
352 with @code{-map} or automatic mappings).
353
354 Note that for Matroska you also have to set the mimetype metadata tag:
355 @example
356 avconv -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
357 @end example
358 (assuming that the attachment stream will be third in the output file).
359
360 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
361 Extract the matching attachment stream into a file named @var{filename}. If
362 @var{filename} is empty, then the value of the @code{filename} metadata tag
363 will be used.
364
365 E.g. to extract the first attachment to a file named 'out.ttf':
366 @example
367 avconv -dump_attachment:t:0 out.ttf INPUT
368 @end example
369 To extract all attachments to files determined by the @code{filename} tag:
370 @example
371 avconv -dump_attachment:t "" INPUT
372 @end example
373
374 Technical note -- attachments are implemented as codec extradata, so this
375 option can actually be used to extract extradata from any stream, not just
376 attachments.
377
378 @end table
379
380 @section Video Options
381
382 @table @option
383 @item -vframes @var{number} (@emph{output})
384 Set the number of video frames to record. This is an alias for @code{-frames:v}.
385 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
386 Set frame rate (Hz value, fraction or abbreviation).
387
388 As an input option, ignore any timestamps stored in the file and instead
389 generate timestamps assuming constant frame rate @var{fps}.
390
391 As an output option, duplicate or drop input frames to achieve constant output
392 frame rate @var{fps} (note that this actually causes the @code{fps} filter to be
393 inserted to the end of the corresponding filtergraph).
394
395 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
396 Set frame size.
397
398 As an input option, this is a shortcut for the @option{video_size} private
399 option, recognized by some demuxers for which the frame size is either not
400 stored in the file or is configurable -- e.g. raw video or video grabbers.
401
402 As an output option, this inserts the @code{scale} video filter to the
403 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
404 directly to insert it at the beginning or some other place.
405
406 The format is @samp{wxh} (default - same as source).  The following
407 abbreviations are recognized:
408 @table @samp
409 @item sqcif
410 128x96
411 @item qcif
412 176x144
413 @item cif
414 352x288
415 @item 4cif
416 704x576
417 @item 16cif
418 1408x1152
419 @item qqvga
420 160x120
421 @item qvga
422 320x240
423 @item vga
424 640x480
425 @item svga
426 800x600
427 @item xga
428 1024x768
429 @item uxga
430 1600x1200
431 @item qxga
432 2048x1536
433 @item sxga
434 1280x1024
435 @item qsxga
436 2560x2048
437 @item hsxga
438 5120x4096
439 @item wvga
440 852x480
441 @item wxga
442 1366x768
443 @item wsxga
444 1600x1024
445 @item wuxga
446 1920x1200
447 @item woxga
448 2560x1600
449 @item wqsxga
450 3200x2048
451 @item wquxga
452 3840x2400
453 @item whsxga
454 6400x4096
455 @item whuxga
456 7680x4800
457 @item cga
458 320x200
459 @item ega
460 640x350
461 @item hd480
462 852x480
463 @item hd720
464 1280x720
465 @item hd1080
466 1920x1080
467 @end table
468
469 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
470 Set the video display aspect ratio specified by @var{aspect}.
471
472 @var{aspect} can be a floating point number string, or a string of the
473 form @var{num}:@var{den}, where @var{num} and @var{den} are the
474 numerator and denominator of the aspect ratio. For example "4:3",
475 "16:9", "1.3333", and "1.7777" are valid argument values.
476
477 @item -vn (@emph{output})
478 Disable video recording.
479
480 @item -vcodec @var{codec} (@emph{output})
481 Set the video codec. This is an alias for @code{-codec:v}.
482
483 @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
484 Select the pass number (1 or 2). It is used to do two-pass
485 video encoding. The statistics of the video are recorded in the first
486 pass into a log file (see also the option -passlogfile),
487 and in the second pass that log file is used to generate the video
488 at the exact requested bitrate.
489 On pass 1, you may just deactivate audio and set output to null,
490 examples for Windows and Unix:
491 @example
492 avconv -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
493 avconv -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
494 @end example
495
496 @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
497 Set two-pass log file name prefix to @var{prefix}, the default file name
498 prefix is ``av2pass''. The complete file name will be
499 @file{PREFIX-N.log}, where N is a number specific to the output
500 stream.
501
502 @item -vf @var{filter_graph} (@emph{output})
503 @var{filter_graph} is a description of the filter graph to apply to
504 the input video.
505 Use the option "-filters" to show all the available filters (including
506 also sources and sinks).  This is an alias for @code{-filter:v}.
507
508 @end table
509
510 @section Advanced Video Options
511
512 @table @option
513 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
514 Set pixel format. Use @code{-pix_fmts} to show all the supported
515 pixel formats.
516 @item -sws_flags @var{flags} (@emph{input/output})
517 Set SwScaler flags.
518 @item -vdt @var{n}
519 Discard threshold.
520
521 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
522 rate control override for specific intervals
523
524 @item -vstats
525 Dump video coding statistics to @file{vstats_HHMMSS.log}.
526 @item -vstats_file @var{file}
527 Dump video coding statistics to @var{file}.
528 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
529 top=1/bottom=0/auto=-1 field first
530 @item -dc @var{precision}
531 Intra_dc_precision.
532 @item -vtag @var{fourcc/tag} (@emph{output})
533 Force video tag/fourcc. This is an alias for @code{-tag:v}.
534 @item -qphist (@emph{global})
535 Show QP histogram.
536 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
537 Force key frames at the specified timestamps, more precisely at the first
538 frames after each specified time.
539 This option can be useful to ensure that a seek point is present at a
540 chapter mark or any other designated place in the output file.
541 The timestamps must be specified in ascending order.
542
543 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
544 When doing stream copy, copy also non-key frames found at the
545 beginning.
546 @end table
547
548 @section Audio Options
549
550 @table @option
551 @item -aframes @var{number} (@emph{output})
552 Set the number of audio frames to record. This is an alias for @code{-frames:a}.
553 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
554 Set the audio sampling frequency. For output streams it is set by
555 default to the frequency of the corresponding input stream. For input
556 streams this option only makes sense for audio grabbing devices and raw
557 demuxers and is mapped to the corresponding demuxer options.
558 @item -aq @var{q} (@emph{output})
559 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
560 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
561 Set the number of audio channels. For output streams it is set by
562 default to the number of input audio channels. For input streams
563 this option only makes sense for audio grabbing devices and raw demuxers
564 and is mapped to the corresponding demuxer options.
565 @item -an (@emph{output})
566 Disable audio recording.
567 @item -acodec @var{codec} (@emph{input/output})
568 Set the audio codec. This is an alias for @code{-codec:a}.
569 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
570 Set the audio sample format. Use @code{-sample_fmts} to get a list
571 of supported sample formats.
572 @item -af @var{filter_graph} (@emph{output})
573 @var{filter_graph} is a description of the filter graph to apply to
574 the input audio.
575 Use the option "-filters" to show all the available filters (including
576 also sources and sinks).  This is an alias for @code{-filter:a}.
577 @end table
578
579 @section Advanced Audio options:
580
581 @table @option
582 @item -atag @var{fourcc/tag} (@emph{output})
583 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
584 @end table
585
586 @section Subtitle options:
587
588 @table @option
589 @item -scodec @var{codec} (@emph{input/output})
590 Set the subtitle codec. This is an alias for @code{-codec:s}.
591 @item -sn (@emph{output})
592 Disable subtitle recording.
593 @end table
594
595 @section Advanced options
596
597 @table @option
598 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
599
600 Designate one or more input streams as a source for the output file. Each input
601 stream is identified by the input file index @var{input_file_id} and
602 the input stream index @var{input_stream_id} within the input
603 file. Both indices start at 0. If specified,
604 @var{sync_file_id}:@var{stream_specifier} sets which input stream
605 is used as a presentation sync reference.
606
607 The first @code{-map} option on the command line specifies the
608 source for output stream 0, the second @code{-map} option specifies
609 the source for output stream 1, etc.
610
611 A @code{-} character before the stream identifier creates a "negative" mapping.
612 It disables matching streams from already created mappings.
613
614 An alternative @var{[linklabel]} form will map outputs from complex filter
615 graphs (see the @option{-filter_complex} option) to the output file.
616 @var{linklabel} must correspond to a defined output link label in the graph.
617
618 For example, to map ALL streams from the first input file to output
619 @example
620 avconv -i INPUT -map 0 output
621 @end example
622
623 For example, if you have two audio streams in the first input file,
624 these streams are identified by "0:0" and "0:1". You can use
625 @code{-map} to select which streams to place in an output file. For
626 example:
627 @example
628 avconv -i INPUT -map 0:1 out.wav
629 @end example
630 will map the input stream in @file{INPUT} identified by "0:1" to
631 the (single) output stream in @file{out.wav}.
632
633 For example, to select the stream with index 2 from input file
634 @file{a.mov} (specified by the identifier "0:2"), and stream with
635 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
636 and copy them to the output file @file{out.mov}:
637 @example
638 avconv -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
639 @end example
640
641 To select all video and the third audio stream from an input file:
642 @example
643 avconv -i INPUT -map 0:v -map 0:a:2 OUTPUT
644 @end example
645
646 To map all the streams except the second audio, use negative mappings
647 @example
648 avconv -i INPUT -map 0 -map -0:a:1 OUTPUT
649 @end example
650
651 Note that using this option disables the default mappings for this output file.
652
653 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
654 Set metadata information of the next output file from @var{infile}. Note that
655 those are file indices (zero-based), not filenames.
656 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
657 A metadata specifier can have the following forms:
658 @table @option
659 @item @var{g}
660 global metadata, i.e. metadata that applies to the whole file
661
662 @item @var{s}[:@var{stream_spec}]
663 per-stream metadata. @var{stream_spec} is a stream specifier as described
664 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
665 matching stream is copied from. In an output metadata specifier, all matching
666 streams are copied to.
667
668 @item @var{c}:@var{chapter_index}
669 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
670
671 @item @var{p}:@var{program_index}
672 per-program metadata. @var{program_index} is the zero-based program index.
673 @end table
674 If metadata specifier is omitted, it defaults to global.
675
676 By default, global metadata is copied from the first input file,
677 per-stream and per-chapter metadata is copied along with streams/chapters. These
678 default mappings are disabled by creating any mapping of the relevant type. A negative
679 file index can be used to create a dummy mapping that just disables automatic copying.
680
681 For example to copy metadata from the first stream of the input file to global metadata
682 of the output file:
683 @example
684 avconv -i in.ogg -map_metadata 0:s:0 out.mp3
685 @end example
686
687 To do the reverse, i.e. copy global metadata to all audio streams:
688 @example
689 avconv -i in.mkv -map_metadata:s:a 0:g out.mkv
690 @end example
691 Note that simple @code{0} would work as well in this example, since global
692 metadata is assumed by default.
693
694 @item -map_chapters @var{input_file_index} (@emph{output})
695 Copy chapters from input file with index @var{input_file_index} to the next
696 output file. If no chapter mapping is specified, then chapters are copied from
697 the first input file with at least one chapter. Use a negative file index to
698 disable any chapter copying.
699 @item -debug
700 Print specific debug info.
701 @item -benchmark (@emph{global})
702 Show benchmarking information at the end of an encode.
703 Shows CPU time used and maximum memory consumption.
704 Maximum memory consumption is not supported on all systems,
705 it will usually display as 0 if not supported.
706 @item -timelimit @var{duration} (@emph{global})
707 Exit after avconv has been running for @var{duration} seconds.
708 @item -dump (@emph{global})
709 Dump each input packet to stderr.
710 @item -hex (@emph{global})
711 When dumping packets, also dump the payload.
712 @item -re (@emph{input})
713 Read input at native frame rate. Mainly used to simulate a grab device.
714 @item -vsync @var{parameter}
715 Video sync method.
716
717 @table @option
718 @item passthrough
719 Each frame is passed with its timestamp from the demuxer to the muxer.
720 @item cfr
721 Frames will be duplicated and dropped to achieve exactly the requested
722 constant framerate.
723 @item vfr
724 Frames are passed through with their timestamp or dropped so as to
725 prevent 2 frames from having the same timestamp.
726 @item auto
727 Chooses between 1 and 2 depending on muxer capabilities. This is the
728 default method.
729 @end table
730
731 With -map you can select from which stream the timestamps should be
732 taken. You can leave either video or audio unchanged and sync the
733 remaining stream(s) to the unchanged one.
734
735 @item -async @var{samples_per_second}
736 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
737 the parameter is the maximum samples per second by which the audio is changed.
738 -async 1 is a special case where only the start of the audio stream is corrected
739 without any later correction.
740 This option has been deprecated. Use the @code{asyncts} audio filter instead.
741 @item -copyts
742 Copy timestamps from input to output.
743 @item -copytb
744 Copy input stream time base from input to output when stream copying.
745 @item -shortest (@emph{output})
746 Finish encoding when the shortest input stream ends.
747 @item -dts_delta_threshold
748 Timestamp discontinuity delta threshold.
749 @item -muxdelay @var{seconds} (@emph{input})
750 Set the maximum demux-decode delay.
751 @item -muxpreload @var{seconds} (@emph{input})
752 Set the initial demux-decode delay.
753 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
754 Assign a new stream-id value to an output stream. This option should be
755 specified prior to the output filename to which it applies.
756 For the situation where multiple output files exist, a streamid
757 may be reassigned to a different value.
758
759 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
760 an output mpegts file:
761 @example
762 avconv -i infile -streamid 0:33 -streamid 1:36 out.ts
763 @end example
764
765 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
766 Set bitstream filters for matching streams. @var{bistream_filters} is
767 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
768 to get the list of bitstream filters.
769 @example
770 avconv -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
771 @end example
772 @example
773 avconv -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
774 @end example
775
776 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{output,per-stream})
777 Force a tag/fourcc for matching streams.
778
779 @item -cpuflags mask (@emph{global})
780 Set a mask that's applied to autodetected CPU flags.  This option is intended
781 for testing. Do not use it unless you know what you're doing.
782
783 @item -filter_complex @var{filtergraph} (@emph{global})
784 Define a complex filter graph, i.e. one with arbitrary number of inputs and/or
785 outputs. For simple graphs -- those with one input and one output of the same
786 type -- see the @option{-filter} options. @var{filtergraph} is a description of
787 the filter graph, as described in @ref{Filtergraph syntax}.
788
789 Input link labels must refer to input streams using the
790 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
791 uses). If @var{stream_specifier} matches multiple streams, the first one will be
792 used. An unlabeled input will be connected to the first unused input stream of
793 the matching type.
794
795 Output link labels are referred to with @option{-map}. Unlabeled outputs are
796 added to the first output file.
797
798 Note that with this option it is possible to use only lavfi sources without
799 normal input files.
800
801 For example, to overlay an image over video
802 @example
803 avconv -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
804 '[out]' out.mkv
805 @end example
806 Here @code{[0:v]} refers to the first video stream in the first input file,
807 which is linked to the first (main) input of the overlay filter. Similarly the
808 first video stream in the second input is linked to the second (overlay) input
809 of overlay.
810
811 Assuming there is only one video stream in each input file, we can omit input
812 labels, so the above is equivalent to
813 @example
814 avconv -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
815 '[out]' out.mkv
816 @end example
817
818 Furthermore we can omit the output label and the single output from the filter
819 graph will be added to the output file automatically, so we can simply write
820 @example
821 avconv -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
822 @end example
823
824 To generate 5 seconds of pure red video using lavfi @code{color} source:
825 @example
826 avconv -filter_complex 'color=red' -t 5 out.mkv
827 @end example
828
829 @item -filter_complex_script @var{filename} (@emph{global})
830 This option is similar to @option{-filter_complex}, the only difference is that
831 its argument is the name of the file from which a complex filtergraph
832 description is to be read.
833
834 @end table
835 @c man end OPTIONS
836
837 @chapter Tips
838 @c man begin TIPS
839
840 @itemize
841 @item
842 For streaming at very low bitrate application, use a low frame rate
843 and a small GOP size. This is especially true for RealVideo where
844 the Linux player does not seem to be very fast, so it can miss
845 frames. An example is:
846
847 @example
848 avconv -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
849 @end example
850
851 @item
852 The parameter 'q' which is displayed while encoding is the current
853 quantizer. The value 1 indicates that a very good quality could
854 be achieved. The value 31 indicates the worst quality. If q=31 appears
855 too often, it means that the encoder cannot compress enough to meet
856 your bitrate. You must either increase the bitrate, decrease the
857 frame rate or decrease the frame size.
858
859 @item
860 If your computer is not fast enough, you can speed up the
861 compression at the expense of the compression ratio. You can use
862 '-me zero' to speed up motion estimation, and '-g 0' to disable
863 motion estimation completely (you have only I-frames, which means it
864 is about as good as JPEG compression).
865
866 @item
867 To have very low audio bitrates, reduce the sampling frequency
868 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
869
870 @item
871 To have a constant quality (but a variable bitrate), use the option
872 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
873 quality).
874
875 @end itemize
876 @c man end TIPS
877
878 @chapter Examples
879 @c man begin EXAMPLES
880
881 @section Preset files
882
883 A preset file contains a sequence of @var{option=value} pairs, one for
884 each line, specifying a sequence of options which can be specified also on
885 the command line. Lines starting with the hash ('#') character are ignored and
886 are used to provide comments. Empty lines are also ignored. Check the
887 @file{presets} directory in the Libav source tree for examples.
888
889 Preset files are specified with the @code{pre} option, this option takes a
890 preset name as input.  Avconv searches for a file named @var{preset_name}.avpreset in
891 the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.avconv}, and in
892 the data directory defined at configuration time (usually @file{$PREFIX/share/avconv})
893 in that order.  For example, if the argument is @code{libx264-max}, it will
894 search for the file @file{libx264-max.avpreset}.
895
896 @section Video and Audio grabbing
897
898 If you specify the input format and device then avconv can grab video
899 and audio directly.
900
901 @example
902 avconv -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
903 @end example
904
905 Note that you must activate the right video source and channel before
906 launching avconv with any TV viewer such as
907 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
908 have to set the audio recording levels correctly with a
909 standard mixer.
910
911 @section X11 grabbing
912
913 Grab the X11 display with avconv via
914
915 @example
916 avconv -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
917 @end example
918
919 0.0 is display.screen number of your X11 server, same as
920 the DISPLAY environment variable.
921
922 @example
923 avconv -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
924 @end example
925
926 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
927 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
928
929 @section Video and Audio file format conversion
930
931 Any supported file format and protocol can serve as input to avconv:
932
933 Examples:
934 @itemize
935 @item
936 You can use YUV files as input:
937
938 @example
939 avconv -i /tmp/test%d.Y /tmp/out.mpg
940 @end example
941
942 It will use the files:
943 @example
944 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
945 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
946 @end example
947
948 The Y files use twice the resolution of the U and V files. They are
949 raw files, without header. They can be generated by all decent video
950 decoders. You must specify the size of the image with the @option{-s} option
951 if avconv cannot guess it.
952
953 @item
954 You can input from a raw YUV420P file:
955
956 @example
957 avconv -i /tmp/test.yuv /tmp/out.avi
958 @end example
959
960 test.yuv is a file containing raw YUV planar data. Each frame is composed
961 of the Y plane followed by the U and V planes at half vertical and
962 horizontal resolution.
963
964 @item
965 You can output to a raw YUV420P file:
966
967 @example
968 avconv -i mydivx.avi hugefile.yuv
969 @end example
970
971 @item
972 You can set several input files and output files:
973
974 @example
975 avconv -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
976 @end example
977
978 Converts the audio file a.wav and the raw YUV video file a.yuv
979 to MPEG file a.mpg.
980
981 @item
982 You can also do audio and video conversions at the same time:
983
984 @example
985 avconv -i /tmp/a.wav -ar 22050 /tmp/a.mp2
986 @end example
987
988 Converts a.wav to MPEG audio at 22050 Hz sample rate.
989
990 @item
991 You can encode to several formats at the same time and define a
992 mapping from input stream to output streams:
993
994 @example
995 avconv -i /tmp/a.wav -map 0:a -b 64k /tmp/a.mp2 -map 0:a -b 128k /tmp/b.mp2
996 @end example
997
998 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
999 file:index' specifies which input stream is used for each output
1000 stream, in the order of the definition of output streams.
1001
1002 @item
1003 You can transcode decrypted VOBs:
1004
1005 @example
1006 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
1007 @end example
1008
1009 This is a typical DVD ripping example; the input is a VOB file, the
1010 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1011 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1012 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1013 input video. Furthermore, the audio stream is MP3-encoded so you need
1014 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1015 The mapping is particularly useful for DVD transcoding
1016 to get the desired audio language.
1017
1018 NOTE: To see the supported input formats, use @code{avconv -formats}.
1019
1020 @item
1021 You can extract images from a video, or create a video from many images:
1022
1023 For extracting images from a video:
1024 @example
1025 avconv -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1026 @end example
1027
1028 This will extract one video frame per second from the video and will
1029 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1030 etc. Images will be rescaled to fit the new WxH values.
1031
1032 If you want to extract just a limited number of frames, you can use the
1033 above command in combination with the -vframes or -t option, or in
1034 combination with -ss to start extracting from a certain point in time.
1035
1036 For creating a video from many images:
1037 @example
1038 avconv -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1039 @end example
1040
1041 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1042 composed of three digits padded with zeroes to express the sequence
1043 number. It is the same syntax supported by the C printf function, but
1044 only formats accepting a normal integer are suitable.
1045
1046 @item
1047 You can put many streams of the same type in the output:
1048
1049 @example
1050 avconv -i test1.avi -i test2.avi -map 0.3 -map 0.2 -map 0.1 -map 0.0 -c copy test12.nut
1051 @end example
1052
1053 The resulting output file @file{test12.avi} will contain first four streams from
1054 the input file in reverse order.
1055
1056 @item
1057 To force CBR video output:
1058 @example
1059 avconv -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1060 @end example
1061
1062 @item
1063 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1064 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1065 @example
1066 avconv -i src.ext -lmax 21*QP2LAMBDA dst.ext
1067 @end example
1068
1069 @end itemize
1070 @c man end EXAMPLES
1071
1072 @include eval.texi
1073 @include encoders.texi
1074 @include demuxers.texi
1075 @include muxers.texi
1076 @include indevs.texi
1077 @include outdevs.texi
1078 @include protocols.texi
1079 @include bitstream_filters.texi
1080 @include filters.texi
1081 @include metadata.texi
1082
1083 @ignore
1084
1085 @setfilename avconv
1086 @settitle avconv video converter
1087
1088 @c man begin SEEALSO
1089 avplay(1), avprobe(1) and the Libav HTML documentation
1090 @c man end
1091
1092 @c man begin AUTHORS
1093 The Libav developers
1094 @c man end
1095
1096 @end ignore
1097
1098 @bye