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