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