4 Encoders are configured elements in Libav which allow the encoding of
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
22 @chapter Audio Encoders
23 @c man begin AUDIO ENCODERS
25 A description of some of the currently available audio encoders
28 @section ac3 and ac3_fixed
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{-acodec 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
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}
62 @subsubsection Metadata Control Options
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.
71 The metadata values set at initialization will be used for every frame in the
74 Metadata values can be changed before encoding each frame.
79 @subsubsection Downmix Levels
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:
92 Apply -4.5dB gain (default)
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:
106 Apply -6dB gain (default)
108 Silence Surround Channel(s)
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.
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.
136 Not Indicated (default)
147 @subsubsection Other Metadata Options
151 @item -copyright @var{boolean}
152 Copyright Indicator. Specifies whether a copyright exists for this audio.
156 No Copyright Exists (default)
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.
179 Not Indicated (default)
182 Not Dolby Surround Encoded
185 Dolby Surround Encoded
188 @item -original @var{boolean}
189 Original Bit Stream Indicator. Specifies whether this audio is from the
190 original source and not a copy.
197 Original Source (default)
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
212 @subsubsection Extended Bitstream Information - Part 1
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.
222 Not Indicated (default)
225 Lt/Rt Downmix Preferred
228 Lo/Ro Downmix Preferred
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.
246 Apply -4.5dB gain (default)
250 Silence Center Channel
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.
264 Apply -6.0dB gain (default)
266 Silence Surround Channel(s)
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.
284 Apply -4.5dB gain (default)
288 Silence Center Channel
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.
302 Apply -6.0dB gain (default)
304 Silence Surround Channel(s)
309 @subsubsection Extended Bitstream Information - Part 2
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.
320 Not Indicated (default)
323 Dolby Surround EX Off
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
337 Not Indicated (default)
346 @item -ad_conv_type @var{type}
347 A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
352 Standard A/D Converter (default)
360 @subsection Other AC-3 Encoding Options
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.
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.
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.
392 Selected by Encoder (default)
395 Disable Channel Coupling
398 Enable Channel Coupling
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.
410 Selected by Encoder (default)
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:
426 Fast mode - corresponding to the wavpack @option{-f} option.
429 Normal (default) settings.
432 High quality - corresponding to the wavpack @option{-h} option.
435 Very high quality - corresponding to the wavpack @option{-hh} option.
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
444 @c man end AUDIO ENCODERS
446 @chapter Video Encoders
447 @c man begin VIDEO ENCODERS
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
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.
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
495 Use the encoder default.
497 Digital picture, like portrait, inner shot
499 Outdoor photograph, with natural lighting
501 Hand or line drawing, with high-contrast details
503 Small-sized colorful images
509 Enable lumi masking adaptive quantization when set to 1. Default is 0
513 Enable variance adaptive quantization when set to 1. Default is 0
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
522 Set structural similarity (SSIM) displaying method. Possible values:
526 Disable displaying of SSIM information.
529 Output average SSIM at the end of encoding to stdout. The format of
530 showing the average SSIM is:
536 For users who are not familiar with C, %f means a float number, or
537 a decimal (e.g. 0.939232).
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
545 SSIM: avg: %1.3f min: %1.3f max: %1.3f
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).
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
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 { } { } { }
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.
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
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.
603 @tab Noise reduction.
604 @item me_range @tab merange
605 @tab Maximum range of the motion search in pixels.
606 @item me_method @tab me
607 @tab Full-pixel motion estimation method.
608 @item subq @tab subme
609 @tab Sub-pixel motion estimation method.
610 @item b_strategy @tab b-adapt
611 @tab Adaptive B-frame placement decision algorithm. Use only on first-pass.
612 @item keyint_min @tab min-keyint
613 @tab Minimum GOP size.
614 @item coder @tab cabac
615 @tab Set coder to @code{ac} to use CABAC.
616 @item cmp @tab chroma-me
617 @tab Set to @code{chroma} to use chroma motion estimation.
618 @item threads @tab threads
619 @tab Number of encoding threads.
620 @item thread_type @tab sliced_threads
621 @tab Set to @code{slice} to use sliced threading instead of frame threading.
622 @item flags -cgop @tab open-gop
623 @tab Set @code{-cgop} to use recovery points to close GOPs.
624 @item rc_init_occupancy @tab vbv-init
625 @tab Initial buffer occupancy.
628 @subsection Private Options
630 @item -preset @var{string}
631 Set the encoding preset (cf. x264 --fullhelp).
632 @item -tune @var{string}
633 Tune the encoding params (cf. x264 --fullhelp).
634 @item -profile @var{string}
635 Set profile restrictions (cf. x264 --fullhelp).
636 @item -fastfirstpass @var{integer}
637 Use fast settings when encoding first pass.
638 @item -crf @var{float}
639 Select the quality for constant quality mode.
640 @item -crf_max @var{float}
641 In CRF mode, prevents VBV from lowering quality beyond this point.
642 @item -qp @var{integer}
643 Constant quantization parameter rate control method.
644 @item -aq-mode @var{integer}
652 Variance AQ (complexity mask).
654 Auto-variance AQ (experimental).
656 @item -aq-strength @var{float}
657 AQ strength, reduces blocking and blurring in flat and textured areas.
658 @item -psy @var{integer}
659 Use psychovisual optimizations.
660 @item -psy-rd @var{string}
661 Strength of psychovisual optimization, in <psy-rd>:<psy-trellis> format.
662 @item -rc-lookahead @var{integer}
663 Number of frames to look ahead for frametype and ratecontrol.
664 @item -weightb @var{integer}
665 Weighted prediction for B-frames.
666 @item -weightp @var{integer}
667 Weighted prediction analysis method.
678 @item -ssim @var{integer}
679 Calculate and print SSIM stats.
680 @item -intra-refresh @var{integer}
681 Use Periodic Intra Refresh instead of IDR frames.
682 @item -bluray-compat @var{integer}
683 Configure the encoder to be compatible with the bluray standard.
684 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
685 @item -b-bias @var{integer}
686 Influences how often B-frames are used.
687 @item -b-pyramid @var{integer}
688 Keep some B-frames as references.
695 Strictly hierarchical pyramid.
697 Non-strict (not Blu-ray compatible).
699 @item -mixed-refs @var{integer}
700 One reference per partition, as opposed to one reference per macroblock.
701 @item -8x8dct @var{integer}
702 High profile 8x8 transform.
703 @item -fast-pskip @var{integer}
704 @item -aud @var{integer}
705 Use access unit delimiters.
706 @item -mbtree @var{integer}
707 Use macroblock tree ratecontrol.
708 @item -deblock @var{string}
709 Loop filter parameters, in <alpha:beta> form.
710 @item -cplxblur @var{float}
711 Reduce fluctuations in QP (before curve compression).
712 @item -partitions @var{string}
713 A comma-separated list of partitions to consider, possible values: p8x8, p4x4, b8x8, i8x8, i4x4, none, all.
714 @item -direct-pred @var{integer}
715 Direct MV prediction mode
728 @item -slice-max-size @var{integer}
729 Limit the size of each slice in bytes.
730 @item -stats @var{string}
731 Filename for 2 pass stats.
732 @item -nal-hrd @var{integer}
733 Signal HRD information (requires vbv-bufsize; cbr not allowed in .mp4).
744 @item -x264-params @var{string}
745 Override the x264 configuration using a :-separated list of key=value parameters.
747 -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
751 Encoding avpresets for common usages are provided so they can be used with the
752 general presets system (e.g. passing the @code{-pre} option).
756 Apple ProRes encoder.
758 @subsection Private Options
761 @item profile @var{integer}
762 Select the ProRes profile to encode
771 @item quant_mat @var{integer}
772 Select quantization matrix.
781 If set to @var{auto}, the matrix matching the profile will be picked.
782 If not set, the matrix providing the highest quality, @var{default}, will be
785 @item bits_per_mb @var{integer}
786 How many bits to allot for coding one macroblock. Different profiles use
787 between 200 and 2400 bits per macroblock, the maximum is 8000.
789 @item mbs_per_slice @var{integer}
790 Number of macroblocks in each slice (1-8); the default value (8)
791 should be good in almost all situations.
793 @item vendor @var{string}
794 Override the 4-byte vendor ID.
795 A custom vendor ID like @var{apl0} would claim the stream was produced by
798 @item alpha_bits @var{integer}
799 Specify number of bits for alpha component.
800 Possible values are @var{0}, @var{8} and @var{16}.
801 Use @var{0} to disable alpha plane coding.
805 @subsection Speed considerations
807 In the default mode of operation the encoder has to honor frame constraints
808 (i.e. not produc frames with size bigger than requested) while still making
809 output picture as good as possible.
810 A frame containing a lot of small details is harder to compress and the encoder
811 would spend more time searching for appropriate quantizers for each slice.
813 Setting a higher @option{bits_per_mb} limit will improve the speed.
815 For the fastest encoding speed set the @option{qscale} parameter (4 is the
816 recommended value) and do not set a size constraint.
818 @c man end VIDEO ENCODERS