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