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