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