qsvenc: Provide a detailed error message if the parameters are invalid
[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 Detailed description
83 @c man begin DETAILED DESCRIPTION
84
85 The transcoding process in @command{avconv} for each output can be described by
86 the following diagram:
87
88 @example
89  _______              ______________
90 |       |            |              |
91 | input |  demuxer   | encoded data |   decoder
92 | file  | ---------> | packets      | -----+
93 |_______|            |______________|      |
94                                            v
95                                        _________
96                                       |         |
97                                       | decoded |
98                                       | frames  |
99                                       |_________|
100  ________             ______________       |
101 |        |           |              |      |
102 | output | <-------- | encoded data | <----+
103 | file   |   muxer   | packets      |   encoder
104 |________|           |______________|
105
106
107 @end example
108
109 @command{avconv} calls the libavformat library (containing demuxers) to read
110 input files and get packets containing encoded data from them. When there are
111 multiple input files, @command{avconv} tries to keep them synchronized by
112 tracking lowest timestamp on any active input stream.
113
114 Encoded packets are then passed to the decoder (unless streamcopy is selected
115 for the stream, see further for a description). The decoder produces
116 uncompressed frames (raw video/PCM audio/...) which can be processed further by
117 filtering (see next section). After filtering the frames are passed to the
118 encoder, which encodes them and outputs encoded packets again. Finally those are
119 passed to the muxer, which writes the encoded packets to the output file.
120
121 @section Filtering
122 Before encoding, @command{avconv} can process raw audio and video frames using
123 filters from the libavfilter library. Several chained filters form a filter
124 graph.  @command{avconv} distinguishes between two types of filtergraphs -
125 simple and complex.
126
127 @subsection Simple filtergraphs
128 Simple filtergraphs are those that have exactly one input and output, both of
129 the same type. In the above diagram they can be represented by simply inserting
130 an additional step between decoding and encoding:
131
132 @example
133  _________                        ______________
134 |         |                      |              |
135 | decoded |                      | encoded data |
136 | frames  |\                    /| packets      |
137 |_________| \                  / |______________|
138              \   __________   /
139   simple      \ |          | /  encoder
140   filtergraph  \| filtered |/
141                 | frames   |
142                 |__________|
143
144 @end example
145
146 Simple filtergraphs are configured with the per-stream @option{-filter} option
147 (with @option{-vf} and @option{-af} aliases for video and audio respectively).
148 A simple filtergraph for video can look for example like this:
149
150 @example
151  _______        _____________        _______        ________
152 |       |      |             |      |       |      |        |
153 | input | ---> | deinterlace | ---> | scale | ---> | output |
154 |_______|      |_____________|      |_______|      |________|
155
156 @end example
157
158 Note that some filters change frame properties but not frame contents. E.g. the
159 @code{fps} filter in the example above changes number of frames, but does not
160 touch the frame contents. Another example is the @code{setpts} filter, which
161 only sets timestamps and otherwise passes the frames unchanged.
162
163 @subsection Complex filtergraphs
164 Complex filtergraphs are those which cannot be described as simply a linear
165 processing chain applied to one stream. This is the case e.g. when the graph has
166 more than one input and/or output, or when output stream type is different from
167 input. They can be represented with the following diagram:
168
169 @example
170  _________
171 |         |
172 | input 0 |\                    __________
173 |_________| \                  |          |
174              \   _________    /| output 0 |
175               \ |         |  / |__________|
176  _________     \| complex | /
177 |         |     |         |/
178 | input 1 |---->| filter  |\
179 |_________|     |         | \   __________
180                /| graph   |  \ |          |
181               / |         |   \| output 1 |
182  _________   /  |_________|    |__________|
183 |         | /
184 | input 2 |/
185 |_________|
186
187 @end example
188
189 Complex filtergraphs are configured with the @option{-filter_complex} option.
190 Note that this option is global, since a complex filtergraph by its nature
191 cannot be unambiguously associated with a single stream or file.
192
193 A trivial example of a complex filtergraph is the @code{overlay} filter, which
194 has two video inputs and one video output, containing one video overlaid on top
195 of the other. Its audio counterpart is the @code{amix} filter.
196
197 @section Stream copy
198 Stream copy is a mode selected by supplying the @code{copy} parameter to the
199 @option{-codec} option. It makes @command{avconv} omit the decoding and encoding
200 step for the specified stream, so it does only demuxing and muxing. It is useful
201 for changing the container format or modifying container-level metadata. The
202 diagram above will in this case simplify to this:
203
204 @example
205  _______              ______________            ________
206 |       |            |              |          |        |
207 | input |  demuxer   | encoded data |  muxer   | output |
208 | file  | ---------> | packets      | -------> | file   |
209 |_______|            |______________|          |________|
210
211 @end example
212
213 Since there is no decoding or encoding, it is very fast and there is no quality
214 loss. However it might not work in some cases because of many factors. Applying
215 filters is obviously also impossible, since filters work on uncompressed data.
216
217 @c man end DETAILED DESCRIPTION
218
219 @chapter Stream selection
220 @c man begin STREAM SELECTION
221
222 By default avconv tries to pick the "best" stream of each type present in input
223 files and add them to each output file. For video, this means the highest
224 resolution, for audio the highest channel count. For subtitle it's simply the
225 first subtitle stream.
226
227 You can disable some of those defaults by using @code{-vn/-an/-sn} options. For
228 full manual control, use the @code{-map} option, which disables the defaults just
229 described.
230
231 @c man end STREAM SELECTION
232
233 @chapter Options
234 @c man begin OPTIONS
235
236 @include avtools-common-opts.texi
237
238 @section Main options
239
240 @table @option
241
242 @item -f @var{fmt} (@emph{input/output})
243 Force input or output file format. The format is normally autodetected for input
244 files and guessed from file extension for output files, so this option is not
245 needed in most cases.
246
247 @item -i @var{filename} (@emph{input})
248 input file name
249
250 @item -y (@emph{global})
251 Overwrite output files without asking.
252
253 @item -n (@emph{global})
254 Immediately exit when output files already exist.
255
256 @item -loop @var{number} (@emph{input})
257 Set number of times input stream shall be looped. Loop 0 means no loop,
258 loop -1 means infinite loop.
259
260 @item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
261 @itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
262 Select an encoder (when used before an output file) or a decoder (when used
263 before an input file) for one or more streams. @var{codec} is the name of a
264 decoder/encoder or a special value @code{copy} (output only) to indicate that
265 the stream is not to be reencoded.
266
267 For example
268 @example
269 avconv -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
270 @end example
271 encodes all video streams with libx264 and copies all audio streams.
272
273 For each stream, the last matching @code{c} option is applied, so
274 @example
275 avconv -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
276 @end example
277 will copy all the streams except the second video, which will be encoded with
278 libx264, and the 138th audio, which will be encoded with libvorbis.
279
280 @item -t @var{duration} (@emph{output})
281 Stop writing the output after its duration reaches @var{duration}.
282 @var{duration} may be a number in seconds, or in @code{hh:mm:ss[.xxx]} form.
283
284 @item -fs @var{limit_size} (@emph{output})
285 Set the file size limit.
286
287 @item -ss @var{position} (@emph{input/output})
288 When used as an input option (before @code{-i}), seeks in this input file to
289 @var{position}. Note the in most formats it is not possible to seek exactly, so
290 @command{avconv} will seek to the closest seek point before @var{position}.
291 When transcoding and @option{-accurate_seek} is enabled (the default), this
292 extra segment between the seek point and @var{position} will be decoded and
293 discarded. When doing stream copy or when @option{-noaccurate_seek} is used, it
294 will be preserved.
295
296 When used as an output option (before an output filename), decodes but discards
297 input until the timestamps reach @var{position}.
298
299 @var{position} may be either in seconds or in @code{hh:mm:ss[.xxx]} form.
300
301 @item -itsoffset @var{offset} (@emph{input})
302 Set the input time offset in seconds.
303 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
304 The offset is added to the timestamps of the input files.
305 Specifying a positive offset means that the corresponding
306 streams are delayed by @var{offset} seconds.
307
308 @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
309 Set a metadata key/value pair.
310
311 An optional @var{metadata_specifier} may be given to set metadata
312 on streams or chapters. See @code{-map_metadata} documentation for
313 details.
314
315 This option overrides metadata set with @code{-map_metadata}. It is
316 also possible to delete metadata by using an empty value.
317
318 For example, for setting the title in the output file:
319 @example
320 avconv -i in.avi -metadata title="my title" out.flv
321 @end example
322
323 To set the language of the first audio stream:
324 @example
325 avconv -i INPUT -metadata:s:a:0 language=eng OUTPUT
326 @end example
327
328 @item -target @var{type} (@emph{output})
329 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
330 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
331 @code{film-} to use the corresponding standard. All the format options
332 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
333
334 @example
335 avconv -i myfile.avi -target vcd /tmp/vcd.mpg
336 @end example
337
338 Nevertheless you can specify additional options as long as you know
339 they do not conflict with the standard, as in:
340
341 @example
342 avconv -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
343 @end example
344
345 @item -dframes @var{number} (@emph{output})
346 Set the number of data frames to record. This is an obsolete alias for
347 @code{-frames:d}, which you should use instead.
348
349 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
350 Stop writing to the stream after @var{framecount} frames.
351
352 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
353 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
354 Use fixed quality scale (VBR). The meaning of @var{q} is
355 codec-dependent.
356
357 @item -b[:@var{stream_specifier}] @var{bitrate} (@emph{output,per-stream})
358 Set the stream bitrate in bits per second. When transcoding, this tells the
359 encoder to use the specified bitrate for the encoded stream.
360
361 For streamcopy, this provides a hint to the muxer about the bitrate of the input
362 stream.
363
364 @item -filter[:@var{stream_specifier}] @var{filter_graph} (@emph{output,per-stream})
365 @var{filter_graph} is a description of the filter graph to apply to
366 the stream. Use @code{-filters} to show all the available filters
367 (including also sources and sinks).
368
369 See also the @option{-filter_complex} option if you want to create filter graphs
370 with multiple inputs and/or outputs.
371
372 @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
373 This option is similar to @option{-filter}, the only difference is that its
374 argument is the name of the file from which a filtergraph description is to be
375 read.
376
377 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
378 Specify the preset for matching stream(s).
379
380 @item -stats (@emph{global})
381 Print encoding progress/statistics. On by default.
382
383 @item -attach @var{filename} (@emph{output})
384 Add an attachment to the output file. This is supported by a few formats
385 like Matroska for e.g. fonts used in rendering subtitles. Attachments
386 are implemented as a specific type of stream, so this option will add
387 a new stream to the file. It is then possible to use per-stream options
388 on this stream in the usual way. Attachment streams created with this
389 option will be created after all the other streams (i.e. those created
390 with @code{-map} or automatic mappings).
391
392 Note that for Matroska you also have to set the mimetype metadata tag:
393 @example
394 avconv -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
395 @end example
396 (assuming that the attachment stream will be third in the output file).
397
398 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
399 Extract the matching attachment stream into a file named @var{filename}. If
400 @var{filename} is empty, then the value of the @code{filename} metadata tag
401 will be used.
402
403 E.g. to extract the first attachment to a file named 'out.ttf':
404 @example
405 avconv -dump_attachment:t:0 out.ttf INPUT
406 @end example
407 To extract all attachments to files determined by the @code{filename} tag:
408 @example
409 avconv -dump_attachment:t "" INPUT
410 @end example
411
412 Technical note -- attachments are implemented as codec extradata, so this
413 option can actually be used to extract extradata from any stream, not just
414 attachments.
415
416 @item -noautorotate
417 Disable automatically rotating video based on file metadata.
418
419 @end table
420
421 @section Video Options
422
423 @table @option
424 @item -vframes @var{number} (@emph{output})
425 Set the number of video frames to record. This is an obsolete alias for
426 @code{-frames:v}, which you should use instead.
427 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
428 Set frame rate (Hz value, fraction or abbreviation).
429
430 As an input option, ignore any timestamps stored in the file and instead
431 generate timestamps assuming constant frame rate @var{fps}.
432
433 As an output option, duplicate or drop input frames to achieve constant output
434 frame rate @var{fps} (note that this actually causes the @code{fps} filter to be
435 inserted to the end of the corresponding filtergraph).
436
437 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
438 Set frame size.
439
440 As an input option, this is a shortcut for the @option{video_size} private
441 option, recognized by some demuxers for which the frame size is either not
442 stored in the file or is configurable -- e.g. raw video or video grabbers.
443
444 As an output option, this inserts the @code{scale} video filter to the
445 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
446 directly to insert it at the beginning or some other place.
447
448 The format is @samp{wxh} (default - same as source).  The following
449 abbreviations are recognized:
450 @table @samp
451 @item sqcif
452 128x96
453 @item qcif
454 176x144
455 @item cif
456 352x288
457 @item 4cif
458 704x576
459 @item 16cif
460 1408x1152
461 @item qqvga
462 160x120
463 @item qvga
464 320x240
465 @item vga
466 640x480
467 @item svga
468 800x600
469 @item xga
470 1024x768
471 @item uxga
472 1600x1200
473 @item qxga
474 2048x1536
475 @item sxga
476 1280x1024
477 @item qsxga
478 2560x2048
479 @item hsxga
480 5120x4096
481 @item wvga
482 852x480
483 @item wxga
484 1366x768
485 @item wsxga
486 1600x1024
487 @item wuxga
488 1920x1200
489 @item woxga
490 2560x1600
491 @item wqsxga
492 3200x2048
493 @item wquxga
494 3840x2400
495 @item whsxga
496 6400x4096
497 @item whuxga
498 7680x4800
499 @item cga
500 320x200
501 @item ega
502 640x350
503 @item hd480
504 852x480
505 @item hd720
506 1280x720
507 @item hd1080
508 1920x1080
509 @item 2kdci
510 2048x1080
511 @item 4kdci
512 4096x2160
513 @item uhd2160
514 3840x2160
515 @item uhd4320
516 7680x4320
517 @end table
518
519 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
520 Set the video display aspect ratio specified by @var{aspect}.
521
522 @var{aspect} can be a floating point number string, or a string of the
523 form @var{num}:@var{den}, where @var{num} and @var{den} are the
524 numerator and denominator of the aspect ratio. For example "4:3",
525 "16:9", "1.3333", and "1.7777" are valid argument values.
526
527 @item -vn (@emph{output})
528 Disable video recording.
529
530 @item -vcodec @var{codec} (@emph{output})
531 Set the video codec. This is an alias for @code{-codec:v}.
532
533 @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
534 Select the pass number (1 or 2). It is used to do two-pass
535 video encoding. The statistics of the video are recorded in the first
536 pass into a log file (see also the option -passlogfile),
537 and in the second pass that log file is used to generate the video
538 at the exact requested bitrate.
539 On pass 1, you may just deactivate audio and set output to null,
540 examples for Windows and Unix:
541 @example
542 avconv -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
543 avconv -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
544 @end example
545
546 @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
547 Set two-pass log file name prefix to @var{prefix}, the default file name
548 prefix is ``av2pass''. The complete file name will be
549 @file{PREFIX-N.log}, where N is a number specific to the output
550 stream.
551
552 @item -vf @var{filter_graph} (@emph{output})
553 @var{filter_graph} is a description of the filter graph to apply to
554 the input video.
555 Use the option "-filters" to show all the available filters (including
556 also sources and sinks).  This is an alias for @code{-filter:v}.
557
558 @end table
559
560 @section Advanced Video Options
561
562 @table @option
563 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
564 Set pixel format. Use @code{-pix_fmts} to show all the supported
565 pixel formats.
566 @item -sws_flags @var{flags} (@emph{input/output})
567 Set SwScaler flags.
568 @item -vdt @var{n}
569 Discard threshold.
570
571 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
572 rate control override for specific intervals
573
574 @item -vstats
575 Dump video coding statistics to @file{vstats_HHMMSS.log}.
576 @item -vstats_file @var{file}
577 Dump video coding statistics to @var{file}.
578 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
579 top=1/bottom=0/auto=-1 field first
580 @item -dc @var{precision}
581 Intra_dc_precision.
582 @item -vtag @var{fourcc/tag} (@emph{output})
583 Force video tag/fourcc. This is an alias for @code{-tag:v}.
584 @item -qphist (@emph{global})
585 Show QP histogram.
586 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
587 Force key frames at the specified timestamps, more precisely at the first
588 frames after each specified time.
589 This option can be useful to ensure that a seek point is present at a
590 chapter mark or any other designated place in the output file.
591 The timestamps must be specified in ascending order.
592
593 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
594 When doing stream copy, copy also non-key frames found at the
595 beginning.
596
597 @item -init_hw_device @var{type}[=@var{name}][:@var{device}[,@var{key=value}...]]
598 Initialise a new hardware device of type @var{type} called @var{name}, using the
599 given device parameters.
600 If no name is specified it will receive a default name of the form "@var{type}%d".
601
602 The meaning of @var{device} and the following arguments depends on the
603 device type:
604 @table @option
605
606 @item cuda
607 @var{device} is the number of the CUDA device.
608
609 @item dxva2
610 @var{device} is the number of the Direct3D 9 display adapter.
611
612 @item vaapi
613 @var{device} is either an X11 display name or a DRM render node.
614 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY})
615 and then the first DRM render node (@emph{/dev/dri/renderD128}).
616
617 @item vdpau
618 @var{device} is an X11 display name.
619 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY}).
620
621 @item qsv
622 @var{device} selects a value in @samp{MFX_IMPL_*}. Allowed values are:
623 @table @option
624 @item auto
625 @item sw
626 @item hw
627 @item auto_any
628 @item hw_any
629 @item hw2
630 @item hw3
631 @item hw4
632 @end table
633 If not specified, @samp{auto_any} is used.
634 (Note that it may be easier to achieve the desired result for QSV by creating the
635 platform-appropriate subdevice (@samp{dxva2} or @samp{vaapi}) and then deriving a
636 QSV device from that.)
637
638 @end table
639
640 @item -init_hw_device @var{type}[=@var{name}]@@@var{source}
641 Initialise a new hardware device of type @var{type} called @var{name},
642 deriving it from the existing device with the name @var{source}.
643
644 @item -init_hw_device list
645 List all hardware device types supported in this build of avconv.
646
647 @item -filter_hw_device @var{name}
648 Pass the hardware device called @var{name} to all filters in any filter graph.
649 This can be used to set the device to upload to with the @code{hwupload} filter,
650 or the device to map to with the @code{hwmap} filter.  Other filters may also
651 make use of this parameter when they require a hardware device.  Note that this
652 is typically only required when the input is not already in hardware frames -
653 when it is, filters will derive the device they require from the context of the
654 frames they receive as input.
655
656 This is a global setting, so all filters will receive the same device.
657
658 Do not use this option in scripts that should remain functional in future
659 avconv versions.
660
661 @item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
662 Use hardware acceleration to decode the matching stream(s). The allowed values
663 of @var{hwaccel} are:
664 @table @option
665 @item none
666 Do not use any hardware acceleration (the default).
667
668 @item auto
669 Automatically select the hardware acceleration method.
670
671 @item vda
672 Use Apple VDA hardware acceleration.
673
674 @item vdpau
675 Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
676
677 @item dxva2
678 Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
679
680 @item vaapi
681 Use VAAPI (Video Acceleration API) hardware acceleration.
682
683 @item qsv
684 Use the Intel QuickSync Video acceleration for video transcoding.
685
686 Unlike most other values, this option does not enable accelerated decoding (that
687 is used automatically whenever a qsv decoder is selected), but accelerated
688 transcoding, without copying the frames into the system memory.
689
690 For it to work, both the decoder and the encoder must support QSV acceleration
691 and no filters must be used.
692 @end table
693
694 This option has no effect if the selected hwaccel is not available or not
695 supported by the chosen decoder.
696
697 Note that most acceleration methods are intended for playback and will not be
698 faster than software decoding on modern CPUs. Additionally, @command{avconv}
699 will usually need to copy the decoded frames from the GPU memory into the system
700 memory, resulting in further performance loss. This option is thus mainly
701 useful for testing.
702
703 @item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
704 Select a device to use for hardware acceleration.
705
706 This option only makes sense when the @option{-hwaccel} option is also specified.
707 It can either refer to an existing device created with @option{-init_hw_device}
708 by name, or it can create a new device as if
709 @samp{-init_hw_device} @var{type}:@var{hwaccel_device}
710 were called immediately before.
711
712 @item -hwaccels
713 List all hardware acceleration methods supported in this build of avconv.
714
715 @end table
716
717 @section Audio Options
718
719 @table @option
720 @item -aframes @var{number} (@emph{output})
721 Set the number of audio frames to record. This is an obsolete alias for
722 @code{-frames:a}, which you should use instead.
723 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
724 Set the audio sampling frequency. For output streams it is set by
725 default to the frequency of the corresponding input stream. For input
726 streams this option only makes sense for audio grabbing devices and raw
727 demuxers and is mapped to the corresponding demuxer options.
728 @item -aq @var{q} (@emph{output})
729 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
730 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
731 Set the number of audio channels. For output streams it is set by
732 default to the number of input audio channels. For input streams
733 this option only makes sense for audio grabbing devices and raw demuxers
734 and is mapped to the corresponding demuxer options.
735 @item -an (@emph{output})
736 Disable audio recording.
737 @item -acodec @var{codec} (@emph{input/output})
738 Set the audio codec. This is an alias for @code{-codec:a}.
739 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
740 Set the audio sample format. Use @code{-sample_fmts} to get a list
741 of supported sample formats.
742 @item -af @var{filter_graph} (@emph{output})
743 @var{filter_graph} is a description of the filter graph to apply to
744 the input audio.
745 Use the option "-filters" to show all the available filters (including
746 also sources and sinks).  This is an alias for @code{-filter:a}.
747 @end table
748
749 @section Advanced Audio options:
750
751 @table @option
752 @item -atag @var{fourcc/tag} (@emph{output})
753 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
754 @end table
755
756 @section Subtitle options:
757
758 @table @option
759 @item -scodec @var{codec} (@emph{input/output})
760 Set the subtitle codec. This is an alias for @code{-codec:s}.
761 @item -sn (@emph{output})
762 Disable subtitle recording.
763 @end table
764
765 @section Advanced options
766
767 @table @option
768 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
769
770 Designate one or more input streams as a source for the output file. Each input
771 stream is identified by the input file index @var{input_file_id} and
772 the input stream index @var{input_stream_id} within the input
773 file. Both indices start at 0. If specified,
774 @var{sync_file_id}:@var{stream_specifier} sets which input stream
775 is used as a presentation sync reference.
776
777 The first @code{-map} option on the command line specifies the
778 source for output stream 0, the second @code{-map} option specifies
779 the source for output stream 1, etc.
780
781 A @code{-} character before the stream identifier creates a "negative" mapping.
782 It disables matching streams from already created mappings.
783
784 An alternative @var{[linklabel]} form will map outputs from complex filter
785 graphs (see the @option{-filter_complex} option) to the output file.
786 @var{linklabel} must correspond to a defined output link label in the graph.
787
788 For example, to map ALL streams from the first input file to output
789 @example
790 avconv -i INPUT -map 0 output
791 @end example
792
793 For example, if you have two audio streams in the first input file,
794 these streams are identified by "0:0" and "0:1". You can use
795 @code{-map} to select which streams to place in an output file. For
796 example:
797 @example
798 avconv -i INPUT -map 0:1 out.wav
799 @end example
800 will map the input stream in @file{INPUT} identified by "0:1" to
801 the (single) output stream in @file{out.wav}.
802
803 For example, to select the stream with index 2 from input file
804 @file{a.mov} (specified by the identifier "0:2"), and stream with
805 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
806 and copy them to the output file @file{out.mov}:
807 @example
808 avconv -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
809 @end example
810
811 To select all video and the third audio stream from an input file:
812 @example
813 avconv -i INPUT -map 0:v -map 0:a:2 OUTPUT
814 @end example
815
816 To map all the streams except the second audio, use negative mappings
817 @example
818 avconv -i INPUT -map 0 -map -0:a:1 OUTPUT
819 @end example
820
821 To pick the English audio stream:
822 @example
823 avconv -i INPUT -map 0:m:language:eng OUTPUT
824 @end example
825
826 Note that using this option disables the default mappings for this output file.
827
828 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
829 Set metadata information of the next output file from @var{infile}. Note that
830 those are file indices (zero-based), not filenames.
831 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
832 A metadata specifier can have the following forms:
833 @table @option
834 @item @var{g}
835 global metadata, i.e. metadata that applies to the whole file
836
837 @item @var{s}[:@var{stream_spec}]
838 per-stream metadata. @var{stream_spec} is a stream specifier as described
839 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
840 matching stream is copied from. In an output metadata specifier, all matching
841 streams are copied to.
842
843 @item @var{c}:@var{chapter_index}
844 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
845
846 @item @var{p}:@var{program_index}
847 per-program metadata. @var{program_index} is the zero-based program index.
848 @end table
849 If metadata specifier is omitted, it defaults to global.
850
851 By default, global metadata is copied from the first input file,
852 per-stream and per-chapter metadata is copied along with streams/chapters. These
853 default mappings are disabled by creating any mapping of the relevant type. A negative
854 file index can be used to create a dummy mapping that just disables automatic copying.
855
856 For example to copy metadata from the first stream of the input file to global metadata
857 of the output file:
858 @example
859 avconv -i in.ogg -map_metadata 0:s:0 out.mp3
860 @end example
861
862 To do the reverse, i.e. copy global metadata to all audio streams:
863 @example
864 avconv -i in.mkv -map_metadata:s:a 0:g out.mkv
865 @end example
866 Note that simple @code{0} would work as well in this example, since global
867 metadata is assumed by default.
868
869 @item -map_chapters @var{input_file_index} (@emph{output})
870 Copy chapters from input file with index @var{input_file_index} to the next
871 output file. If no chapter mapping is specified, then chapters are copied from
872 the first input file with at least one chapter. Use a negative file index to
873 disable any chapter copying.
874 @item -debug
875 Print specific debug info.
876 @item -benchmark (@emph{global})
877 Show benchmarking information at the end of an encode.
878 Shows CPU time used and maximum memory consumption.
879 Maximum memory consumption is not supported on all systems,
880 it will usually display as 0 if not supported.
881 @item -timelimit @var{duration} (@emph{global})
882 Exit after avconv has been running for @var{duration} seconds.
883 @item -dump (@emph{global})
884 Dump each input packet to stderr.
885 @item -hex (@emph{global})
886 When dumping packets, also dump the payload.
887 @item -re (@emph{input})
888 Read input at native frame rate. Mainly used to simulate a grab device
889 or live input stream (e.g. when reading from a file). Should not be used
890 with actual grab devices or live input streams (where it can cause packet
891 loss).
892 @item -vsync @var{parameter}
893 Video sync method.
894
895 @table @option
896 @item passthrough
897 Each frame is passed with its timestamp from the demuxer to the muxer.
898 @item cfr
899 Frames will be duplicated and dropped to achieve exactly the requested
900 constant framerate.
901 @item vfr
902 Frames are passed through with their timestamp or dropped so as to
903 prevent 2 frames from having the same timestamp.
904 @item auto
905 Chooses between 1 and 2 depending on muxer capabilities. This is the
906 default method.
907 @end table
908
909 With -map you can select from which stream the timestamps should be
910 taken. You can leave either video or audio unchanged and sync the
911 remaining stream(s) to the unchanged one.
912
913 @item -async @var{samples_per_second}
914 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
915 the parameter is the maximum samples per second by which the audio is changed.
916 -async 1 is a special case where only the start of the audio stream is corrected
917 without any later correction.
918 This option has been deprecated. Use the @code{asyncts} audio filter instead.
919 @item -copyts
920 Copy timestamps from input to output.
921 @item -copytb
922 Copy input stream time base from input to output when stream copying.
923 @item -shortest (@emph{output})
924 Finish encoding when the shortest input stream ends.
925 @item -dts_delta_threshold
926 Timestamp discontinuity delta threshold.
927 @item -muxdelay @var{seconds} (@emph{input})
928 Set the maximum demux-decode delay.
929 @item -muxpreload @var{seconds} (@emph{input})
930 Set the initial demux-decode delay.
931 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
932 Assign a new stream-id value to an output stream. This option should be
933 specified prior to the output filename to which it applies.
934 For the situation where multiple output files exist, a streamid
935 may be reassigned to a different value.
936
937 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
938 an output mpegts file:
939 @example
940 avconv -i infile -streamid 0:33 -streamid 1:36 out.ts
941 @end example
942
943 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
944 Set bitstream filters for matching streams. @var{bitstream_filters} is
945 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
946 to get the list of bitstream filters.
947 @example
948 avconv -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
949 @end example
950 @example
951 avconv -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
952 @end example
953
954 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
955 Force a tag/fourcc for matching streams.
956
957 @item -filter_complex @var{filtergraph} (@emph{global})
958 Define a complex filter graph, i.e. one with arbitrary number of inputs and/or
959 outputs. For simple graphs -- those with one input and one output of the same
960 type -- see the @option{-filter} options. @var{filtergraph} is a description of
961 the filter graph, as described in @ref{Filtergraph syntax}.
962
963 Input link labels must refer to input streams using the
964 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
965 uses). If @var{stream_specifier} matches multiple streams, the first one will be
966 used. An unlabeled input will be connected to the first unused input stream of
967 the matching type.
968
969 Output link labels are referred to with @option{-map}. Unlabeled outputs are
970 added to the first output file.
971
972 Note that with this option it is possible to use only lavfi sources without
973 normal input files.
974
975 For example, to overlay an image over video
976 @example
977 avconv -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
978 '[out]' out.mkv
979 @end example
980 Here @code{[0:v]} refers to the first video stream in the first input file,
981 which is linked to the first (main) input of the overlay filter. Similarly the
982 first video stream in the second input is linked to the second (overlay) input
983 of overlay.
984
985 Assuming there is only one video stream in each input file, we can omit input
986 labels, so the above is equivalent to
987 @example
988 avconv -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
989 '[out]' out.mkv
990 @end example
991
992 Furthermore we can omit the output label and the single output from the filter
993 graph will be added to the output file automatically, so we can simply write
994 @example
995 avconv -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
996 @end example
997
998 To generate 5 seconds of pure red video using lavfi @code{color} source:
999 @example
1000 avconv -filter_complex 'color=red' -t 5 out.mkv
1001 @end example
1002
1003 @item -filter_complex_script @var{filename} (@emph{global})
1004 This option is similar to @option{-filter_complex}, the only difference is that
1005 its argument is the name of the file from which a complex filtergraph
1006 description is to be read.
1007
1008 @item -accurate_seek (@emph{input})
1009 This option enables or disables accurate seeking in input files with the
1010 @option{-ss} option. It is enabled by default, so seeking is accurate when
1011 transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
1012 e.g. when copying some streams and transcoding the others.
1013
1014 @item -max_muxing_queue_size @var{packets} (@emph{output,per-stream})
1015 When transcoding audio and/or video streams, avconv will not begin writing into
1016 the output until it has one packet for each such stream. While waiting for that
1017 to happen, packets for other streams are buffered. This option sets the size of
1018 this buffer, in packets, for the matching output stream.
1019
1020 The default value of this option should be high enough for most uses, so only
1021 touch this option if you are sure that you need it.
1022
1023 @end table
1024 @c man end OPTIONS
1025
1026 @chapter Tips
1027 @c man begin TIPS
1028
1029 @itemize
1030 @item
1031 For streaming at very low bitrate application, use a low frame rate
1032 and a small GOP size. This is especially true for RealVideo where
1033 the Linux player does not seem to be very fast, so it can miss
1034 frames. An example is:
1035
1036 @example
1037 avconv -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
1038 @end example
1039
1040 @item
1041 The parameter 'q' which is displayed while encoding is the current
1042 quantizer. The value 1 indicates that a very good quality could
1043 be achieved. The value 31 indicates the worst quality. If q=31 appears
1044 too often, it means that the encoder cannot compress enough to meet
1045 your bitrate. You must either increase the bitrate, decrease the
1046 frame rate or decrease the frame size.
1047
1048 @item
1049 If your computer is not fast enough, you can speed up the
1050 compression at the expense of the compression ratio. You can use
1051 '-me zero' to speed up motion estimation, and '-g 0' to disable
1052 motion estimation completely (you have only I-frames, which means it
1053 is about as good as JPEG compression).
1054
1055 @item
1056 To have very low audio bitrates, reduce the sampling frequency
1057 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
1058
1059 @item
1060 To have a constant quality (but a variable bitrate), use the option
1061 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
1062 quality).
1063
1064 @end itemize
1065 @c man end TIPS
1066
1067 @chapter Examples
1068 @c man begin EXAMPLES
1069
1070 @section Preset files
1071
1072 A preset file contains a sequence of @var{option=value} pairs, one for
1073 each line, specifying a sequence of options which can be specified also on
1074 the command line. Lines starting with the hash ('#') character are ignored and
1075 are used to provide comments. Empty lines are also ignored. Check the
1076 @file{presets} directory in the Libav source tree for examples.
1077
1078 Preset files are specified with the @code{pre} option, this option takes a
1079 preset name as input.  Avconv searches for a file named @var{preset_name}.avpreset in
1080 the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.avconv}, and in
1081 the data directory defined at configuration time (usually @file{$PREFIX/share/avconv})
1082 in that order.  For example, if the argument is @code{libx264-max}, it will
1083 search for the file @file{libx264-max.avpreset}.
1084
1085 @section Video and Audio grabbing
1086
1087 If you specify the input format and device then avconv can grab video
1088 and audio directly.
1089
1090 @example
1091 avconv -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
1092 @end example
1093
1094 Note that you must activate the right video source and channel before
1095 launching avconv with any TV viewer such as
1096 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
1097 have to set the audio recording levels correctly with a
1098 standard mixer.
1099
1100 @section X11 grabbing
1101
1102 Grab the X11 display with avconv via
1103
1104 @example
1105 avconv -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
1106 @end example
1107
1108 0.0 is display.screen number of your X11 server, same as
1109 the DISPLAY environment variable.
1110
1111 @example
1112 avconv -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
1113 @end example
1114
1115 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
1116 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
1117
1118 @section Video and Audio file format conversion
1119
1120 Any supported file format and protocol can serve as input to avconv:
1121
1122 Examples:
1123 @itemize
1124 @item
1125 You can use YUV files as input:
1126
1127 @example
1128 avconv -i /tmp/test%d.Y /tmp/out.mpg
1129 @end example
1130
1131 It will use the files:
1132 @example
1133 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
1134 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
1135 @end example
1136
1137 The Y files use twice the resolution of the U and V files. They are
1138 raw files, without header. They can be generated by all decent video
1139 decoders. You must specify the size of the image with the @option{-s} option
1140 if avconv cannot guess it.
1141
1142 @item
1143 You can input from a raw YUV420P file:
1144
1145 @example
1146 avconv -i /tmp/test.yuv /tmp/out.avi
1147 @end example
1148
1149 test.yuv is a file containing raw YUV planar data. Each frame is composed
1150 of the Y plane followed by the U and V planes at half vertical and
1151 horizontal resolution.
1152
1153 @item
1154 You can output to a raw YUV420P file:
1155
1156 @example
1157 avconv -i mydivx.avi hugefile.yuv
1158 @end example
1159
1160 @item
1161 You can set several input files and output files:
1162
1163 @example
1164 avconv -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1165 @end example
1166
1167 Converts the audio file a.wav and the raw YUV video file a.yuv
1168 to MPEG file a.mpg.
1169
1170 @item
1171 You can also do audio and video conversions at the same time:
1172
1173 @example
1174 avconv -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1175 @end example
1176
1177 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1178
1179 @item
1180 You can encode to several formats at the same time and define a
1181 mapping from input stream to output streams:
1182
1183 @example
1184 avconv -i /tmp/a.wav -map 0:a -b 64k /tmp/a.mp2 -map 0:a -b 128k /tmp/b.mp2
1185 @end example
1186
1187 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1188 file:index' specifies which input stream is used for each output
1189 stream, in the order of the definition of output streams.
1190
1191 @item
1192 You can transcode decrypted VOBs:
1193
1194 @example
1195 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
1196 @end example
1197
1198 This is a typical DVD ripping example; the input is a VOB file, the
1199 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1200 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1201 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1202 input video. Furthermore, the audio stream is MP3-encoded so you need
1203 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1204 The mapping is particularly useful for DVD transcoding
1205 to get the desired audio language.
1206
1207 NOTE: To see the supported input formats, use @code{avconv -formats}.
1208
1209 @item
1210 You can extract images from a video, or create a video from many images:
1211
1212 For extracting images from a video:
1213 @example
1214 avconv -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1215 @end example
1216
1217 This will extract one video frame per second from the video and will
1218 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1219 etc. Images will be rescaled to fit the new WxH values.
1220
1221 If you want to extract just a limited number of frames, you can use the
1222 above command in combination with the @code{-frames:v} or @code{-t} option,
1223 or in combination with -ss to start extracting from a certain point in time.
1224
1225 For creating a video from many images:
1226 @example
1227 avconv -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1228 @end example
1229
1230 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1231 composed of three digits padded with zeroes to express the sequence
1232 number. It is the same syntax supported by the C printf function, but
1233 only formats accepting a normal integer are suitable.
1234
1235 @item
1236 You can put many streams of the same type in the output:
1237
1238 @example
1239 avconv -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
1240 @end example
1241
1242 The resulting output file @file{test12.nut} will contain the first four streams
1243 from the input files in reverse order.
1244
1245 @item
1246 To force CBR video output:
1247 @example
1248 avconv -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1249 @end example
1250
1251 @item
1252 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1253 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1254 @example
1255 avconv -i src.ext -lmax 21*QP2LAMBDA dst.ext
1256 @end example
1257
1258 @end itemize
1259 @c man end EXAMPLES
1260
1261 @include eval.texi
1262 @include decoders.texi
1263 @include encoders.texi
1264 @include demuxers.texi
1265 @include muxers.texi
1266 @include indevs.texi
1267 @include protocols.texi
1268 @include bitstream_filters.texi
1269 @include filters.texi
1270 @include metadata.texi
1271
1272 @ignore
1273
1274 @setfilename avconv
1275 @settitle avconv video converter
1276
1277 @c man begin SEEALSO
1278 avplay(1), avprobe(1) and the Libav HTML documentation
1279 @c man end
1280
1281 @c man begin AUTHORS
1282 The Libav developers
1283 @c man end
1284
1285 @end ignore
1286
1287 @bye