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