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