aarch64: Add assembly support for -fsanitize=hwaddress tagged globals.
[libav.git] / doc / encoders.texi
blobc369e03bfd33c09bc041bdf03d54297d2d186733
1 @chapter Encoders
2 @c man begin ENCODERS
4 Encoders are configured elements in Libav which allow the encoding of
5 multimedia streams.
7 When you configure your Libav build, all the supported native encoders
8 are enabled by default. Encoders requiring an external library must be enabled
9 manually via the corresponding @code{--enable-lib} option. You can list all
10 available encoders using the configure option @code{--list-encoders}.
12 You can disable all the encoders with the configure option
13 @code{--disable-encoders} and selectively enable / disable single encoders
14 with the options @code{--enable-encoder=@var{ENCODER}} /
15 @code{--disable-encoder=@var{ENCODER}}.
17 The option @code{-encoders} of the av* tools will display the list of
18 enabled encoders.
20 @c man end ENCODERS
22 @chapter Audio Encoders
23 @c man begin AUDIO ENCODERS
25 A description of some of the currently available audio encoders
26 follows.
28 @section ac3 and ac3_fixed
30 AC-3 audio encoders.
32 These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
33 the undocumented RealAudio 3 (a.k.a. dnet).
35 The @var{ac3} encoder uses floating-point math, while the @var{ac3_fixed}
36 encoder only uses fixed-point integer math. This does not mean that one is
37 always faster, just that one or the other may be better suited to a
38 particular system. The floating-point encoder will generally produce better
39 quality audio for a given bitrate. The @var{ac3_fixed} encoder is not the
40 default codec for any of the output formats, so it must be specified explicitly
41 using the option @code{-c:a ac3_fixed} in order to use it.
43 @subsection AC-3 Metadata
45 The AC-3 metadata options are used to set parameters that describe the audio,
46 but in most cases do not affect the audio encoding itself. Some of the options
47 do directly affect or influence the decoding and playback of the resulting
48 bitstream, while others are just for informational purposes. A few of the
49 options will add bits to the output stream that could otherwise be used for
50 audio data, and will thus affect the quality of the output. Those will be
51 indicated accordingly with a note in the option list below.
53 These parameters are described in detail in several publicly-available
54 documents.
55 @itemize
56 @item @uref{http://www.atsc.org/cms/standards/a_52-2010.pdf,A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard}
57 @item @uref{http://www.atsc.org/cms/standards/a_54a_with_corr_1.pdf,A/54 - Guide to the Use of the ATSC Digital Television Standard}
58 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf,Dolby Metadata Guide}
59 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf,Dolby Digital Professional Encoding Guidelines}
60 @end itemize
62 @subsubsection Metadata Control Options
64 @table @option
66 @item -per_frame_metadata @var{boolean}
67 Allow Per-Frame Metadata. Specifies if the encoder should check for changing
68 metadata for each frame.
69 @table @option
70 @item 0
71 The metadata values set at initialization will be used for every frame in the
72 stream. (default)
73 @item 1
74 Metadata values can be changed before encoding each frame.
75 @end table
77 @end table
79 @subsubsection Downmix Levels
81 @table @option
83 @item -center_mixlev @var{level}
84 Center Mix Level. The amount of gain the decoder should apply to the center
85 channel when downmixing to stereo. This field will only be written to the
86 bitstream if a center channel is present. The value is specified as a scale
87 factor. There are 3 valid values:
88 @table @option
89 @item 0.707
90 Apply -3dB gain
91 @item 0.595
92 Apply -4.5dB gain (default)
93 @item 0.500
94 Apply -6dB gain
95 @end table
97 @item -surround_mixlev @var{level}
98 Surround Mix Level. The amount of gain the decoder should apply to the surround
99 channel(s) when downmixing to stereo. This field will only be written to the
100 bitstream if one or more surround channels are present. The value is specified
101 as a scale factor.  There are 3 valid values:
102 @table @option
103 @item 0.707
104 Apply -3dB gain
105 @item 0.500
106 Apply -6dB gain (default)
107 @item 0.000
108 Silence Surround Channel(s)
109 @end table
111 @end table
113 @subsubsection Audio Production Information
114 Audio Production Information is optional information describing the mixing
115 environment.  Either none or both of the fields are written to the bitstream.
117 @table @option
119 @item -mixing_level @var{number}
120 Mixing Level. Specifies peak sound pressure level (SPL) in the production
121 environment when the mix was mastered. Valid values are 80 to 111, or -1 for
122 unknown or not indicated. The default value is -1, but that value cannot be
123 used if the Audio Production Information is written to the bitstream. Therefore,
124 if the @code{room_type} option is not the default value, the @code{mixing_level}
125 option must not be -1.
127 @item -room_type @var{type}
128 Room Type. Describes the equalization used during the final mixing session at
129 the studio or on the dubbing stage. A large room is a dubbing stage with the
130 industry standard X-curve equalization; a small room has flat equalization.
131 This field will not be written to the bitstream if both the @code{mixing_level}
132 option and the @code{room_type} option have the default values.
133 @table @option
134 @item 0
135 @itemx notindicated
136 Not Indicated (default)
137 @item 1
138 @itemx large
139 Large Room
140 @item 2
141 @itemx small
142 Small Room
143 @end table
145 @end table
147 @subsubsection Other Metadata Options
149 @table @option
151 @item -copyright @var{boolean}
152 Copyright Indicator. Specifies whether a copyright exists for this audio.
153 @table @option
154 @item 0
155 @itemx off
156 No Copyright Exists (default)
157 @item 1
158 @itemx on
159 Copyright Exists
160 @end table
162 @item -dialnorm @var{value}
163 Dialogue Normalization. Indicates how far the average dialogue level of the
164 program is below digital 100% full scale (0 dBFS). This parameter determines a
165 level shift during audio reproduction that sets the average volume of the
166 dialogue to a preset level. The goal is to match volume level between program
167 sources. A value of -31dB will result in no volume level change, relative to
168 the source volume, during audio reproduction. Valid values are whole numbers in
169 the range -31 to -1, with -31 being the default.
171 @item -dsur_mode @var{mode}
172 Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
173 (Pro Logic). This field will only be written to the bitstream if the audio
174 stream is stereo. Using this option does @b{NOT} mean the encoder will actually
175 apply Dolby Surround processing.
176 @table @option
177 @item 0
178 @itemx notindicated
179 Not Indicated (default)
180 @item 1
181 @itemx off
182 Not Dolby Surround Encoded
183 @item 2
184 @itemx on
185 Dolby Surround Encoded
186 @end table
188 @item -original @var{boolean}
189 Original Bit Stream Indicator. Specifies whether this audio is from the
190 original source and not a copy.
191 @table @option
192 @item 0
193 @itemx off
194 Not Original Source
195 @item 1
196 @itemx on
197 Original Source (default)
198 @end table
200 @end table
202 @subsection Extended Bitstream Information
203 The extended bitstream options are part of the Alternate Bit Stream Syntax as
204 specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
205 If any one parameter in a group is specified, all values in that group will be
206 written to the bitstream.  Default values are used for those that are written
207 but have not been specified.  If the mixing levels are written, the decoder
208 will use these values instead of the ones specified in the @code{center_mixlev}
209 and @code{surround_mixlev} options if it supports the Alternate Bit Stream
210 Syntax.
212 @subsubsection Extended Bitstream Information - Part 1
214 @table @option
216 @item -dmix_mode @var{mode}
217 Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
218 (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
219 @table @option
220 @item 0
221 @itemx notindicated
222 Not Indicated (default)
223 @item 1
224 @itemx ltrt
225 Lt/Rt Downmix Preferred
226 @item 2
227 @itemx loro
228 Lo/Ro Downmix Preferred
229 @end table
231 @item -ltrt_cmixlev @var{level}
232 Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
233 center channel when downmixing to stereo in Lt/Rt mode.
234 @table @option
235 @item 1.414
236 Apply +3dB gain
237 @item 1.189
238 Apply +1.5dB gain
239 @item 1.000
240 Apply 0dB gain
241 @item 0.841
242 Apply -1.5dB gain
243 @item 0.707
244 Apply -3.0dB gain
245 @item 0.595
246 Apply -4.5dB gain (default)
247 @item 0.500
248 Apply -6.0dB gain
249 @item 0.000
250 Silence Center Channel
251 @end table
253 @item -ltrt_surmixlev @var{level}
254 Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
255 surround channel(s) when downmixing to stereo in Lt/Rt mode.
256 @table @option
257 @item 0.841
258 Apply -1.5dB gain
259 @item 0.707
260 Apply -3.0dB gain
261 @item 0.595
262 Apply -4.5dB gain
263 @item 0.500
264 Apply -6.0dB gain (default)
265 @item 0.000
266 Silence Surround Channel(s)
267 @end table
269 @item -loro_cmixlev @var{level}
270 Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
271 center channel when downmixing to stereo in Lo/Ro mode.
272 @table @option
273 @item 1.414
274 Apply +3dB gain
275 @item 1.189
276 Apply +1.5dB gain
277 @item 1.000
278 Apply 0dB gain
279 @item 0.841
280 Apply -1.5dB gain
281 @item 0.707
282 Apply -3.0dB gain
283 @item 0.595
284 Apply -4.5dB gain (default)
285 @item 0.500
286 Apply -6.0dB gain
287 @item 0.000
288 Silence Center Channel
289 @end table
291 @item -loro_surmixlev @var{level}
292 Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
293 surround channel(s) when downmixing to stereo in Lo/Ro mode.
294 @table @option
295 @item 0.841
296 Apply -1.5dB gain
297 @item 0.707
298 Apply -3.0dB gain
299 @item 0.595
300 Apply -4.5dB gain
301 @item 0.500
302 Apply -6.0dB gain (default)
303 @item 0.000
304 Silence Surround Channel(s)
305 @end table
307 @end table
309 @subsubsection Extended Bitstream Information - Part 2
311 @table @option
313 @item -dsurex_mode @var{mode}
314 Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
315 (7.1 matrixed to 5.1). Using this option does @b{NOT} mean the encoder will actually
316 apply Dolby Surround EX processing.
317 @table @option
318 @item 0
319 @itemx notindicated
320 Not Indicated (default)
321 @item 1
322 @itemx on
323 Dolby Surround EX Off
324 @item 2
325 @itemx off
326 Dolby Surround EX On
327 @end table
329 @item -dheadphone_mode @var{mode}
330 Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
331 encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
332 option does @b{NOT} mean the encoder will actually apply Dolby Headphone
333 processing.
334 @table @option
335 @item 0
336 @itemx notindicated
337 Not Indicated (default)
338 @item 1
339 @itemx on
340 Dolby Headphone Off
341 @item 2
342 @itemx off
343 Dolby Headphone On
344 @end table
346 @item -ad_conv_type @var{type}
347 A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
348 conversion.
349 @table @option
350 @item 0
351 @itemx standard
352 Standard A/D Converter (default)
353 @item 1
354 @itemx hdcd
355 HDCD A/D Converter
356 @end table
358 @end table
360 @subsection Other AC-3 Encoding Options
362 @table @option
364 @item -stereo_rematrixing @var{boolean}
365 Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
366 is an optional AC-3 feature that increases quality by selectively encoding
367 the left/right channels as mid/side. This option is enabled by default, and it
368 is highly recommended that it be left as enabled except for testing purposes.
370 @end table
372 @subheading Floating-Point-Only AC-3 Encoding Options
374 These options are only valid for the floating-point encoder and do not exist
375 for the fixed-point encoder due to the corresponding features not being
376 implemented in fixed-point.
378 @table @option
380 @item -channel_coupling @var{boolean}
381 Enables/Disables use of channel coupling, which is an optional AC-3 feature
382 that increases quality by combining high frequency information from multiple
383 channels into a single channel. The per-channel high frequency information is
384 sent with less accuracy in both the frequency and time domains. This allows
385 more bits to be used for lower frequencies while preserving enough information
386 to reconstruct the high frequencies. This option is enabled by default for the
387 floating-point encoder and should generally be left as enabled except for
388 testing purposes or to increase encoding speed.
389 @table @option
390 @item -1
391 @itemx auto
392 Selected by Encoder (default)
393 @item 0
394 @itemx off
395 Disable Channel Coupling
396 @item 1
397 @itemx on
398 Enable Channel Coupling
399 @end table
401 @item -cpl_start_band @var{number}
402 Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
403 value higher than the bandwidth is used, it will be reduced to 1 less than the
404 coupling end band. If @var{auto} is used, the start band will be determined by
405 the encoder based on the bit rate, sample rate, and channel layout. This option
406 has no effect if channel coupling is disabled.
407 @table @option
408 @item -1
409 @itemx auto
410 Selected by Encoder (default)
411 @end table
413 @end table
415 @section libwavpack
417 A wrapper providing WavPack encoding through libwavpack.
419 Only lossless mode using 32-bit integer samples is supported currently.
420 The @option{compression_level} option can be used to control speed vs.
421 compression tradeoff, with the values mapped to libwavpack as follows:
423 @table @option
425 @item 0
426 Fast mode - corresponding to the wavpack @option{-f} option.
428 @item 1
429 Normal (default) settings.
431 @item 2
432 High quality - corresponding to the wavpack @option{-h} option.
434 @item 3
435 Very high quality - corresponding to the wavpack @option{-hh} option.
437 @item 4-8
438 Same as 3, but with extra processing enabled - corresponding to the wavpack
439 @option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
440 @option{-x6}.
442 @end table
444 @c man end AUDIO ENCODERS
446 @chapter Video Encoders
447 @c man begin VIDEO ENCODERS
449 @section libwebp
451 libwebp WebP Image encoder wrapper
453 libwebp is Google's official encoder for WebP images. It can encode in either
454 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
455 frame. Lossless images are a separate codec developed by Google.
457 @subsection Pixel Format
459 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
460 to limitations of the format and libwebp. Alpha is supported for either mode.
461 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
462 passed in for encoding lossless, the pixel format will automatically be
463 converted using functions from libwebp. This is not ideal and is done only for
464 convenience.
466 @subsection Options
468 @table @option
470 @item -lossless @var{boolean}
471 Enables/Disables use of lossless mode. Default is 0.
473 @item -compression_level @var{integer}
474 For lossy, this is a quality/speed tradeoff. Higher values give better quality
475 for a given size at the cost of increased encoding time. For lossless, this is
476 a size/speed tradeoff. Higher values give smaller size at the cost of increased
477 encoding time. More specifically, it controls the number of extra algorithms
478 and compression tools used, and varies the combination of these tools. This
479 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
480 Default is 4.
482 @item -qscale @var{float}
483 For lossy encoding, this controls image quality, 0 to 100. For lossless
484 encoding, this controls the effort and time spent at compressing more. The
485 default value is 75. Note that for usage via libavcodec, this option is called
486 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
488 @item -preset @var{type}
489 Configuration preset. This does some automatic settings based on the general
490 type of the image.
491 @table @option
492 @item none
493 Do not use a preset.
494 @item default
495 Use the encoder default.
496 @item picture
497 Digital picture, like portrait, inner shot
498 @item photo
499 Outdoor photograph, with natural lighting
500 @item drawing
501 Hand or line drawing, with high-contrast details
502 @item icon
503 Small-sized colorful images
504 @item text
505 Text-like
506 @end table
508 @item lumi_aq
509 Enable lumi masking adaptive quantization when set to 1. Default is 0
510 (disabled).
512 @item variance_aq
513 Enable variance adaptive quantization when set to 1. Default is 0
514 (disabled).
516 When combined with @option{lumi_aq}, the resulting quality will not
517 be better than any of the two specified individually. In other
518 words, the resulting quality will be the worse one of the two
519 effects.
521 @item ssim
522 Set structural similarity (SSIM) displaying method. Possible values:
524 @table @samp
525 @item off
526 Disable displaying of SSIM information.
528 @item avg
529 Output average SSIM at the end of encoding to stdout. The format of
530 showing the average SSIM is:
532 @example
533 Average SSIM: %f
534 @end example
536 For users who are not familiar with C, %f means a float number, or
537 a decimal (e.g. 0.939232).
539 @item frame
540 Output both per-frame SSIM data during encoding and average SSIM at
541 the end of encoding to stdout. The format of per-frame information
544 @example
545        SSIM: avg: %1.3f min: %1.3f max: %1.3f
546 @end example
548 For users who are not familiar with C, %1.3f means a float number
549 rounded to 3 digits after the dot (e.g. 0.932).
551 @end table
553 @item ssim_acc
554 Set SSIM accuracy. Valid options are integers within the range of
555 0-4, while 0 gives the most accurate result and 4 computes the
556 fastest.
558 @end table
560 @section libx264
562 x264 H.264/MPEG-4 AVC encoder wrapper
564 x264 supports an impressive number of features, including 8x8 and 4x4 adaptive
565 spatial transform, adaptive B-frame placement, CAVLC/CABAC entropy coding,
566 interlacing (MBAFF), lossless mode, psy optimizations for detail retention
567 (adaptive quantization, psy-RD, psy-trellis).
569 The Libav wrapper provides a mapping for most of them using global options
570 that match those of the encoders and provides private options for the unique
571 encoder options. Additionally an expert override is provided to directly pass
572 a list of key=value tuples as accepted by x264_param_parse.
574 @subsection Option Mapping
576 The following options are supported by the x264 wrapper, the x264-equivalent
577 options follow the Libav ones.
579 @multitable {                  } {              } {                           }
580 @item b                 @tab bitrate
581 @tab Libav @code{b} option is expressed in bits/s, x264 @code{bitrate} in kilobits/s.
582 @item bf                @tab bframes
583 @tab Maximum number of B-frames.
584 @item g                 @tab keyint
585 @tab Maximum GOP size.
586 @item qmin              @tab qpmin
587 @tab Minimum quantizer scale.
588 @item qmax              @tab qpmax
589 @tab Maximum quantizer scale.
590 @item qdiff             @tab qpstep
591 @tab Maximum difference between quantizer scales.
592 @item qblur             @tab qblur
593 @tab Quantizer curve blur
594 @item qcomp             @tab qcomp
595 @tab Quantizer curve compression factor
596 @item refs              @tab ref
597 @tab Number of reference frames each P-frame can use. The range is from @var{0-16}.
598 @item sc_threshold      @tab scenecut
599 @tab Sets the threshold for the scene change detection.
600 @item trellis           @tab trellis
601 @tab Performs Trellis quantization to increase efficiency. Enabled by default.
602 @item nr                @tab nr
603 @tab Noise reduction.
604 @item me_range          @tab merange
605 @tab Maximum range of the motion search in pixels.
606 @item subq              @tab subme
607 @tab Sub-pixel motion estimation method.
608 @item b_strategy        @tab b-adapt
609 @tab Adaptive B-frame placement decision algorithm. Use only on first-pass.
610 @item keyint_min        @tab min-keyint
611 @tab Minimum GOP size.
612 @item coder             @tab cabac
613 @tab Set coder to @code{ac} to use CABAC.
614 @item cmp               @tab chroma-me
615 @tab Set to @code{chroma} to use chroma motion estimation.
616 @item threads           @tab threads
617 @tab Number of encoding threads.
618 @item thread_type       @tab sliced_threads
619 @tab Set to @code{slice} to use sliced threading instead of frame threading.
620 @item flags -cgop       @tab open-gop
621 @tab Set @code{-cgop} to use recovery points to close GOPs.
622 @item rc_init_occupancy @tab vbv-init
623 @tab Initial buffer occupancy.
624 @end multitable
626 @subsection Private Options
627 @table @option
628 @item -preset @var{string}
629 Set the encoding preset (cf. x264 --fullhelp).
630 @item -tune @var{string}
631 Tune the encoding params (cf. x264 --fullhelp).
632 @item -profile @var{string}
633 Set profile restrictions (cf. x264 --fullhelp).
634 @item -fastfirstpass @var{integer}
635 Use fast settings when encoding first pass.
636 @item -crf @var{float}
637 Select the quality for constant quality mode.
638 @item -crf_max @var{float}
639 In CRF mode, prevents VBV from lowering quality beyond this point.
640 @item -qp @var{integer}
641 Constant quantization parameter rate control method.
642 @item -aq-mode @var{integer}
643 AQ method
645 Possible values:
646 @table @samp
647 @item none
649 @item variance
650 Variance AQ (complexity mask).
651 @item autovariance
652 Auto-variance AQ (experimental).
653 @end table
654 @item -aq-strength @var{float}
655 AQ strength, reduces blocking and blurring in flat and textured areas.
656 @item -psy @var{integer}
657 Use psychovisual optimizations.
658 @item -psy-rd @var{string}
659 Strength of psychovisual optimization, in <psy-rd>:<psy-trellis> format.
660 @item -rc-lookahead @var{integer}
661 Number of frames to look ahead for frametype and ratecontrol.
662 @item -weightb @var{integer}
663 Weighted prediction for B-frames.
664 @item -weightp @var{integer}
665 Weighted prediction analysis method.
667 Possible values:
668 @table @samp
669 @item none
671 @item simple
673 @item smart
675 @end table
676 @item -ssim @var{integer}
677 Calculate and print SSIM stats.
678 @item -intra-refresh @var{integer}
679 Use Periodic Intra Refresh instead of IDR frames.
680 @item -bluray-compat @var{integer}
681 Configure the encoder to be compatible with the bluray standard.
682 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
683 @item -b-bias @var{integer}
684 Influences how often B-frames are used.
685 @item -b-pyramid @var{integer}
686 Keep some B-frames as references.
688 Possible values:
689 @table @samp
690 @item none
692 @item strict
693 Strictly hierarchical pyramid.
694 @item normal
695 Non-strict (not Blu-ray compatible).
696 @end table
697 @item -mixed-refs @var{integer}
698 One reference per partition, as opposed to one reference per macroblock.
699 @item -8x8dct @var{integer}
700 High profile 8x8 transform.
701 @item -fast-pskip @var{integer}
702 @item -aud @var{integer}
703 Use access unit delimiters.
704 @item -mbtree @var{integer}
705 Use macroblock tree ratecontrol.
706 @item -deblock @var{string}
707 Loop filter parameters, in <alpha:beta> form.
708 @item -cplxblur @var{float}
709 Reduce fluctuations in QP (before curve compression).
710 @item -partitions @var{string}
711 A comma-separated list of partitions to consider, possible values: p8x8, p4x4, b8x8, i8x8, i4x4, none, all.
712 @item -direct-pred @var{integer}
713 Direct MV prediction mode
715 Possible values:
716 @table @samp
717 @item none
719 @item spatial
721 @item temporal
723 @item auto
725 @end table
726 @item -slice-max-size @var{integer}
727 Limit the size of each slice in bytes.
728 @item -stats @var{string}
729 Filename for 2 pass stats.
730 @item -nal-hrd @var{integer}
731 Signal HRD information (requires vbv-bufsize; cbr not allowed in .mp4).
733 Possible values:
734 @table @samp
735 @item none
737 @item vbr
739 @item cbr
741 @end table
742 @item -x264-params @var{string}
743 Override the x264 configuration using a :-separated list of key=value parameters.
744 @example
745 -x264-params level=30:bframes=0:weightp=0:cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:no-fast-pskip=1:subq=6:8x8dct=0:trellis=0
746 @end example
747 @end table
749 Encoding avpresets for common usages are provided so they can be used with the
750 general presets system (e.g. passing the @code{-pre} option).
752 @section ProRes
754 Apple ProRes encoder.
756 @subsection Private Options
758 @table @option
759 @item profile @var{integer}
760 Select the ProRes profile to encode
761 @table @samp
762 @item proxy
763 @item lt
764 @item standard
765 @item hq
766 @item 4444
767 @end table
769 @item quant_mat @var{integer}
770 Select quantization matrix.
771 @table @samp
772 @item auto
773 @item default
774 @item proxy
775 @item lt
776 @item standard
777 @item hq
778 @end table
779 If set to @var{auto}, the matrix matching the profile will be picked.
780 If not set, the matrix providing the highest quality, @var{default}, will be
781 picked.
783 @item bits_per_mb @var{integer}
784 How many bits to allot for coding one macroblock. Different profiles use
785 between 200 and 2400 bits per macroblock, the maximum is 8000.
787 @item mbs_per_slice @var{integer}
788 Number of macroblocks in each slice (1-8); the default value (8)
789 should be good in almost all situations.
791 @item vendor @var{string}
792 Override the 4-byte vendor ID.
793 A custom vendor ID like @var{apl0} would claim the stream was produced by
794 the Apple encoder.
796 @item alpha_bits @var{integer}
797 Specify number of bits for alpha component.
798 Possible values are @var{0}, @var{8} and @var{16}.
799 Use @var{0} to disable alpha plane coding.
801 @end table
803 @subsection Speed considerations
805 In the default mode of operation the encoder has to honor frame constraints
806 (i.e. not produce frames with a size larger than requested) while still making
807 the output picture as good as possible.
808 A frame containing a lot of small details is harder to compress and the encoder
809 would spend more time searching for appropriate quantizers for each slice.
811 Setting a higher @option{bits_per_mb} limit will improve the speed.
813 For the fastest encoding speed set the @option{qscale} parameter (4 is the
814 recommended value) and do not set a size constraint.
816 @section libkvazaar
818 Kvazaar H.265/HEVC encoder.
820 Requires the presence of the libkvazaar headers and library during
821 configuration. You need to explicitly configure the build with
822 @option{--enable-libkvazaar}.
824 @subsection Options
826 @table @option
828 @item b
829 Set target video bitrate in bit/s and enable rate control.
831 @item kvazaar-params
832 Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
833 by commas (,). See kvazaar documentation for a list of options.
835 @end table
837 @section QSV encoders
839 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
841 The ratecontrol method is selected as follows:
843 @itemize @bullet
844 @item
845 When @option{global_quality} is specified, a quality-based mode is used.
846 Specifically this means either
847 @itemize @minus
848 @item
849 @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
850 also set (the @option{-qscale} avconv option).
852 @item
853 @var{LA_ICQ} - intelligent constant quality with lookahead, when the
854 @option{la_depth} option is also set.
856 @item
857 @var{ICQ} -- intelligent constant quality otherwise.
858 @end itemize
860 @item
861 Otherwise, a bitrate-based mode is used. For all of those, you should specify at
862 least the desired average bitrate with the @option{b} option.
863 @itemize @minus
864 @item
865 @var{LA} - VBR with lookahead, when the @option{la_depth} option is specified.
867 @item
868 @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
870 @item
871 @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
872 the average bitrate.
874 @item
875 @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
876 than the average bitrate.
878 @item
879 @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
880 is further configured by the @option{avbr_accuracy} and
881 @option{avbr_convergence} options.
882 @end itemize
883 @end itemize
885 Note that depending on your system, a different mode than the one you specified
886 may be selected by the encoder. Set the verbosity level to @var{verbose} or
887 higher to see the actual settings used by the QSV runtime.
889 Additional libavcodec global options are mapped to MSDK options as follows:
891 @itemize
892 @item
893 @option{g/gop_size} -> @option{GopPicSize}
895 @item
896 @option{bf/max_b_frames}+1 -> @option{GopRefDist}
898 @item
899 @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
900 @option{InitialDelayInKB}
902 @item
903 @option{slices} -> @option{NumSlice}
905 @item
906 @option{refs} -> @option{NumRefFrame}
908 @item
909 @option{b_strategy/b_frame_strategy} -> @option{BRefType}
911 @item
912 @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
914 @item
915 For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
916 @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
917 and @var{QPP} and @var{QPB} respectively.
919 @item
920 Setting the @option{coder} option to the value @var{vlc} will make the H.264
921 encoder use CAVLC instead of CABAC.
923 @end itemize
925 @section VAAPI encoders
927 Wrappers for hardware encoders accessible via VAAPI.
929 These encoders only accept input in VAAPI hardware surfaces.  If you have input
930 in software frames, use the @option{hwupload} filter to upload them to the GPU.
932 The following standard libavcodec options are used:
933 @itemize
934 @item
935 @option{g} / @option{gop_size}
936 @item
937 @option{bf} / @option{max_b_frames}
938 @item
939 @option{profile}
940 @item
941 @option{level}
942 @item
943 @option{b} / @option{bit_rate}
944 @item
945 @option{maxrate} / @option{rc_max_rate}
946 @item
947 @option{bufsize} / @option{rc_buffer_size}
948 @item
949 @option{rc_init_occupancy} / @option{rc_initial_buffer_occupancy}
950 @item
951 @option{compression_level}
953 Speed / quality tradeoff: higher values are faster / worse quality.
954 @item
955 @option{q} / @option{global_quality}
957 Size / quality tradeoff: higher values are smaller / worse quality.
958 @item
959 @option{qmin}
960 (only: @option{qmax} is not supported)
961 @item
962 @option{i_qfactor} / @option{i_quant_factor}
963 @item
964 @option{i_qoffset} / @option{i_quant_offset}
965 @item
966 @option{b_qfactor} / @option{b_quant_factor}
967 @item
968 @option{b_qoffset} / @option{b_quant_offset}
969 @end itemize
971 @table @option
973 @item vaapi_h264
974 @option{profile} sets the value of @emph{profile_idc} and the @emph{constraint_set*_flag}s.
975 @option{level} sets the value of @emph{level_idc}.
977 @table @option
978 @item low_power
979 Use low-power encoding mode.
980 @end table
982 @item vaapi_hevc
983 @option{profile} and @option{level} set the values of
984 @emph{general_profile_idc} and @emph{general_level_idc} respectively.
986 @item vaapi_mjpeg
987 Always encodes using the standard quantisation and huffman tables -
988 @option{global_quality} scales the standard quantisation table (range 1-100).
990 @item vaapi_mpeg2
991 @option{profile} and @option{level} set the value of @emph{profile_and_level_indication}.
993 No rate control is supported.
995 @item vaapi_vp8
996 B-frames are not supported.
998 @option{global_quality} sets the @emph{q_idx} used for non-key frames (range 0-127).
1000 @table @option
1001 @item loop_filter_level
1002 @item loop_filter_sharpness
1003 Manually set the loop filter parameters.
1004 @end table
1006 @item vaapi_vp9
1007 @option{global_quality} sets the @emph{q_idx} used for P-frames (range 0-255).
1009 @table @option
1010 @item loop_filter_level
1011 @item loop_filter_sharpness
1012 Manually set the loop filter parameters.
1013 @end table
1015 B-frames are supported, but the output stream is always in encode order rather than display
1016 order.  If B-frames are enabled, it may be necessary to use the @option{vp9_raw_reorder}
1017 bitstream filter to modify the output stream to display frames in the correct order.
1019 Only normal frames are produced - the @option{vp9_superframe} bitstream filter may be
1020 required to produce a stream usable with all decoders.
1022 @end table
1024 @c man end VIDEO ENCODERS