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