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