avconv: make -map_metadata work consistently with the other 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 [[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 Options
69 @c man begin OPTIONS
70
71 @include fftools-common-opts.texi
72
73 @section Main options
74
75 @table @option
76
77 @item -f @var{fmt}
78 Force format.
79
80 @item -i @var{filename}
81 input file name
82
83 @item -y
84 Overwrite output files.
85
86 @item -t @var{duration}
87 Restrict the transcoded/captured video sequence
88 to the duration specified in seconds.
89 @code{hh:mm:ss[.xxx]} syntax is also supported.
90
91 @item -fs @var{limit_size}
92 Set the file size limit.
93
94 @item -ss @var{position}
95 Seek to given time position in seconds.
96 @code{hh:mm:ss[.xxx]} syntax is also supported.
97
98 @item -itsoffset @var{offset}
99 Set the input time offset in seconds.
100 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
101 This option affects all the input files that follow it.
102 The offset is added to the timestamps of the input files.
103 Specifying a positive offset means that the corresponding
104 streams are delayed by 'offset' seconds.
105
106 @item -timestamp @var{time}
107 Set the recording timestamp in the container.
108 The syntax for @var{time} is:
109 @example
110 now|([(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH[:MM[:SS[.m...]]])|(HH[MM[SS[.m...]]]))[Z|z])
111 @end example
112 If the value is "now" it takes the current time.
113 Time is local time unless 'Z' or 'z' is appended, in which case it is
114 interpreted as UTC.
115 If the year-month-day part is not specified it takes the current
116 year-month-day.
117
118 @item -metadata @var{key}=@var{value}
119 Set a metadata key/value pair.
120
121 For example, for setting the title in the output file:
122 @example
123 avconv -i in.avi -metadata title="my title" out.flv
124 @end example
125
126 @item -v @var{number}
127 Set the logging verbosity level.
128
129 @item -target @var{type}
130 Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
131 "ntsc-svcd", ... ). All the format options (bitrate, codecs,
132 buffer sizes) are then set automatically. You can just type:
133
134 @example
135 avconv -i myfile.avi -target vcd /tmp/vcd.mpg
136 @end example
137
138 Nevertheless you can specify additional options as long as you know
139 they do not conflict with the standard, as in:
140
141 @example
142 avconv -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
143 @end example
144
145 @item -dframes @var{number}
146 Set the number of data frames to record.
147
148 @item -scodec @var{codec}
149 Force subtitle codec ('copy' to copy stream).
150
151 @item -newsubtitle
152 Add a new subtitle stream to the current output stream.
153
154 @item -slang @var{code}
155 Set the ISO 639 language code (3 letters) of the current subtitle stream.
156
157 @end table
158
159 @section Video Options
160
161 @table @option
162 @item -vframes @var{number}
163 Set the number of video frames to record.
164 @item -r @var{fps}
165 Set frame rate (Hz value, fraction or abbreviation), (default = 25).
166 @item -s @var{size}
167 Set frame size. The format is @samp{wxh} (avserver default = 160x128, avconv default = same as source).
168 The following abbreviations are recognized:
169 @table @samp
170 @item sqcif
171 128x96
172 @item qcif
173 176x144
174 @item cif
175 352x288
176 @item 4cif
177 704x576
178 @item 16cif
179 1408x1152
180 @item qqvga
181 160x120
182 @item qvga
183 320x240
184 @item vga
185 640x480
186 @item svga
187 800x600
188 @item xga
189 1024x768
190 @item uxga
191 1600x1200
192 @item qxga
193 2048x1536
194 @item sxga
195 1280x1024
196 @item qsxga
197 2560x2048
198 @item hsxga
199 5120x4096
200 @item wvga
201 852x480
202 @item wxga
203 1366x768
204 @item wsxga
205 1600x1024
206 @item wuxga
207 1920x1200
208 @item woxga
209 2560x1600
210 @item wqsxga
211 3200x2048
212 @item wquxga
213 3840x2400
214 @item whsxga
215 6400x4096
216 @item whuxga
217 7680x4800
218 @item cga
219 320x200
220 @item ega
221 640x350
222 @item hd480
223 852x480
224 @item hd720
225 1280x720
226 @item hd1080
227 1920x1080
228 @end table
229
230 @item -aspect @var{aspect}
231 Set the video display aspect ratio specified by @var{aspect}.
232
233 @var{aspect} can be a floating point number string, or a string of the
234 form @var{num}:@var{den}, where @var{num} and @var{den} are the
235 numerator and denominator of the aspect ratio. For example "4:3",
236 "16:9", "1.3333", and "1.7777" are valid argument values.
237
238 @item -croptop @var{size}
239 @item -cropbottom @var{size}
240 @item -cropleft @var{size}
241 @item -cropright @var{size}
242 All the crop options have been removed. Use -vf
243 crop=width:height:x:y instead.
244
245 @item -padtop @var{size}
246 @item -padbottom @var{size}
247 @item -padleft @var{size}
248 @item -padright @var{size}
249 @item -padcolor @var{hex_color}
250 All the pad options have been removed. Use -vf
251 pad=width:height:x:y:color instead.
252 @item -vn
253 Disable video recording.
254 @item -bt @var{tolerance}
255 Set video bitrate tolerance (in bits, default 4000k).
256 Has a minimum value of: (target_bitrate/target_framerate).
257 In 1-pass mode, bitrate tolerance specifies how far ratecontrol is
258 willing to deviate from the target average bitrate value. This is
259 not related to min/max bitrate. Lowering tolerance too much has
260 an adverse effect on quality.
261 @item -maxrate @var{bitrate}
262 Set max video bitrate (in bit/s).
263 Requires -bufsize to be set.
264 @item -minrate @var{bitrate}
265 Set min video bitrate (in bit/s).
266 Most useful in setting up a CBR encode:
267 @example
268 avconv -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
269 @end example
270 It is of little use elsewise.
271 @item -bufsize @var{size}
272 Set video buffer verifier buffer size (in bits).
273 @item -vcodec @var{codec}
274 Force video codec to @var{codec}. Use the @code{copy} special value to
275 tell that the raw codec data must be copied as is.
276 @item -sameq
277 Use same quantizer as source (implies VBR).
278
279 @item -pass @var{n}
280 Select the pass number (1 or 2). It is used to do two-pass
281 video encoding. The statistics of the video are recorded in the first
282 pass into a log file (see also the option -passlogfile),
283 and in the second pass that log file is used to generate the video
284 at the exact requested bitrate.
285 On pass 1, you may just deactivate audio and set output to null,
286 examples for Windows and Unix:
287 @example
288 avconv -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y NUL
289 avconv -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y /dev/null
290 @end example
291
292 @item -passlogfile @var{prefix}
293 Set two-pass log file name prefix to @var{prefix}, the default file name
294 prefix is ``av2pass''. The complete file name will be
295 @file{PREFIX-N.log}, where N is a number specific to the output
296 stream.
297
298 @item -newvideo
299 Add a new video stream to the current output stream.
300
301 @item -vlang @var{code}
302 Set the ISO 639 language code (3 letters) of the current video stream.
303
304 @item -vf @var{filter_graph}
305 @var{filter_graph} is a description of the filter graph to apply to
306 the input video.
307 Use the option "-filters" to show all the available filters (including
308 also sources and sinks).
309
310 @end table
311
312 @section Advanced Video Options
313
314 @table @option
315 @item -pix_fmt @var{format}
316 Set pixel format. Use 'list' as parameter to show all the supported
317 pixel formats.
318 @item -sws_flags @var{flags}
319 Set SwScaler flags.
320 @item -g @var{gop_size}
321 Set the group of pictures size.
322 @item -intra
323 Use only intra frames.
324 @item -vdt @var{n}
325 Discard threshold.
326 @item -qscale @var{q}
327 Use fixed video quantizer scale (VBR).
328 @item -qmin @var{q}
329 minimum video quantizer scale (VBR)
330 @item -qmax @var{q}
331 maximum video quantizer scale (VBR)
332 @item -qdiff @var{q}
333 maximum difference between the quantizer scales (VBR)
334 @item -qblur @var{blur}
335 video quantizer scale blur (VBR) (range 0.0 - 1.0)
336 @item -qcomp @var{compression}
337 video quantizer scale compression (VBR) (default 0.5).
338 Constant of ratecontrol equation. Recommended range for default rc_eq: 0.0-1.0
339
340 @item -lmin @var{lambda}
341 minimum video lagrange factor (VBR)
342 @item -lmax @var{lambda}
343 max video lagrange factor (VBR)
344 @item -mblmin @var{lambda}
345 minimum macroblock quantizer scale (VBR)
346 @item -mblmax @var{lambda}
347 maximum macroblock quantizer scale (VBR)
348
349 These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
350 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
351 @example
352 avconv -i src.ext -lmax 21*QP2LAMBDA dst.ext
353 @end example
354
355 @item -rc_init_cplx @var{complexity}
356 initial complexity for single pass encoding
357 @item -b_qfactor @var{factor}
358 qp factor between P- and B-frames
359 @item -i_qfactor @var{factor}
360 qp factor between P- and I-frames
361 @item -b_qoffset @var{offset}
362 qp offset between P- and B-frames
363 @item -i_qoffset @var{offset}
364 qp offset between P- and I-frames
365 @item -rc_eq @var{equation}
366 Set rate control equation (see section "Expression Evaluation")
367 (default = @code{tex^qComp}).
368
369 When computing the rate control equation expression, besides the
370 standard functions defined in the section "Expression Evaluation", the
371 following functions are available:
372 @table @var
373 @item bits2qp(bits)
374 @item qp2bits(qp)
375 @end table
376
377 and the following constants are available:
378 @table @var
379 @item iTex
380 @item pTex
381 @item tex
382 @item mv
383 @item fCode
384 @item iCount
385 @item mcVar
386 @item var
387 @item isI
388 @item isP
389 @item isB
390 @item avgQP
391 @item qComp
392 @item avgIITex
393 @item avgPITex
394 @item avgPPTex
395 @item avgBPTex
396 @item avgTex
397 @end table
398
399 @item -rc_override @var{override}
400 rate control override for specific intervals
401 @item -me_method @var{method}
402 Set motion estimation method to @var{method}.
403 Available methods are (from lowest to best quality):
404 @table @samp
405 @item zero
406 Try just the (0, 0) vector.
407 @item phods
408 @item log
409 @item x1
410 @item hex
411 @item umh
412 @item epzs
413 (default method)
414 @item full
415 exhaustive search (slow and marginally better than epzs)
416 @end table
417
418 @item -dct_algo @var{algo}
419 Set DCT algorithm to @var{algo}. Available values are:
420 @table @samp
421 @item 0
422 FF_DCT_AUTO (default)
423 @item 1
424 FF_DCT_FASTINT
425 @item 2
426 FF_DCT_INT
427 @item 3
428 FF_DCT_MMX
429 @item 4
430 FF_DCT_MLIB
431 @item 5
432 FF_DCT_ALTIVEC
433 @end table
434
435 @item -idct_algo @var{algo}
436 Set IDCT algorithm to @var{algo}. Available values are:
437 @table @samp
438 @item 0
439 FF_IDCT_AUTO (default)
440 @item 1
441 FF_IDCT_INT
442 @item 2
443 FF_IDCT_SIMPLE
444 @item 3
445 FF_IDCT_SIMPLEMMX
446 @item 4
447 FF_IDCT_LIBMPEG2MMX
448 @item 5
449 FF_IDCT_PS2
450 @item 6
451 FF_IDCT_MLIB
452 @item 7
453 FF_IDCT_ARM
454 @item 8
455 FF_IDCT_ALTIVEC
456 @item 9
457 FF_IDCT_SH4
458 @item 10
459 FF_IDCT_SIMPLEARM
460 @end table
461
462 @item -er @var{n}
463 Set error resilience to @var{n}.
464 @table @samp
465 @item 1
466 FF_ER_CAREFUL (default)
467 @item 2
468 FF_ER_COMPLIANT
469 @item 3
470 FF_ER_AGGRESSIVE
471 @item 4
472 FF_ER_VERY_AGGRESSIVE
473 @end table
474
475 @item -ec @var{bit_mask}
476 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
477 the following values:
478 @table @samp
479 @item 1
480 FF_EC_GUESS_MVS (default = enabled)
481 @item 2
482 FF_EC_DEBLOCK (default = enabled)
483 @end table
484
485 @item -bf @var{frames}
486 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
487 @item -mbd @var{mode}
488 macroblock decision
489 @table @samp
490 @item 0
491 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in avconv).
492 @item 1
493 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
494 @item 2
495 FF_MB_DECISION_RD: rate distortion
496 @end table
497
498 @item -4mv
499 Use four motion vector by macroblock (MPEG-4 only).
500 @item -part
501 Use data partitioning (MPEG-4 only).
502 @item -bug @var{param}
503 Work around encoder bugs that are not auto-detected.
504 @item -strict @var{strictness}
505 How strictly to follow the standards.
506 @item -aic
507 Enable Advanced intra coding (h263+).
508 @item -umv
509 Enable Unlimited Motion Vector (h263+)
510
511 @item -deinterlace
512 Deinterlace pictures.
513 @item -ilme
514 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
515 Use this option if your input file is interlaced and you want
516 to keep the interlaced format for minimum losses.
517 The alternative is to deinterlace the input stream with
518 @option{-deinterlace}, but deinterlacing introduces losses.
519 @item -psnr
520 Calculate PSNR of compressed frames.
521 @item -vstats
522 Dump video coding statistics to @file{vstats_HHMMSS.log}.
523 @item -vstats_file @var{file}
524 Dump video coding statistics to @var{file}.
525 @item -top @var{n}
526 top=1/bottom=0/auto=-1 field first
527 @item -dc @var{precision}
528 Intra_dc_precision.
529 @item -vtag @var{fourcc/tag}
530 Force video tag/fourcc.
531 @item -qphist
532 Show QP histogram.
533 @item -vbsf @var{bitstream_filter}
534 Bitstream filters available are "dump_extra", "remove_extra", "noise", "h264_mp4toannexb", "imxdump", "mjpegadump", "mjpeg2jpeg".
535 @example
536 avconv -i h264.mp4 -vcodec copy -vbsf h264_mp4toannexb -an out.h264
537 @end example
538 @item -force_key_frames @var{time}[,@var{time}...]
539 Force key frames at the specified timestamps, more precisely at the first
540 frames after each specified time.
541 This option can be useful to ensure that a seek point is present at a
542 chapter mark or any other designated place in the output file.
543 The timestamps must be specified in ascending order.
544 @end table
545
546 @section Audio Options
547
548 @table @option
549 @item -aframes @var{number}
550 Set the number of audio frames to record.
551 @item -ar @var{freq}
552 Set the audio sampling frequency. For output streams it is set by
553 default to the frequency of the corresponding input stream. For input
554 streams this option only makes sense for audio grabbing devices and raw
555 demuxers and is mapped to the corresponding demuxer options.
556 @item -aq @var{q}
557 Set the audio quality (codec-specific, VBR).
558 @item -ac @var{channels}
559 Set the number of audio channels. For output streams it is set by
560 default to the number of input audio channels. For input streams
561 this option only makes sense for audio grabbing devices and raw demuxers
562 and is mapped to the corresponding demuxer options.
563 @item -an
564 Disable audio recording.
565 @item -acodec @var{codec}
566 Force audio codec to @var{codec}. Use the @code{copy} special value to
567 specify that the raw codec data must be copied as is.
568 @item -newaudio
569 Add a new audio track to the output file. If you want to specify parameters,
570 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
571
572 Mapping will be done automatically, if the number of output streams is equal to
573 the number of input streams, else it will pick the first one that matches. You
574 can override the mapping using @code{-map} as usual.
575
576 Example:
577 @example
578 avconv -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
579 @end example
580 @item -alang @var{code}
581 Set the ISO 639 language code (3 letters) of the current audio stream.
582 @end table
583
584 @section Advanced Audio options:
585
586 @table @option
587 @item -atag @var{fourcc/tag}
588 Force audio tag/fourcc.
589 @item -audio_service_type @var{type}
590 Set the type of service that the audio stream contains.
591 @table @option
592 @item ma
593 Main Audio Service (default)
594 @item ef
595 Effects
596 @item vi
597 Visually Impaired
598 @item hi
599 Hearing Impaired
600 @item di
601 Dialogue
602 @item co
603 Commentary
604 @item em
605 Emergency
606 @item vo
607 Voice Over
608 @item ka
609 Karaoke
610 @end table
611 @item -absf @var{bitstream_filter}
612 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
613 @end table
614
615 @section Subtitle options:
616
617 @table @option
618 @item -scodec @var{codec}
619 Force subtitle codec ('copy' to copy stream).
620 @item -newsubtitle
621 Add a new subtitle stream to the current output stream.
622 @item -slang @var{code}
623 Set the ISO 639 language code (3 letters) of the current subtitle stream.
624 @item -sn
625 Disable subtitle recording.
626 @item -sbsf @var{bitstream_filter}
627 Bitstream filters available are "mov2textsub", "text2movsub".
628 @example
629 avconv -i file.mov -an -vn -sbsf mov2textsub -scodec copy -f rawvideo sub.txt
630 @end example
631 @end table
632
633 @section Audio/Video grab options
634
635 @table @option
636 @item -isync
637 Synchronize read on input.
638 @end table
639
640 @section Advanced options
641
642 @table @option
643 @item -map @var{input_file_id}.@var{input_stream_id}[:@var{sync_file_id}.@var{sync_stream_id}]
644
645 Designate an input stream as a source for the output file. Each input
646 stream is identified by the input file index @var{input_file_id} and
647 the input stream index @var{input_stream_id} within the input
648 file. Both indexes start at 0. If specified,
649 @var{sync_file_id}.@var{sync_stream_id} sets which input stream
650 is used as a presentation sync reference.
651
652 The @code{-map} options must be specified just after the output file.
653 If any @code{-map} options are used, the number of @code{-map} options
654 on the command line must match the number of streams in the output
655 file. The first @code{-map} option on the command line specifies the
656 source for output stream 0, the second @code{-map} option specifies
657 the source for output stream 1, etc.
658
659 For example, if you have two audio streams in the first input file,
660 these streams are identified by "0.0" and "0.1". You can use
661 @code{-map} to select which stream to place in an output file. For
662 example:
663 @example
664 avconv -i INPUT out.wav -map 0.1
665 @end example
666 will map the input stream in @file{INPUT} identified by "0.1" to
667 the (single) output stream in @file{out.wav}.
668
669 For example, to select the stream with index 2 from input file
670 @file{a.mov} (specified by the identifier "0.2"), and stream with
671 index 6 from input @file{b.mov} (specified by the identifier "1.6"),
672 and copy them to the output file @file{out.mov}:
673 @example
674 avconv -i a.mov -i b.mov -vcodec copy -acodec copy out.mov -map 0.2 -map 1.6
675 @end example
676
677 To add more streams to the output file, you can use the
678 @code{-newaudio}, @code{-newvideo}, @code{-newsubtitle} options.
679
680 @item -map_metadata[:@var{metadata_type}][:@var{index}] @var{infile}[:@var{metadata_type}][:@var{index}]
681 Set metadata information of the next output file from @var{infile}. Note that
682 those are file indices (zero-based), not filenames.
683 Optional @var{metadata_type} parameters specify, which metadata to copy - (g)lobal
684 (i.e. metadata that applies to the whole file), per-(s)tream, per-(c)hapter or
685 per-(p)rogram. All metadata specifiers other than global must be followed by the
686 stream/chapter/program index. If metadata specifier is omitted, it defaults to
687 global.
688
689 By default, global metadata is copied from the first input file,
690 per-stream and per-chapter metadata is copied along with streams/chapters. These
691 default mappings are disabled by creating any mapping of the relevant type. A negative
692 file index can be used to create a dummy mapping that just disables automatic copying.
693
694 For example to copy metadata from the first stream of the input file to global metadata
695 of the output file:
696 @example
697 avconv -i in.ogg -map_metadata 0:s:0 out.mp3
698 @end example
699 @item -map_chapters @var{input_file_index}
700 Copy chapters from input file with index @var{input_file_index} to the next
701 output file. If no chapter mapping is specified, then chapters are copied from
702 the first input file with at least one chapter. Use a negative file index to
703 disable any chapter copying.
704 @item -debug
705 Print specific debug info.
706 @item -benchmark
707 Show benchmarking information at the end of an encode.
708 Shows CPU time used and maximum memory consumption.
709 Maximum memory consumption is not supported on all systems,
710 it will usually display as 0 if not supported.
711 @item -dump
712 Dump each input packet.
713 @item -hex
714 When dumping packets, also dump the payload.
715 @item -bitexact
716 Only use bit exact algorithms (for codec testing).
717 @item -ps @var{size}
718 Set RTP payload size in bytes.
719 @item -re
720 Read input at native frame rate. Mainly used to simulate a grab device.
721 @item -threads @var{count}
722 Thread count.
723 @item -vsync @var{parameter}
724 Video sync method.
725
726 @table @option
727 @item 0
728 Each frame is passed with its timestamp from the demuxer to the muxer.
729 @item 1
730 Frames will be duplicated and dropped to achieve exactly the requested
731 constant framerate.
732 @item 2
733 Frames are passed through with their timestamp or dropped so as to
734 prevent 2 frames from having the same timestamp.
735 @item -1
736 Chooses between 1 and 2 depending on muxer capabilities. This is the
737 default method.
738 @end table
739
740 With -map you can select from which stream the timestamps should be
741 taken. You can leave either video or audio unchanged and sync the
742 remaining stream(s) to the unchanged one.
743
744 @item -async @var{samples_per_second}
745 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
746 the parameter is the maximum samples per second by which the audio is changed.
747 -async 1 is a special case where only the start of the audio stream is corrected
748 without any later correction.
749 @item -copyts
750 Copy timestamps from input to output.
751 @item -copytb
752 Copy input stream time base from input to output when stream copying.
753 @item -shortest
754 Finish encoding when the shortest input stream ends.
755 @item -dts_delta_threshold
756 Timestamp discontinuity delta threshold.
757 @item -muxdelay @var{seconds}
758 Set the maximum demux-decode delay.
759 @item -muxpreload @var{seconds}
760 Set the initial demux-decode delay.
761 @item -streamid @var{output-stream-index}:@var{new-value}
762 Assign a new stream-id value to an output stream. This option should be
763 specified prior to the output filename to which it applies.
764 For the situation where multiple output files exist, a streamid
765 may be reassigned to a different value.
766
767 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
768 an output mpegts file:
769 @example
770 avconv -i infile -streamid 0:33 -streamid 1:36 out.ts
771 @end example
772 @end table
773
774 @section Preset files
775
776 A preset file contains a sequence of @var{option}=@var{value} pairs,
777 one for each line, specifying a sequence of options which would be
778 awkward to specify on the command line. Lines starting with the hash
779 ('#') character are ignored and are used to provide comments. Check
780 the @file{ffpresets} directory in the Libav source tree for examples.
781
782 Preset files are specified with the @code{vpre}, @code{apre},
783 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
784 filename of the preset instead of a preset name as input and can be
785 used for any kind of codec. For the @code{vpre}, @code{apre}, and
786 @code{spre} options, the options specified in a preset file are
787 applied to the currently selected codec of the same type as the preset
788 option.
789
790 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
791 preset options identifies the preset file to use according to the
792 following rules:
793
794 First avconv searches for a file named @var{arg}.ffpreset in the
795 directories @file{$av_DATADIR} (if set), and @file{$HOME/.avconv}, and in
796 the datadir defined at configuration time (usually @file{PREFIX/share/avconv})
797 in that order. For example, if the argument is @code{libx264-max}, it will
798 search for the file @file{libx264-max.ffpreset}.
799
800 If no such file is found, then avconv will search for a file named
801 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
802 directories, where @var{codec_name} is the name of the codec to which
803 the preset file options will be applied. For example, if you select
804 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
805 then it will search for the file @file{libx264-max.ffpreset}.
806 @c man end
807
808 @chapter Tips
809 @c man begin TIPS
810
811 @itemize
812 @item
813 For streaming at very low bitrate application, use a low frame rate
814 and a small GOP size. This is especially true for RealVideo where
815 the Linux player does not seem to be very fast, so it can miss
816 frames. An example is:
817
818 @example
819 avconv -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
820 @end example
821
822 @item
823 The parameter 'q' which is displayed while encoding is the current
824 quantizer. The value 1 indicates that a very good quality could
825 be achieved. The value 31 indicates the worst quality. If q=31 appears
826 too often, it means that the encoder cannot compress enough to meet
827 your bitrate. You must either increase the bitrate, decrease the
828 frame rate or decrease the frame size.
829
830 @item
831 If your computer is not fast enough, you can speed up the
832 compression at the expense of the compression ratio. You can use
833 '-me zero' to speed up motion estimation, and '-intra' to disable
834 motion estimation completely (you have only I-frames, which means it
835 is about as good as JPEG compression).
836
837 @item
838 To have very low audio bitrates, reduce the sampling frequency
839 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
840
841 @item
842 To have a constant quality (but a variable bitrate), use the option
843 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
844 quality).
845
846 @item
847 When converting video files, you can use the '-sameq' option which
848 uses the same quality factor in the encoder as in the decoder.
849 It allows almost lossless encoding.
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 -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
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 -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 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 -vcodec copy -acodec copy -vcodec copy -acodec copy test12.avi -newvideo -newaudio
1012 @end example
1013
1014 In addition to the first video and audio streams, the resulting
1015 output file @file{test12.avi} will contain the second video
1016 and the second audio stream found in the input streams list.
1017
1018 The @code{-newvideo}, @code{-newaudio} and @code{-newsubtitle}
1019 options have to be specified immediately after the name of the output
1020 file to which you want to add them.
1021
1022 @end itemize
1023 @c man end EXAMPLES
1024
1025 @include eval.texi
1026 @include encoders.texi
1027 @include demuxers.texi
1028 @include muxers.texi
1029 @include indevs.texi
1030 @include outdevs.texi
1031 @include protocols.texi
1032 @include bitstream_filters.texi
1033 @include filters.texi
1034 @include metadata.texi
1035
1036 @ignore
1037
1038 @setfilename avconv
1039 @settitle avconv video converter
1040
1041 @c man begin SEEALSO
1042 avplay(1), avprobe(1), avserver(1) and the Libav HTML documentation
1043 @c man end
1044
1045 @c man begin AUTHORS
1046 The Libav developers
1047 @c man end
1048
1049 @end ignore
1050
1051 @bye