avcodec/libvpxenc: add VP8 temporal scalability config options
[ffmpeg.git] / doc / encoders.texi
1 @chapter Encoders
2 @c man begin ENCODERS
3
4 Encoders are configured elements in FFmpeg which allow the encoding of
5 multimedia streams.
6
7 When you configure your FFmpeg 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}.
11
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}}.
16
17 The option @code{-encoders} of the ff* tools will display the list of
18 enabled encoders.
19
20 @c man end ENCODERS
21
22 @chapter Audio Encoders
23 @c man begin AUDIO ENCODERS
24
25 A description of some of the currently available audio encoders
26 follows.
27
28 @anchor{aacenc}
29 @section aac
30
31 Advanced Audio Coding (AAC) encoder.
32
33 This encoder is the default AAC encoder, natively implemented into FFmpeg. Its
34 quality is on par or better than libfdk_aac at the default bitrate of 128kbps.
35 This encoder also implements more options, profiles and samplerates than
36 other encoders (with only the AAC-HE profile pending to be implemented) so this
37 encoder has become the default and is the recommended choice.
38
39 @subsection Options
40
41 @table @option
42 @item b
43 Set bit rate in bits/s. Setting this automatically activates constant bit rate
44 (CBR) mode. If this option is unspecified it is set to 128kbps.
45
46 @item q
47 Set quality for variable bit rate (VBR) mode. This option is valid only using
48 the @command{ffmpeg} command-line tool. For library interface users, use
49 @option{global_quality}.
50
51 @item cutoff
52 Set cutoff frequency. If unspecified will allow the encoder to dynamically
53 adjust the cutoff to improve clarity on low bitrates.
54
55 @item aac_coder
56 Set AAC encoder coding method. Possible values:
57
58 @table @samp
59 @item twoloop
60 Two loop searching (TLS) method.
61
62 This method first sets quantizers depending on band thresholds and then tries
63 to find an optimal combination by adding or subtracting a specific value from
64 all quantizers and adjusting some individual quantizer a little.  Will tune
65 itself based on whether @option{aac_is}, @option{aac_ms} and @option{aac_pns}
66 are enabled.
67
68 @item anmr
69 Average noise to mask ratio (ANMR) trellis-based solution.
70
71 This is an experimental coder which currently produces a lower quality, is more
72 unstable and is slower than the default twoloop coder but has potential.
73 Currently has no support for the @option{aac_is} or @option{aac_pns} options.
74 Not currently recommended.
75
76 @item fast
77 Constant quantizer method.
78
79 Uses a cheaper version of twoloop algorithm that doesn't try to do as many
80 clever adjustments. Worse with low bitrates (less than 64kbps), but is better
81 and much faster at higher bitrates.
82 This is the default choice for a coder
83
84 @end table
85
86 @item aac_ms
87 Sets mid/side coding mode. The default value of "auto" will automatically use
88 M/S with bands which will benefit from such coding. Can be forced for all bands
89 using the value "enable", which is mainly useful for debugging or disabled using
90 "disable".
91
92 @item aac_is
93 Sets intensity stereo coding tool usage. By default, it's enabled and will
94 automatically toggle IS for similar pairs of stereo bands if it's beneficial.
95 Can be disabled for debugging by setting the value to "disable".
96
97 @item aac_pns
98 Uses perceptual noise substitution to replace low entropy high frequency bands
99 with imperceptible white noise during the decoding process. By default, it's
100 enabled, but can be disabled for debugging purposes by using "disable".
101
102 @item aac_tns
103 Enables the use of a multitap FIR filter which spans through the high frequency
104 bands to hide quantization noise during the encoding process and is reverted
105 by the decoder. As well as decreasing unpleasant artifacts in the high range
106 this also reduces the entropy in the high bands and allows for more bits to
107 be used by the mid-low bands. By default it's enabled but can be disabled for
108 debugging by setting the option to "disable".
109
110 @item aac_ltp
111 Enables the use of the long term prediction extension which increases coding
112 efficiency in very low bandwidth situations such as encoding of voice or
113 solo piano music by extending constant harmonic peaks in bands throughout
114 frames. This option is implied by profile:a aac_low and is incompatible with
115 aac_pred. Use in conjunction with @option{-ar} to decrease the samplerate.
116
117 @item aac_pred
118 Enables the use of a more traditional style of prediction where the spectral
119 coefficients transmitted are replaced by the difference of the current
120 coefficients minus the previous "predicted" coefficients. In theory and sometimes
121 in practice this can improve quality for low to mid bitrate audio.
122 This option implies the aac_main profile and is incompatible with aac_ltp.
123
124 @item profile
125 Sets the encoding profile, possible values:
126
127 @table @samp
128 @item aac_low
129 The default, AAC "Low-complexity" profile. Is the most compatible and produces
130 decent quality.
131
132 @item mpeg2_aac_low
133 Equivalent to @code{-profile:a aac_low -aac_pns 0}. PNS was introduced with the
134 MPEG4 specifications.
135
136 @item aac_ltp
137 Long term prediction profile, is enabled by and will enable the @option{aac_ltp}
138 option. Introduced in MPEG4.
139
140 @item aac_main
141 Main-type prediction profile, is enabled by and will enable the @option{aac_pred}
142 option. Introduced in MPEG2.
143
144 @end table
145 If this option is unspecified it is set to @samp{aac_low}.
146 @end table
147
148 @section ac3 and ac3_fixed
149
150 AC-3 audio encoders.
151
152 These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
153 the undocumented RealAudio 3 (a.k.a. dnet).
154
155 The @var{ac3} encoder uses floating-point math, while the @var{ac3_fixed}
156 encoder only uses fixed-point integer math. This does not mean that one is
157 always faster, just that one or the other may be better suited to a
158 particular system. The floating-point encoder will generally produce better
159 quality audio for a given bitrate. The @var{ac3_fixed} encoder is not the
160 default codec for any of the output formats, so it must be specified explicitly
161 using the option @code{-acodec ac3_fixed} in order to use it.
162
163 @subsection AC-3 Metadata
164
165 The AC-3 metadata options are used to set parameters that describe the audio,
166 but in most cases do not affect the audio encoding itself. Some of the options
167 do directly affect or influence the decoding and playback of the resulting
168 bitstream, while others are just for informational purposes. A few of the
169 options will add bits to the output stream that could otherwise be used for
170 audio data, and will thus affect the quality of the output. Those will be
171 indicated accordingly with a note in the option list below.
172
173 These parameters are described in detail in several publicly-available
174 documents.
175 @itemize
176 @item @uref{http://www.atsc.org/cms/standards/a_52-2010.pdf,A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard}
177 @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}
178 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf,Dolby Metadata Guide}
179 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf,Dolby Digital Professional Encoding Guidelines}
180 @end itemize
181
182 @subsubsection Metadata Control Options
183
184 @table @option
185
186 @item -per_frame_metadata @var{boolean}
187 Allow Per-Frame Metadata. Specifies if the encoder should check for changing
188 metadata for each frame.
189 @table @option
190 @item 0
191 The metadata values set at initialization will be used for every frame in the
192 stream. (default)
193 @item 1
194 Metadata values can be changed before encoding each frame.
195 @end table
196
197 @end table
198
199 @subsubsection Downmix Levels
200
201 @table @option
202
203 @item -center_mixlev @var{level}
204 Center Mix Level. The amount of gain the decoder should apply to the center
205 channel when downmixing to stereo. This field will only be written to the
206 bitstream if a center channel is present. The value is specified as a scale
207 factor. There are 3 valid values:
208 @table @option
209 @item 0.707
210 Apply -3dB gain
211 @item 0.595
212 Apply -4.5dB gain (default)
213 @item 0.500
214 Apply -6dB gain
215 @end table
216
217 @item -surround_mixlev @var{level}
218 Surround Mix Level. The amount of gain the decoder should apply to the surround
219 channel(s) when downmixing to stereo. This field will only be written to the
220 bitstream if one or more surround channels are present. The value is specified
221 as a scale factor.  There are 3 valid values:
222 @table @option
223 @item 0.707
224 Apply -3dB gain
225 @item 0.500
226 Apply -6dB gain (default)
227 @item 0.000
228 Silence Surround Channel(s)
229 @end table
230
231 @end table
232
233 @subsubsection Audio Production Information
234 Audio Production Information is optional information describing the mixing
235 environment.  Either none or both of the fields are written to the bitstream.
236
237 @table @option
238
239 @item -mixing_level @var{number}
240 Mixing Level. Specifies peak sound pressure level (SPL) in the production
241 environment when the mix was mastered. Valid values are 80 to 111, or -1 for
242 unknown or not indicated. The default value is -1, but that value cannot be
243 used if the Audio Production Information is written to the bitstream. Therefore,
244 if the @code{room_type} option is not the default value, the @code{mixing_level}
245 option must not be -1.
246
247 @item -room_type @var{type}
248 Room Type. Describes the equalization used during the final mixing session at
249 the studio or on the dubbing stage. A large room is a dubbing stage with the
250 industry standard X-curve equalization; a small room has flat equalization.
251 This field will not be written to the bitstream if both the @code{mixing_level}
252 option and the @code{room_type} option have the default values.
253 @table @option
254 @item 0
255 @itemx notindicated
256 Not Indicated (default)
257 @item 1
258 @itemx large
259 Large Room
260 @item 2
261 @itemx small
262 Small Room
263 @end table
264
265 @end table
266
267 @subsubsection Other Metadata Options
268
269 @table @option
270
271 @item -copyright @var{boolean}
272 Copyright Indicator. Specifies whether a copyright exists for this audio.
273 @table @option
274 @item 0
275 @itemx off
276 No Copyright Exists (default)
277 @item 1
278 @itemx on
279 Copyright Exists
280 @end table
281
282 @item -dialnorm @var{value}
283 Dialogue Normalization. Indicates how far the average dialogue level of the
284 program is below digital 100% full scale (0 dBFS). This parameter determines a
285 level shift during audio reproduction that sets the average volume of the
286 dialogue to a preset level. The goal is to match volume level between program
287 sources. A value of -31dB will result in no volume level change, relative to
288 the source volume, during audio reproduction. Valid values are whole numbers in
289 the range -31 to -1, with -31 being the default.
290
291 @item -dsur_mode @var{mode}
292 Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
293 (Pro Logic). This field will only be written to the bitstream if the audio
294 stream is stereo. Using this option does @b{NOT} mean the encoder will actually
295 apply Dolby Surround processing.
296 @table @option
297 @item 0
298 @itemx notindicated
299 Not Indicated (default)
300 @item 1
301 @itemx off
302 Not Dolby Surround Encoded
303 @item 2
304 @itemx on
305 Dolby Surround Encoded
306 @end table
307
308 @item -original @var{boolean}
309 Original Bit Stream Indicator. Specifies whether this audio is from the
310 original source and not a copy.
311 @table @option
312 @item 0
313 @itemx off
314 Not Original Source
315 @item 1
316 @itemx on
317 Original Source (default)
318 @end table
319
320 @end table
321
322 @subsection Extended Bitstream Information
323 The extended bitstream options are part of the Alternate Bit Stream Syntax as
324 specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
325 If any one parameter in a group is specified, all values in that group will be
326 written to the bitstream.  Default values are used for those that are written
327 but have not been specified.  If the mixing levels are written, the decoder
328 will use these values instead of the ones specified in the @code{center_mixlev}
329 and @code{surround_mixlev} options if it supports the Alternate Bit Stream
330 Syntax.
331
332 @subsubsection Extended Bitstream Information - Part 1
333
334 @table @option
335
336 @item -dmix_mode @var{mode}
337 Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
338 (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
339 @table @option
340 @item 0
341 @itemx notindicated
342 Not Indicated (default)
343 @item 1
344 @itemx ltrt
345 Lt/Rt Downmix Preferred
346 @item 2
347 @itemx loro
348 Lo/Ro Downmix Preferred
349 @end table
350
351 @item -ltrt_cmixlev @var{level}
352 Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
353 center channel when downmixing to stereo in Lt/Rt mode.
354 @table @option
355 @item 1.414
356 Apply +3dB gain
357 @item 1.189
358 Apply +1.5dB gain
359 @item 1.000
360 Apply 0dB gain
361 @item 0.841
362 Apply -1.5dB gain
363 @item 0.707
364 Apply -3.0dB gain
365 @item 0.595
366 Apply -4.5dB gain (default)
367 @item 0.500
368 Apply -6.0dB gain
369 @item 0.000
370 Silence Center Channel
371 @end table
372
373 @item -ltrt_surmixlev @var{level}
374 Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
375 surround channel(s) when downmixing to stereo in Lt/Rt mode.
376 @table @option
377 @item 0.841
378 Apply -1.5dB gain
379 @item 0.707
380 Apply -3.0dB gain
381 @item 0.595
382 Apply -4.5dB gain
383 @item 0.500
384 Apply -6.0dB gain (default)
385 @item 0.000
386 Silence Surround Channel(s)
387 @end table
388
389 @item -loro_cmixlev @var{level}
390 Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
391 center channel when downmixing to stereo in Lo/Ro mode.
392 @table @option
393 @item 1.414
394 Apply +3dB gain
395 @item 1.189
396 Apply +1.5dB gain
397 @item 1.000
398 Apply 0dB gain
399 @item 0.841
400 Apply -1.5dB gain
401 @item 0.707
402 Apply -3.0dB gain
403 @item 0.595
404 Apply -4.5dB gain (default)
405 @item 0.500
406 Apply -6.0dB gain
407 @item 0.000
408 Silence Center Channel
409 @end table
410
411 @item -loro_surmixlev @var{level}
412 Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
413 surround channel(s) when downmixing to stereo in Lo/Ro mode.
414 @table @option
415 @item 0.841
416 Apply -1.5dB gain
417 @item 0.707
418 Apply -3.0dB gain
419 @item 0.595
420 Apply -4.5dB gain
421 @item 0.500
422 Apply -6.0dB gain (default)
423 @item 0.000
424 Silence Surround Channel(s)
425 @end table
426
427 @end table
428
429 @subsubsection Extended Bitstream Information - Part 2
430
431 @table @option
432
433 @item -dsurex_mode @var{mode}
434 Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
435 (7.1 matrixed to 5.1). Using this option does @b{NOT} mean the encoder will actually
436 apply Dolby Surround EX processing.
437 @table @option
438 @item 0
439 @itemx notindicated
440 Not Indicated (default)
441 @item 1
442 @itemx on
443 Dolby Surround EX Off
444 @item 2
445 @itemx off
446 Dolby Surround EX On
447 @end table
448
449 @item -dheadphone_mode @var{mode}
450 Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
451 encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
452 option does @b{NOT} mean the encoder will actually apply Dolby Headphone
453 processing.
454 @table @option
455 @item 0
456 @itemx notindicated
457 Not Indicated (default)
458 @item 1
459 @itemx on
460 Dolby Headphone Off
461 @item 2
462 @itemx off
463 Dolby Headphone On
464 @end table
465
466 @item -ad_conv_type @var{type}
467 A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
468 conversion.
469 @table @option
470 @item 0
471 @itemx standard
472 Standard A/D Converter (default)
473 @item 1
474 @itemx hdcd
475 HDCD A/D Converter
476 @end table
477
478 @end table
479
480 @subsection Other AC-3 Encoding Options
481
482 @table @option
483
484 @item -stereo_rematrixing @var{boolean}
485 Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
486 is an optional AC-3 feature that increases quality by selectively encoding
487 the left/right channels as mid/side. This option is enabled by default, and it
488 is highly recommended that it be left as enabled except for testing purposes.
489
490 @item cutoff @var{frequency}
491 Set lowpass cutoff frequency. If unspecified, the encoder selects a default
492 determined by various other encoding parameters.
493
494 @end table
495
496 @subsection Floating-Point-Only AC-3 Encoding Options
497
498 These options are only valid for the floating-point encoder and do not exist
499 for the fixed-point encoder due to the corresponding features not being
500 implemented in fixed-point.
501
502 @table @option
503
504 @item -channel_coupling @var{boolean}
505 Enables/Disables use of channel coupling, which is an optional AC-3 feature
506 that increases quality by combining high frequency information from multiple
507 channels into a single channel. The per-channel high frequency information is
508 sent with less accuracy in both the frequency and time domains. This allows
509 more bits to be used for lower frequencies while preserving enough information
510 to reconstruct the high frequencies. This option is enabled by default for the
511 floating-point encoder and should generally be left as enabled except for
512 testing purposes or to increase encoding speed.
513 @table @option
514 @item -1
515 @itemx auto
516 Selected by Encoder (default)
517 @item 0
518 @itemx off
519 Disable Channel Coupling
520 @item 1
521 @itemx on
522 Enable Channel Coupling
523 @end table
524
525 @item -cpl_start_band @var{number}
526 Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
527 value higher than the bandwidth is used, it will be reduced to 1 less than the
528 coupling end band. If @var{auto} is used, the start band will be determined by
529 the encoder based on the bit rate, sample rate, and channel layout. This option
530 has no effect if channel coupling is disabled.
531 @table @option
532 @item -1
533 @itemx auto
534 Selected by Encoder (default)
535 @end table
536
537 @end table
538
539 @anchor{flac}
540 @section flac
541
542 FLAC (Free Lossless Audio Codec) Encoder
543
544 @subsection Options
545
546 The following options are supported by FFmpeg's flac encoder.
547
548 @table @option
549 @item compression_level
550 Sets the compression level, which chooses defaults for many other options
551 if they are not set explicitly. Valid values are from 0 to 12, 5 is the
552 default.
553
554 @item frame_size
555 Sets the size of the frames in samples per channel.
556
557 @item lpc_coeff_precision
558 Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the
559 default.
560
561 @item lpc_type
562 Sets the first stage LPC algorithm
563 @table @samp
564 @item none
565 LPC is not used
566
567 @item fixed
568 fixed LPC coefficients
569
570 @item levinson
571
572 @item cholesky
573 @end table
574
575 @item lpc_passes
576 Number of passes to use for Cholesky factorization during LPC analysis
577
578 @item min_partition_order
579 The minimum partition order
580
581 @item max_partition_order
582 The maximum partition order
583
584 @item prediction_order_method
585 @table @samp
586 @item estimation
587 @item 2level
588 @item 4level
589 @item 8level
590 @item search
591 Bruteforce search
592 @item log
593 @end table
594
595 @item ch_mode
596 Channel mode
597 @table @samp
598 @item auto
599 The mode is chosen automatically for each frame
600 @item indep
601 Channels are independently coded
602 @item left_side
603 @item right_side
604 @item mid_side
605 @end table
606
607 @item exact_rice_parameters
608 Chooses if rice parameters are calculated exactly or approximately.
609 if set to 1 then they are chosen exactly, which slows the code down slightly and
610 improves compression slightly.
611
612 @item multi_dim_quant
613 Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is
614 applied after the first stage to finetune the coefficients. This is quite slow
615 and slightly improves compression.
616
617 @end table
618
619 @anchor{opusenc}
620 @section opus
621
622 Opus encoder.
623
624 This is a native FFmpeg encoder for the Opus format. Currently its in development and
625 only implements the CELT part of the codec. Its quality is usually worse and at best
626 is equal to the libopus encoder.
627
628 @subsection Options
629
630 @table @option
631 @item b
632 Set bit rate in bits/s. If unspecified it uses the number of channels and the layout
633 to make a good guess.
634
635 @item opus_delay
636 Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly
637 decrease quality.
638 @end table
639
640 @anchor{libfdk-aac-enc}
641 @section libfdk_aac
642
643 libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
644
645 The libfdk-aac library is based on the Fraunhofer FDK AAC code from
646 the Android project.
647
648 Requires the presence of the libfdk-aac headers and library during
649 configuration. You need to explicitly configure the build with
650 @code{--enable-libfdk-aac}. The library is also incompatible with GPL,
651 so if you allow the use of GPL, you should configure with
652 @code{--enable-gpl --enable-nonfree --enable-libfdk-aac}.
653
654 This encoder is considered to produce output on par or worse at 128kbps to the
655 @ref{aacenc,,the native FFmpeg AAC encoder} but can often produce better
656 sounding audio at identical or lower bitrates and has support for the
657 AAC-HE profiles.
658
659 VBR encoding, enabled through the @option{vbr} or @option{flags
660 +qscale} options, is experimental and only works with some
661 combinations of parameters.
662
663 Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or
664 higher.
665
666 For more information see the fdk-aac project at
667 @url{http://sourceforge.net/p/opencore-amr/fdk-aac/}.
668
669 @subsection Options
670
671 The following options are mapped on the shared FFmpeg codec options.
672
673 @table @option
674 @item b
675 Set bit rate in bits/s. If the bitrate is not explicitly specified, it
676 is automatically set to a suitable value depending on the selected
677 profile.
678
679 In case VBR mode is enabled the option is ignored.
680
681 @item ar
682 Set audio sampling rate (in Hz).
683
684 @item channels
685 Set the number of audio channels.
686
687 @item flags +qscale
688 Enable fixed quality, VBR (Variable Bit Rate) mode.
689 Note that VBR is implicitly enabled when the @option{vbr} value is
690 positive.
691
692 @item cutoff
693 Set cutoff frequency. If not specified (or explicitly set to 0) it
694 will use a value automatically computed by the library. Default value
695 is 0.
696
697 @item profile
698 Set audio profile.
699
700 The following profiles are recognized:
701 @table @samp
702 @item aac_low
703 Low Complexity AAC (LC)
704
705 @item aac_he
706 High Efficiency AAC (HE-AAC)
707
708 @item aac_he_v2
709 High Efficiency AAC version 2 (HE-AACv2)
710
711 @item aac_ld
712 Low Delay AAC (LD)
713
714 @item aac_eld
715 Enhanced Low Delay AAC (ELD)
716 @end table
717
718 If not specified it is set to @samp{aac_low}.
719 @end table
720
721 The following are private options of the libfdk_aac encoder.
722
723 @table @option
724 @item afterburner
725 Enable afterburner feature if set to 1, disabled if set to 0. This
726 improves the quality but also the required processing power.
727
728 Default value is 1.
729
730 @item eld_sbr
731 Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
732 if set to 0.
733
734 Default value is 0.
735
736 @item signaling
737 Set SBR/PS signaling style.
738
739 It can assume one of the following values:
740 @table @samp
741 @item default
742 choose signaling implicitly (explicit hierarchical by default,
743 implicit if global header is disabled)
744
745 @item implicit
746 implicit backwards compatible signaling
747
748 @item explicit_sbr
749 explicit SBR, implicit PS signaling
750
751 @item explicit_hierarchical
752 explicit hierarchical signaling
753 @end table
754
755 Default value is @samp{default}.
756
757 @item latm
758 Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
759
760 Default value is 0.
761
762 @item header_period
763 Set StreamMuxConfig and PCE repetition period (in frames) for sending
764 in-band configuration buffers within LATM/LOAS transport layer.
765
766 Must be a 16-bits non-negative integer.
767
768 Default value is 0.
769
770 @item vbr
771 Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
772 good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
773 (Constant Bit Rate) is enabled.
774
775 Currently only the @samp{aac_low} profile supports VBR encoding.
776
777 VBR modes 1-5 correspond to roughly the following average bit rates:
778
779 @table @samp
780 @item 1
781 32 kbps/channel
782 @item 2
783 40 kbps/channel
784 @item 3
785 48-56 kbps/channel
786 @item 4
787 64 kbps/channel
788 @item 5
789 about 80-96 kbps/channel
790 @end table
791
792 Default value is 0.
793 @end table
794
795 @subsection Examples
796
797 @itemize
798 @item
799 Use @command{ffmpeg} to convert an audio file to VBR AAC in an M4A (MP4)
800 container:
801 @example
802 ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
803 @end example
804
805 @item
806 Use @command{ffmpeg} to convert an audio file to CBR 64k kbps AAC, using the
807 High-Efficiency AAC profile:
808 @example
809 ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
810 @end example
811 @end itemize
812
813 @anchor{libmp3lame}
814 @section libmp3lame
815
816 LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper.
817
818 Requires the presence of the libmp3lame headers and library during
819 configuration. You need to explicitly configure the build with
820 @code{--enable-libmp3lame}.
821
822 See @ref{libshine} for a fixed-point MP3 encoder, although with a
823 lower quality.
824
825 @subsection Options
826
827 The following options are supported by the libmp3lame wrapper. The
828 @command{lame}-equivalent of the options are listed in parentheses.
829
830 @table @option
831 @item b (@emph{-b})
832 Set bitrate expressed in bits/s for CBR or ABR. LAME @code{bitrate} is
833 expressed in kilobits/s.
834
835 @item q (@emph{-V})
836 Set constant quality setting for VBR. This option is valid only
837 using the @command{ffmpeg} command-line tool. For library interface
838 users, use @option{global_quality}.
839
840 @item compression_level (@emph{-q})
841 Set algorithm quality. Valid arguments are integers in the 0-9 range,
842 with 0 meaning highest quality but slowest, and 9 meaning fastest
843 while producing the worst quality.
844
845 @item cutoff (@emph{--lowpass})
846 Set lowpass cutoff frequency. If unspecified, the encoder dynamically
847 adjusts the cutoff.
848
849 @item reservoir
850 Enable use of bit reservoir when set to 1. Default value is 1. LAME
851 has this enabled by default, but can be overridden by use
852 @option{--nores} option.
853
854 @item joint_stereo (@emph{-m j})
855 Enable the encoder to use (on a frame by frame basis) either L/R
856 stereo or mid/side stereo. Default value is 1.
857
858 @item abr (@emph{--abr})
859 Enable the encoder to use ABR when set to 1. The @command{lame}
860 @option{--abr} sets the target bitrate, while this options only
861 tells FFmpeg to use ABR still relies on @option{b} to set bitrate.
862
863 @end table
864
865 @section libopencore-amrnb
866
867 OpenCORE Adaptive Multi-Rate Narrowband encoder.
868
869 Requires the presence of the libopencore-amrnb headers and library during
870 configuration. You need to explicitly configure the build with
871 @code{--enable-libopencore-amrnb --enable-version3}.
872
873 This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
874 but you can override it by setting @option{strict} to @samp{unofficial} or
875 lower.
876
877 @subsection Options
878
879 @table @option
880
881 @item b
882 Set bitrate in bits per second. Only the following bitrates are supported,
883 otherwise libavcodec will round to the nearest valid bitrate.
884
885 @table @option
886 @item 4750
887 @item 5150
888 @item 5900
889 @item 6700
890 @item 7400
891 @item 7950
892 @item 10200
893 @item 12200
894 @end table
895
896 @item dtx
897 Allow discontinuous transmission (generate comfort noise) when set to 1. The
898 default value is 0 (disabled).
899
900 @end table
901
902 @section libopus
903
904 libopus Opus Interactive Audio Codec encoder wrapper.
905
906 Requires the presence of the libopus headers and library during
907 configuration. You need to explicitly configure the build with
908 @code{--enable-libopus}.
909
910 @subsection Option Mapping
911
912 Most libopus options are modelled after the @command{opusenc} utility from
913 opus-tools. The following is an option mapping chart describing options
914 supported by the libopus wrapper, and their @command{opusenc}-equivalent
915 in parentheses.
916
917 @table @option
918
919 @item b (@emph{bitrate})
920 Set the bit rate in bits/s.  FFmpeg's @option{b} option is
921 expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
922 kilobits/s.
923
924 @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
925 Set VBR mode. The FFmpeg @option{vbr} option has the following
926 valid arguments, with the @command{opusenc} equivalent options
927 in parentheses:
928
929 @table @samp
930 @item off (@emph{hard-cbr})
931 Use constant bit rate encoding.
932
933 @item on (@emph{vbr})
934 Use variable bit rate encoding (the default).
935
936 @item constrained (@emph{cvbr})
937 Use constrained variable bit rate encoding.
938 @end table
939
940 @item compression_level (@emph{comp})
941 Set encoding algorithm complexity. Valid options are integers in
942 the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
943 gives the highest quality but slowest encoding. The default is 10.
944
945 @item frame_duration (@emph{framesize})
946 Set maximum frame size, or duration of a frame in milliseconds. The
947 argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
948 frame sizes achieve lower latency but less quality at a given bitrate.
949 Sizes greater than 20ms are only interesting at fairly low bitrates.
950 The default is 20ms.
951
952 @item packet_loss (@emph{expect-loss})
953 Set expected packet loss percentage. The default is 0.
954
955 @item application (N.A.)
956 Set intended application type. Valid options are listed below:
957
958 @table @samp
959 @item voip
960 Favor improved speech intelligibility.
961 @item audio
962 Favor faithfulness to the input (the default).
963 @item lowdelay
964 Restrict to only the lowest delay modes.
965 @end table
966
967 @item cutoff (N.A.)
968 Set cutoff bandwidth in Hz. The argument must be exactly one of the
969 following: 4000, 6000, 8000, 12000, or 20000, corresponding to
970 narrowband, mediumband, wideband, super wideband, and fullband
971 respectively. The default is 0 (cutoff disabled).
972
973 @item mapping_family (@emph{mapping_family})
974 Set channel mapping family to be used by the encoder. The default value of -1
975 uses mapping family 0 for mono and stereo inputs, and mapping family 1
976 otherwise. The default also disables the surround masking and LFE bandwidth
977 optimzations in libopus, and requires that the input contains 8 channels or
978 fewer.
979
980 Other values include 0 for mono and stereo, 1 for surround sound with masking
981 and LFE bandwidth optimizations, and 255 for independent streams with an
982 unspecified channel layout.
983
984 @item apply_phase_inv (N.A.) (requires libopus >= 1.2)
985 If set to 0, disables the use of phase inversion for intensity stereo,
986 improving the quality of mono downmixes, but slightly reducing normal stereo
987 quality. The default is 1 (phase inversion enabled).
988
989 @end table
990
991 @anchor{libshine}
992 @section libshine
993
994 Shine Fixed-Point MP3 encoder wrapper.
995
996 Shine is a fixed-point MP3 encoder. It has a far better performance on
997 platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
998 However, as it is more targeted on performance than quality, it is not on par
999 with LAME and other production-grade encoders quality-wise. Also, according to
1000 the project's homepage, this encoder may not be free of bugs as the code was
1001 written a long time ago and the project was dead for at least 5 years.
1002
1003 This encoder only supports stereo and mono input. This is also CBR-only.
1004
1005 The original project (last updated in early 2007) is at
1006 @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
1007 updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
1008
1009 Requires the presence of the libshine headers and library during
1010 configuration. You need to explicitly configure the build with
1011 @code{--enable-libshine}.
1012
1013 See also @ref{libmp3lame}.
1014
1015 @subsection Options
1016
1017 The following options are supported by the libshine wrapper. The
1018 @command{shineenc}-equivalent of the options are listed in parentheses.
1019
1020 @table @option
1021 @item b (@emph{-b})
1022 Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
1023 is expressed in kilobits/s.
1024
1025 @end table
1026
1027 @section libtwolame
1028
1029 TwoLAME MP2 encoder wrapper.
1030
1031 Requires the presence of the libtwolame headers and library during
1032 configuration. You need to explicitly configure the build with
1033 @code{--enable-libtwolame}.
1034
1035 @subsection Options
1036
1037 The following options are supported by the libtwolame wrapper. The
1038 @command{twolame}-equivalent options follow the FFmpeg ones and are in
1039 parentheses.
1040
1041 @table @option
1042 @item b (@emph{-b})
1043 Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
1044 option is expressed in kilobits/s. Default value is 128k.
1045
1046 @item q (@emph{-V})
1047 Set quality for experimental VBR support. Maximum value range is
1048 from -50 to 50, useful range is from -10 to 10. The higher the
1049 value, the better the quality. This option is valid only using the
1050 @command{ffmpeg} command-line tool. For library interface users,
1051 use @option{global_quality}.
1052
1053 @item mode (@emph{--mode})
1054 Set the mode of the resulting audio. Possible values:
1055
1056 @table @samp
1057 @item auto
1058 Choose mode automatically based on the input. This is the default.
1059 @item stereo
1060 Stereo
1061 @item joint_stereo
1062 Joint stereo
1063 @item dual_channel
1064 Dual channel
1065 @item mono
1066 Mono
1067 @end table
1068
1069 @item psymodel (@emph{--psyc-mode})
1070 Set psychoacoustic model to use in encoding. The argument must be
1071 an integer between -1 and 4, inclusive. The higher the value, the
1072 better the quality. The default value is 3.
1073
1074 @item energy_levels (@emph{--energy})
1075 Enable energy levels extensions when set to 1. The default value is
1076 0 (disabled).
1077
1078 @item error_protection (@emph{--protect})
1079 Enable CRC error protection when set to 1. The default value is 0
1080 (disabled).
1081
1082 @item copyright (@emph{--copyright})
1083 Set MPEG audio copyright flag when set to 1. The default value is 0
1084 (disabled).
1085
1086 @item original (@emph{--original})
1087 Set MPEG audio original flag when set to 1. The default value is 0
1088 (disabled).
1089
1090 @end table
1091
1092 @section libvo-amrwbenc
1093
1094 VisualOn Adaptive Multi-Rate Wideband encoder.
1095
1096 Requires the presence of the libvo-amrwbenc headers and library during
1097 configuration. You need to explicitly configure the build with
1098 @code{--enable-libvo-amrwbenc --enable-version3}.
1099
1100 This is a mono-only encoder. Officially it only supports 16000Hz sample
1101 rate, but you can override it by setting @option{strict} to
1102 @samp{unofficial} or lower.
1103
1104 @subsection Options
1105
1106 @table @option
1107
1108 @item b
1109 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
1110 libavcodec will round to the nearest valid bitrate.
1111
1112 @table @samp
1113 @item 6600
1114 @item 8850
1115 @item 12650
1116 @item 14250
1117 @item 15850
1118 @item 18250
1119 @item 19850
1120 @item 23050
1121 @item 23850
1122 @end table
1123
1124 @item dtx
1125 Allow discontinuous transmission (generate comfort noise) when set to 1. The
1126 default value is 0 (disabled).
1127
1128 @end table
1129
1130 @section libvorbis
1131
1132 libvorbis encoder wrapper.
1133
1134 Requires the presence of the libvorbisenc headers and library during
1135 configuration. You need to explicitly configure the build with
1136 @code{--enable-libvorbis}.
1137
1138 @subsection Options
1139
1140 The following options are supported by the libvorbis wrapper. The
1141 @command{oggenc}-equivalent of the options are listed in parentheses.
1142
1143 To get a more accurate and extensive documentation of the libvorbis
1144 options, consult the libvorbisenc's and @command{oggenc}'s documentations.
1145 See @url{http://xiph.org/vorbis/},
1146 @url{http://wiki.xiph.org/Vorbis-tools}, and oggenc(1).
1147
1148 @table @option
1149 @item b (@emph{-b})
1150 Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
1151 expressed in kilobits/s.
1152
1153 @item q (@emph{-q})
1154 Set constant quality setting for VBR. The value should be a float
1155 number in the range of -1.0 to 10.0. The higher the value, the better
1156 the quality. The default value is @samp{3.0}.
1157
1158 This option is valid only using the @command{ffmpeg} command-line tool.
1159 For library interface users, use @option{global_quality}.
1160
1161 @item cutoff (@emph{--advanced-encode-option lowpass_frequency=N})
1162 Set cutoff bandwidth in Hz, a value of 0 disables cutoff. @command{oggenc}'s
1163 related option is expressed in kHz. The default value is @samp{0} (cutoff
1164 disabled).
1165
1166 @item minrate (@emph{-m})
1167 Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
1168 expressed in kilobits/s.
1169
1170 @item maxrate (@emph{-M})
1171 Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
1172 expressed in kilobits/s. This only has effect on ABR mode.
1173
1174 @item iblock (@emph{--advanced-encode-option impulse_noisetune=N})
1175 Set noise floor bias for impulse blocks. The value is a float number from
1176 -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
1177 to the crispness of transients in the encoded audio. The tradeoff for better
1178 transient response is a higher bitrate.
1179
1180 @end table
1181
1182 @anchor{libwavpack}
1183 @section libwavpack
1184
1185 A wrapper providing WavPack encoding through libwavpack.
1186
1187 Only lossless mode using 32-bit integer samples is supported currently.
1188
1189 Requires the presence of the libwavpack headers and library during
1190 configuration. You need to explicitly configure the build with
1191 @code{--enable-libwavpack}.
1192
1193 Note that a libavcodec-native encoder for the WavPack codec exists so users can
1194 encode audios with this codec without using this encoder. See @ref{wavpackenc}.
1195
1196 @subsection Options
1197
1198 @command{wavpack} command line utility's corresponding options are listed in
1199 parentheses, if any.
1200
1201 @table @option
1202 @item frame_size (@emph{--blocksize})
1203 Default is 32768.
1204
1205 @item compression_level
1206 Set speed vs. compression tradeoff. Acceptable arguments are listed below:
1207
1208 @table @samp
1209 @item 0 (@emph{-f})
1210 Fast mode.
1211
1212 @item 1
1213 Normal (default) settings.
1214
1215 @item 2 (@emph{-h})
1216 High quality.
1217
1218 @item 3 (@emph{-hh})
1219 Very high quality.
1220
1221 @item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
1222 Same as @samp{3}, but with extra processing enabled.
1223
1224 @samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
1225
1226 @end table
1227 @end table
1228
1229 @anchor{mjpegenc}
1230 @section mjpeg
1231
1232 Motion JPEG encoder.
1233
1234 @subsection Options
1235
1236 @table @option
1237 @item huffman
1238 Set the huffman encoding strategy. Possible values:
1239
1240 @table @samp
1241 @item default
1242 Use the default huffman tables. This is the default strategy.
1243
1244 @item optimal
1245 Compute and use optimal huffman tables.
1246
1247 @end table
1248 @end table
1249
1250 @anchor{wavpackenc}
1251 @section wavpack
1252
1253 WavPack lossless audio encoder.
1254
1255 This is a libavcodec-native WavPack encoder. There is also an encoder based on
1256 libwavpack, but there is virtually no reason to use that encoder.
1257
1258 See also @ref{libwavpack}.
1259
1260 @subsection Options
1261
1262 The equivalent options for @command{wavpack} command line utility are listed in
1263 parentheses.
1264
1265 @subsubsection Shared options
1266
1267 The following shared options are effective for this encoder. Only special notes
1268 about this particular encoder will be documented here. For the general meaning
1269 of the options, see @ref{codec-options,,the Codec Options chapter}.
1270
1271 @table @option
1272 @item frame_size (@emph{--blocksize})
1273 For this encoder, the range for this option is between 128 and 131072. Default
1274 is automatically decided based on sample rate and number of channel.
1275
1276 For the complete formula of calculating default, see
1277 @file{libavcodec/wavpackenc.c}.
1278
1279 @item compression_level (@emph{-f}, @emph{-h}, @emph{-hh}, and @emph{-x})
1280 This option's syntax is consistent with @ref{libwavpack}'s.
1281 @end table
1282
1283 @subsubsection Private options
1284
1285 @table @option
1286 @item joint_stereo (@emph{-j})
1287 Set whether to enable joint stereo. Valid values are:
1288
1289 @table @samp
1290 @item on (@emph{1})
1291 Force mid/side audio encoding.
1292 @item off (@emph{0})
1293 Force left/right audio encoding.
1294 @item auto
1295 Let the encoder decide automatically.
1296 @end table
1297
1298 @item optimize_mono
1299 Set whether to enable optimization for mono. This option is only effective for
1300 non-mono streams. Available values:
1301
1302 @table @samp
1303 @item on
1304 enabled
1305 @item off
1306 disabled
1307 @end table
1308
1309 @end table
1310
1311 @c man end AUDIO ENCODERS
1312
1313 @chapter Video Encoders
1314 @c man begin VIDEO ENCODERS
1315
1316 A description of some of the currently available video encoders
1317 follows.
1318
1319 @section Hap
1320
1321 Vidvox Hap video encoder.
1322
1323 @subsection Options
1324
1325 @table @option
1326 @item format @var{integer}
1327 Specifies the Hap format to encode.
1328
1329 @table @option
1330 @item hap
1331 @item hap_alpha
1332 @item hap_q
1333 @end table
1334
1335 Default value is @option{hap}.
1336
1337 @item chunks @var{integer}
1338 Specifies the number of chunks to split frames into, between 1 and 64. This
1339 permits multithreaded decoding of large frames, potentially at the cost of
1340 data-rate. The encoder may modify this value to divide frames evenly.
1341
1342 Default value is @var{1}.
1343
1344 @item compressor @var{integer}
1345 Specifies the second-stage compressor to use. If set to @option{none},
1346 @option{chunks} will be limited to 1, as chunked uncompressed frames offer no
1347 benefit.
1348
1349 @table @option
1350 @item none
1351 @item snappy
1352 @end table
1353
1354 Default value is @option{snappy}.
1355
1356 @end table
1357
1358 @section jpeg2000
1359
1360 The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
1361 option can be used to set the encoding quality. Lossless encoding
1362 can be selected with @code{-pred 1}.
1363
1364 @subsection Options
1365
1366 @table @option
1367 @item format
1368 Can be set to either @code{j2k} or @code{jp2} (the default) that
1369 makes it possible to store non-rgb pix_fmts.
1370
1371 @end table
1372
1373 @section libaom-av1
1374
1375 libaom AV1 encoder wrapper.
1376
1377 Requires the presence of the libaom headers and library during
1378 configuration.  You need to explicitly configure the build with
1379 @code{--enable-libaom}.
1380
1381 @subsection Options
1382
1383 The wrapper supports the following standard libavcodec options:
1384
1385 @table @option
1386
1387 @item b
1388 Set bitrate target in bits/second.  By default this will use
1389 variable-bitrate mode.  If @option{maxrate} and @option{minrate} are
1390 also set to the same value then it will use constant-bitrate mode,
1391 otherwise if @option{crf} is set as well then it will use
1392 constrained-quality mode.
1393
1394 @item g keyint_min
1395 Set key frame placement.  The GOP size sets the maximum distance between
1396 key frames; if zero the output stream will be intra-only.  The minimum
1397 distance is ignored unless it is the same as the GOP size, in which case
1398 key frames will always appear at a fixed interval.  Not set by default,
1399 so without this option the library has completely free choice about
1400 where to place key frames.
1401
1402 @item qmin qmax
1403 Set minimum/maximum quantisation values.  Valid range is from 0 to 63
1404 (warning: this does not match the quantiser values actually used by AV1
1405 - divide by four to map real quantiser values to this range).  Defaults
1406 to min/max (no constraint).
1407
1408 @item minrate maxrate bufsize rc_init_occupancy
1409 Set rate control buffering parameters.  Not used if not set - defaults
1410 to unconstrained variable bitrate.
1411
1412 @item threads
1413 Set the number of threads to use while encoding.  This may require the
1414 @option{tiles} option to also be set to actually use the specified
1415 number of threads fully.  Defaults to the number of hardware threads
1416 supported by the host machine.
1417
1418 @item profile
1419 Set the encoding profile.  Defaults to using the profile which matches
1420 the bit depth and chroma subsampling of the input.
1421
1422 @end table
1423
1424 The wrapper also has some specific options:
1425
1426 @table @option
1427
1428 @item cpu-used
1429 Set the quality/encoding speed tradeoff.  Valid range is from 0 to 8,
1430 higher numbers indicating greater speed and lower quality.  The default
1431 value is 1, which will be slow and high quality.
1432
1433 @item auto-alt-ref
1434 Enable use of alternate reference frames.  Defaults to the internal
1435 default of the library.
1436
1437 @item lag-in-frames
1438 Set the maximum number of frames which the encoder may keep in flight
1439 at any one time for lookahead purposes.  Defaults to the internal
1440 default of the library.
1441
1442 @item error-resilience
1443 Enable error resilience features:
1444 @table @option
1445 @item default
1446 Improve resilience against losses of whole frames.
1447 @end table
1448 Not enabled by default.
1449
1450 @item crf
1451 Set the quality/size tradeoff for constant-quality (no bitrate target)
1452 and constrained-quality (with maximum bitrate target) modes. Valid
1453 range is 0 to 63, higher numbers indicating lower quality and smaller
1454 output size.  Only used if set; by default only the bitrate target is
1455 used.
1456
1457 @item static-thresh
1458 Set a change threshold on blocks below which they will be skipped by
1459 the encoder.  Defined in arbitrary units as a nonnegative integer,
1460 defaulting to zero (no blocks are skipped).
1461
1462 @item drop-threshold
1463 Set a threshold for dropping frames when close to rate control bounds.
1464 Defined as a percentage of the target buffer - when the rate control
1465 buffer falls below this percentage, frames will be dropped until it
1466 has refilled above the threshold.  Defaults to zero (no frames are
1467 dropped).
1468
1469 @item tiles
1470 Set the number of tiles to encode the input video with, as colums x
1471 rows.  Larger numbers allow greater parallelism in both encoding and
1472 decoding, but may decrease coding efficiency.  Defaults to the minimum
1473 number of tiles required by the size of the input video (this is 1x1
1474 (that is, a single tile) for sizes up to and including 4K).
1475
1476 @item tile-columns tile-rows
1477 Set the number of tiles as log2 of the number of tile rows and columns.
1478 Provided for compatibility with libvpx/VP9.
1479
1480 @end table
1481
1482 @section libkvazaar
1483
1484 Kvazaar H.265/HEVC encoder.
1485
1486 Requires the presence of the libkvazaar headers and library during
1487 configuration. You need to explicitly configure the build with
1488 @option{--enable-libkvazaar}.
1489
1490 @subsection Options
1491
1492 @table @option
1493
1494 @item b
1495 Set target video bitrate in bit/s and enable rate control.
1496
1497 @item kvazaar-params
1498 Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
1499 by commas (,). See kvazaar documentation for a list of options.
1500
1501 @end table
1502
1503 @section libopenh264
1504
1505 Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
1506
1507 This encoder requires the presence of the libopenh264 headers and
1508 library during configuration. You need to explicitly configure the
1509 build with @code{--enable-libopenh264}. The library is detected using
1510 @command{pkg-config}.
1511
1512 For more information about the library see
1513 @url{http://www.openh264.org}.
1514
1515 @subsection Options
1516
1517 The following FFmpeg global options affect the configurations of the
1518 libopenh264 encoder.
1519
1520 @table @option
1521 @item b
1522 Set the bitrate (as a number of bits per second).
1523
1524 @item g
1525 Set the GOP size.
1526
1527 @item maxrate
1528 Set the max bitrate (as a number of bits per second).
1529
1530 @item flags +global_header
1531 Set global header in the bitstream.
1532
1533 @item slices
1534 Set the number of slices, used in parallelized encoding. Default value
1535 is 0. This is only used when @option{slice_mode} is set to
1536 @samp{fixed}.
1537
1538 @item slice_mode
1539 Set slice mode. Can assume one of the following possible values:
1540
1541 @table @samp
1542 @item fixed
1543 a fixed number of slices
1544 @item rowmb
1545 one slice per row of macroblocks
1546 @item auto
1547 automatic number of slices according to number of threads
1548 @item dyn
1549 dynamic slicing
1550 @end table
1551
1552 Default value is @samp{auto}.
1553
1554 @item loopfilter
1555 Enable loop filter, if set to 1 (automatically enabled). To disable
1556 set a value of 0.
1557
1558 @item profile
1559 Set profile restrictions. If set to the value of @samp{main} enable
1560 CABAC (set the @code{SEncParamExt.iEntropyCodingModeFlag} flag to 1).
1561
1562 @item max_nal_size
1563 Set maximum NAL size in bytes.
1564
1565 @item allow_skip_frames
1566 Allow skipping frames to hit the target bitrate if set to 1.
1567 @end table
1568
1569 @section libtheora
1570
1571 libtheora Theora encoder wrapper.
1572
1573 Requires the presence of the libtheora headers and library during
1574 configuration. You need to explicitly configure the build with
1575 @code{--enable-libtheora}.
1576
1577 For more information about the libtheora project see
1578 @url{http://www.theora.org/}.
1579
1580 @subsection Options
1581
1582 The following global options are mapped to internal libtheora options
1583 which affect the quality and the bitrate of the encoded stream.
1584
1585 @table @option
1586 @item b
1587 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1588 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1589
1590 @item flags
1591 Used to enable constant quality mode (VBR) encoding through the
1592 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1593 modes.
1594
1595 @item g
1596 Set the GOP size.
1597
1598 @item global_quality
1599 Set the global quality as an integer in lambda units.
1600
1601 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1602 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1603 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1604 value in the native libtheora range [0-63]. A higher value corresponds
1605 to a higher quality.
1606
1607 @item q
1608 Enable VBR mode when set to a non-negative value, and set constant
1609 quality value as a double floating point value in QP units.
1610
1611 The value is clipped in the [0-10] range, and then multiplied by 6.3
1612 to get a value in the native libtheora range [0-63].
1613
1614 This option is valid only using the @command{ffmpeg} command-line
1615 tool. For library interface users, use @option{global_quality}.
1616 @end table
1617
1618 @subsection Examples
1619
1620 @itemize
1621 @item
1622 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1623 @example
1624 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1625 @end example
1626
1627 @item
1628 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1629 @example
1630 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1631 @end example
1632 @end itemize
1633
1634 @section libvpx
1635
1636 VP8/VP9 format supported through libvpx.
1637
1638 Requires the presence of the libvpx headers and library during configuration.
1639 You need to explicitly configure the build with @code{--enable-libvpx}.
1640
1641 @subsection Options
1642
1643 The following options are supported by the libvpx wrapper. The
1644 @command{vpxenc}-equivalent options or values are listed in parentheses
1645 for easy migration.
1646
1647 To reduce the duplication of documentation, only the private options
1648 and some others requiring special attention are documented here. For
1649 the documentation of the undocumented generic options, see
1650 @ref{codec-options,,the Codec Options chapter}.
1651
1652 To get more documentation of the libvpx options, invoke the command
1653 @command{ffmpeg -h encoder=libvpx}, @command{ffmpeg -h encoder=libvpx-vp9} or
1654 @command{vpxenc --help}. Further information is available in the libvpx API
1655 documentation.
1656
1657 @table @option
1658
1659 @item b (@emph{target-bitrate})
1660 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1661 expressed in bits/s, while @command{vpxenc}'s @option{target-bitrate} is in
1662 kilobits/s.
1663
1664 @item g (@emph{kf-max-dist})
1665
1666 @item keyint_min (@emph{kf-min-dist})
1667
1668 @item qmin (@emph{min-q})
1669
1670 @item qmax (@emph{max-q})
1671
1672 @item bufsize (@emph{buf-sz}, @emph{buf-optimal-sz})
1673 Set ratecontrol buffer size (in bits). Note @command{vpxenc}'s options are
1674 specified in milliseconds, the libvpx wrapper converts this value as follows:
1675 @code{buf-sz = bufsize * 1000 / bitrate},
1676 @code{buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6}.
1677
1678 @item rc_init_occupancy (@emph{buf-initial-sz})
1679 Set number of bits which should be loaded into the rc buffer before decoding
1680 starts. Note @command{vpxenc}'s option is specified in milliseconds, the libvpx
1681 wrapper converts this value as follows:
1682 @code{rc_init_occupancy * 1000 / bitrate}.
1683
1684 @item undershoot-pct
1685 Set datarate undershoot (min) percentage of the target bitrate.
1686
1687 @item overshoot-pct
1688 Set datarate overshoot (max) percentage of the target bitrate.
1689
1690 @item skip_threshold (@emph{drop-frame})
1691
1692 @item qcomp (@emph{bias-pct})
1693
1694 @item maxrate (@emph{maxsection-pct})
1695 Set GOP max bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1696 percentage of the target bitrate, the libvpx wrapper converts this value as
1697 follows: @code{(maxrate * 100 / bitrate)}.
1698
1699 @item minrate (@emph{minsection-pct})
1700 Set GOP min bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1701 percentage of the target bitrate, the libvpx wrapper converts this value as
1702 follows: @code{(minrate * 100 / bitrate)}.
1703
1704 @item minrate, maxrate, b @emph{end-usage=cbr}
1705 @code{(minrate == maxrate == bitrate)}.
1706
1707 @item crf (@emph{end-usage=cq}, @emph{cq-level})
1708
1709 @item tune (@emph{tune})
1710 @table @samp
1711 @item psnr (@emph{psnr})
1712 @item ssim (@emph{ssim})
1713 @end table
1714
1715 @item quality, deadline (@emph{deadline})
1716 @table @samp
1717 @item best
1718 Use best quality deadline. Poorly named and quite slow, this option should be
1719 avoided as it may give worse quality output than good.
1720 @item good
1721 Use good quality deadline. This is a good trade-off between speed and quality
1722 when used with the @option{cpu-used} option.
1723 @item realtime
1724 Use realtime quality deadline.
1725 @end table
1726
1727 @item speed, cpu-used (@emph{cpu-used})
1728 Set quality/speed ratio modifier. Higher values speed up the encode at the cost
1729 of quality.
1730
1731 @item nr (@emph{noise-sensitivity})
1732
1733 @item static-thresh
1734 Set a change threshold on blocks below which they will be skipped by the
1735 encoder.
1736
1737 @item slices (@emph{token-parts})
1738 Note that FFmpeg's @option{slices} option gives the total number of partitions,
1739 while @command{vpxenc}'s @option{token-parts} is given as
1740 @code{log2(partitions)}.
1741
1742 @item max-intra-rate
1743 Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
1744 means unlimited.
1745
1746 @item force_key_frames
1747 @code{VPX_EFLAG_FORCE_KF}
1748
1749 @item Alternate reference frame related
1750 @table @option
1751 @item auto-alt-ref
1752 Enable use of alternate reference frames (2-pass only).
1753 Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
1754 @item arnr-max-frames
1755 Set altref noise reduction max frame count.
1756 @item arnr-type
1757 Set altref noise reduction filter type: backward, forward, centered.
1758 @item arnr-strength
1759 Set altref noise reduction filter strength.
1760 @item rc-lookahead, lag-in-frames (@emph{lag-in-frames})
1761 Set number of frames to look ahead for frametype and ratecontrol.
1762 @end table
1763
1764 @item error-resilient
1765 Enable error resiliency features.
1766
1767 @item VP8-specific options
1768 @table @option
1769 @item ts-parameters
1770 Sets the temporal scalability configuration using a :-separated list of
1771 key=value pairs. For example, to specify temporal scalability parameters
1772 with @code{ffmpeg}:
1773 @example
1774 ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
1775 ts_target_bitrate=250000,500000,1000000:ts_rate_decimator=4,2,1:\
1776 ts_periodicity=4:ts_layer_id=0,2,1,2 OUTPUT
1777 @end example
1778 Below is a brief explanation of each of the parameters, please
1779 refer to @code{struct vpx_codec_enc_cfg} in @code{vpx/vpx_encoder.h} for more
1780 details.
1781 @table @option
1782 @item ts_number_layers
1783 Number of temporal coding layers.
1784 @item ts_target_bitrate
1785 Target bitrate for each temporal layer.
1786 @item ts_rate_decimator
1787 Frame rate decimation factor for each temporal layer.
1788 @item ts_periodicity
1789 Length of the sequence defining frame temporal layer membership.
1790 @item ts_layer_id
1791 Template defining the membership of frames to temporal layers.
1792 @end table
1793 @end table
1794
1795 @item VP9-specific options
1796 @table @option
1797 @item lossless
1798 Enable lossless mode.
1799 @item tile-columns
1800 Set number of tile columns to use. Note this is given as
1801 @code{log2(tile_columns)}. For example, 8 tile columns would be requested by
1802 setting the @option{tile-columns} option to 3.
1803 @item tile-rows
1804 Set number of tile rows to use. Note this is given as @code{log2(tile_rows)}.
1805 For example, 4 tile rows would be requested by setting the @option{tile-rows}
1806 option to 2.
1807 @item frame-parallel
1808 Enable frame parallel decodability features.
1809 @item aq-mode
1810 Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
1811 cyclic refresh, 4: equator360).
1812 @item colorspace @emph{color-space}
1813 Set input color space. The VP9 bitstream supports signaling the following
1814 colorspaces:
1815 @table @option
1816 @item @samp{rgb} @emph{sRGB}
1817 @item @samp{bt709} @emph{bt709}
1818 @item @samp{unspecified} @emph{unknown}
1819 @item @samp{bt470bg} @emph{bt601}
1820 @item @samp{smpte170m} @emph{smpte170}
1821 @item @samp{smpte240m} @emph{smpte240}
1822 @item @samp{bt2020_ncl} @emph{bt2020}
1823 @end table
1824 @item row-mt @var{boolean}
1825 Enable row based multi-threading.
1826 @item tune-content
1827 Set content type: default (0), screen (1), film (2).
1828 @item corpus-complexity
1829 Corpus VBR mode is a variant of standard VBR where the complexity distribution
1830 midpoint is passed in rather than calculated for a specific clip or chunk.
1831
1832 The valid range is [0, 10000]. 0 (default) uses standard VBR.
1833 @item enable-tpl @var{boolean}
1834 Enable temporal dependency model.
1835 @end table
1836
1837 @end table
1838
1839 For more information about libvpx see:
1840 @url{http://www.webmproject.org/}
1841
1842 @section libwebp
1843
1844 libwebp WebP Image encoder wrapper
1845
1846 libwebp is Google's official encoder for WebP images. It can encode in either
1847 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
1848 frame. Lossless images are a separate codec developed by Google.
1849
1850 @subsection Pixel Format
1851
1852 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
1853 to limitations of the format and libwebp. Alpha is supported for either mode.
1854 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
1855 passed in for encoding lossless, the pixel format will automatically be
1856 converted using functions from libwebp. This is not ideal and is done only for
1857 convenience.
1858
1859 @subsection Options
1860
1861 @table @option
1862
1863 @item -lossless @var{boolean}
1864 Enables/Disables use of lossless mode. Default is 0.
1865
1866 @item -compression_level @var{integer}
1867 For lossy, this is a quality/speed tradeoff. Higher values give better quality
1868 for a given size at the cost of increased encoding time. For lossless, this is
1869 a size/speed tradeoff. Higher values give smaller size at the cost of increased
1870 encoding time. More specifically, it controls the number of extra algorithms
1871 and compression tools used, and varies the combination of these tools. This
1872 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
1873 Default is 4.
1874
1875 @item -qscale @var{float}
1876 For lossy encoding, this controls image quality, 0 to 100. For lossless
1877 encoding, this controls the effort and time spent at compressing more. The
1878 default value is 75. Note that for usage via libavcodec, this option is called
1879 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
1880
1881 @item -preset @var{type}
1882 Configuration preset. This does some automatic settings based on the general
1883 type of the image.
1884 @table @option
1885 @item none
1886 Do not use a preset.
1887 @item default
1888 Use the encoder default.
1889 @item picture
1890 Digital picture, like portrait, inner shot
1891 @item photo
1892 Outdoor photograph, with natural lighting
1893 @item drawing
1894 Hand or line drawing, with high-contrast details
1895 @item icon
1896 Small-sized colorful images
1897 @item text
1898 Text-like
1899 @end table
1900
1901 @end table
1902
1903 @section libx264, libx264rgb
1904
1905 x264 H.264/MPEG-4 AVC encoder wrapper.
1906
1907 This encoder requires the presence of the libx264 headers and library
1908 during configuration. You need to explicitly configure the build with
1909 @code{--enable-libx264}.
1910
1911 libx264 supports an impressive number of features, including 8x8 and
1912 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
1913 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
1914 for detail retention (adaptive quantization, psy-RD, psy-trellis).
1915
1916 Many libx264 encoder options are mapped to FFmpeg global codec
1917 options, while unique encoder options are provided through private
1918 options. Additionally the @option{x264opts} and @option{x264-params}
1919 private options allows one to pass a list of key=value tuples as accepted
1920 by the libx264 @code{x264_param_parse} function.
1921
1922 The x264 project website is at
1923 @url{http://www.videolan.org/developers/x264.html}.
1924
1925 The libx264rgb encoder is the same as libx264, except it accepts packed RGB
1926 pixel formats as input instead of YUV.
1927
1928 @subsection Supported Pixel Formats
1929
1930 x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
1931 x264's configure time. FFmpeg only supports one bit depth in one particular
1932 build. In other words, it is not possible to build one FFmpeg with multiple
1933 versions of x264 with different bit depths.
1934
1935 @subsection Options
1936
1937 The following options are supported by the libx264 wrapper. The
1938 @command{x264}-equivalent options or values are listed in parentheses
1939 for easy migration.
1940
1941 To reduce the duplication of documentation, only the private options
1942 and some others requiring special attention are documented here. For
1943 the documentation of the undocumented generic options, see
1944 @ref{codec-options,,the Codec Options chapter}.
1945
1946 To get a more accurate and extensive documentation of the libx264
1947 options, invoke the command @command{x264 --fullhelp} or consult
1948 the libx264 documentation.
1949
1950 @table @option
1951 @item b (@emph{bitrate})
1952 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1953 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
1954 kilobits/s.
1955
1956 @item bf (@emph{bframes})
1957
1958 @item g (@emph{keyint})
1959
1960 @item qmin (@emph{qpmin})
1961 Minimum quantizer scale.
1962
1963 @item qmax (@emph{qpmax})
1964 Maximum quantizer scale.
1965
1966 @item qdiff (@emph{qpstep})
1967 Maximum difference between quantizer scales.
1968
1969 @item qblur (@emph{qblur})
1970 Quantizer curve blur
1971
1972 @item qcomp (@emph{qcomp})
1973 Quantizer curve compression factor
1974
1975 @item refs (@emph{ref})
1976 Number of reference frames each P-frame can use. The range is from @var{0-16}.
1977
1978 @item sc_threshold (@emph{scenecut})
1979 Sets the threshold for the scene change detection.
1980
1981 @item trellis (@emph{trellis})
1982 Performs Trellis quantization to increase efficiency. Enabled by default.
1983
1984 @item nr  (@emph{nr})
1985
1986 @item me_range (@emph{merange})
1987 Maximum range of the motion search in pixels.
1988
1989 @item me_method (@emph{me})
1990 Set motion estimation method. Possible values in the decreasing order
1991 of speed:
1992
1993 @table @samp
1994 @item dia (@emph{dia})
1995 @item epzs (@emph{dia})
1996 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
1997 @samp{dia}.
1998 @item hex (@emph{hex})
1999 Hexagonal search with radius 2.
2000 @item umh (@emph{umh})
2001 Uneven multi-hexagon search.
2002 @item esa (@emph{esa})
2003 Exhaustive search.
2004 @item tesa (@emph{tesa})
2005 Hadamard exhaustive search (slowest).
2006 @end table
2007
2008 @item forced-idr
2009 Normally, when forcing a I-frame type, the encoder can select any type
2010 of I-frame. This option forces it to choose an IDR-frame.
2011
2012 @item subq (@emph{subme})
2013 Sub-pixel motion estimation method.
2014
2015 @item b_strategy (@emph{b-adapt})
2016 Adaptive B-frame placement decision algorithm. Use only on first-pass.
2017
2018 @item keyint_min (@emph{min-keyint})
2019 Minimum GOP size.
2020
2021 @item coder
2022 Set entropy encoder. Possible values:
2023
2024 @table @samp
2025 @item ac
2026 Enable CABAC.
2027
2028 @item vlc
2029 Enable CAVLC and disable CABAC. It generates the same effect as
2030 @command{x264}'s @option{--no-cabac} option.
2031 @end table
2032
2033 @item cmp
2034 Set full pixel motion estimation comparison algorithm. Possible values:
2035
2036 @table @samp
2037 @item chroma
2038 Enable chroma in motion estimation.
2039
2040 @item sad
2041 Ignore chroma in motion estimation. It generates the same effect as
2042 @command{x264}'s @option{--no-chroma-me} option.
2043 @end table
2044
2045 @item threads (@emph{threads})
2046 Number of encoding threads.
2047
2048 @item thread_type
2049 Set multithreading technique. Possible values:
2050
2051 @table @samp
2052 @item slice
2053 Slice-based multithreading. It generates the same effect as
2054 @command{x264}'s @option{--sliced-threads} option.
2055 @item frame
2056 Frame-based multithreading.
2057 @end table
2058
2059 @item flags
2060 Set encoding flags. It can be used to disable closed GOP and enable
2061 open GOP by setting it to @code{-cgop}. The result is similar to
2062 the behavior of @command{x264}'s @option{--open-gop} option.
2063
2064 @item rc_init_occupancy (@emph{vbv-init})
2065
2066 @item preset (@emph{preset})
2067 Set the encoding preset.
2068
2069 @item tune (@emph{tune})
2070 Set tuning of the encoding params.
2071
2072 @item profile (@emph{profile})
2073 Set profile restrictions.
2074
2075 @item fastfirstpass
2076 Enable fast settings when encoding first pass, when set to 1. When set
2077 to 0, it has the same effect of @command{x264}'s
2078 @option{--slow-firstpass} option.
2079
2080 @item crf (@emph{crf})
2081 Set the quality for constant quality mode.
2082
2083 @item crf_max (@emph{crf-max})
2084 In CRF mode, prevents VBV from lowering quality beyond this point.
2085
2086 @item qp (@emph{qp})
2087 Set constant quantization rate control method parameter.
2088
2089 @item aq-mode (@emph{aq-mode})
2090 Set AQ method. Possible values:
2091
2092 @table @samp
2093 @item none (@emph{0})
2094 Disabled.
2095
2096 @item variance (@emph{1})
2097 Variance AQ (complexity mask).
2098
2099 @item autovariance (@emph{2})
2100 Auto-variance AQ (experimental).
2101 @end table
2102
2103 @item aq-strength (@emph{aq-strength})
2104 Set AQ strength, reduce blocking and blurring in flat and textured areas.
2105
2106 @item psy
2107 Use psychovisual optimizations when set to 1. When set to 0, it has the
2108 same effect as @command{x264}'s @option{--no-psy} option.
2109
2110 @item psy-rd  (@emph{psy-rd})
2111 Set strength of psychovisual optimization, in
2112 @var{psy-rd}:@var{psy-trellis} format.
2113
2114 @item rc-lookahead (@emph{rc-lookahead})
2115 Set number of frames to look ahead for frametype and ratecontrol.
2116
2117 @item weightb
2118 Enable weighted prediction for B-frames when set to 1. When set to 0,
2119 it has the same effect as @command{x264}'s @option{--no-weightb} option.
2120
2121 @item weightp (@emph{weightp})
2122 Set weighted prediction method for P-frames. Possible values:
2123
2124 @table @samp
2125 @item none (@emph{0})
2126 Disabled
2127 @item simple (@emph{1})
2128 Enable only weighted refs
2129 @item smart (@emph{2})
2130 Enable both weighted refs and duplicates
2131 @end table
2132
2133 @item ssim (@emph{ssim})
2134 Enable calculation and printing SSIM stats after the encoding.
2135
2136 @item intra-refresh (@emph{intra-refresh})
2137 Enable the use of Periodic Intra Refresh instead of IDR frames when set
2138 to 1.
2139
2140 @item avcintra-class (@emph{class})
2141 Configure the encoder to generate AVC-Intra.
2142 Valid values are 50,100 and 200
2143
2144 @item bluray-compat (@emph{bluray-compat})
2145 Configure the encoder to be compatible with the bluray standard.
2146 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
2147
2148 @item b-bias (@emph{b-bias})
2149 Set the influence on how often B-frames are used.
2150
2151 @item b-pyramid (@emph{b-pyramid})
2152 Set method for keeping of some B-frames as references. Possible values:
2153
2154 @table @samp
2155 @item none (@emph{none})
2156 Disabled.
2157 @item strict (@emph{strict})
2158 Strictly hierarchical pyramid.
2159 @item normal (@emph{normal})
2160 Non-strict (not Blu-ray compatible).
2161 @end table
2162
2163 @item mixed-refs
2164 Enable the use of one reference per partition, as opposed to one
2165 reference per macroblock when set to 1. When set to 0, it has the
2166 same effect as @command{x264}'s @option{--no-mixed-refs} option.
2167
2168 @item 8x8dct
2169 Enable adaptive spatial transform (high profile 8x8 transform)
2170 when set to 1. When set to 0, it has the same effect as
2171 @command{x264}'s @option{--no-8x8dct} option.
2172
2173 @item fast-pskip
2174 Enable early SKIP detection on P-frames when set to 1. When set
2175 to 0, it has the same effect as @command{x264}'s
2176 @option{--no-fast-pskip} option.
2177
2178 @item aud (@emph{aud})
2179 Enable use of access unit delimiters when set to 1.
2180
2181 @item mbtree
2182 Enable use macroblock tree ratecontrol when set to 1. When set
2183 to 0, it has the same effect as @command{x264}'s
2184 @option{--no-mbtree} option.
2185
2186 @item deblock (@emph{deblock})
2187 Set loop filter parameters, in @var{alpha}:@var{beta} form.
2188
2189 @item cplxblur (@emph{cplxblur})
2190 Set fluctuations reduction in QP (before curve compression).
2191
2192 @item partitions (@emph{partitions})
2193 Set partitions to consider as a comma-separated list of. Possible
2194 values in the list:
2195
2196 @table @samp
2197 @item p8x8
2198 8x8 P-frame partition.
2199 @item p4x4
2200 4x4 P-frame partition.
2201 @item b8x8
2202 4x4 B-frame partition.
2203 @item i8x8
2204 8x8 I-frame partition.
2205 @item i4x4
2206 4x4 I-frame partition.
2207 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
2208 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
2209 option) to be enabled.)
2210 @item none (@emph{none})
2211 Do not consider any partitions.
2212 @item all (@emph{all})
2213 Consider every partition.
2214 @end table
2215
2216 @item direct-pred (@emph{direct})
2217 Set direct MV prediction mode. Possible values:
2218
2219 @table @samp
2220 @item none (@emph{none})
2221 Disable MV prediction.
2222 @item spatial (@emph{spatial})
2223 Enable spatial predicting.
2224 @item temporal (@emph{temporal})
2225 Enable temporal predicting.
2226 @item auto (@emph{auto})
2227 Automatically decided.
2228 @end table
2229
2230 @item slice-max-size (@emph{slice-max-size})
2231 Set the limit of the size of each slice in bytes. If not specified
2232 but RTP payload size (@option{ps}) is specified, that is used.
2233
2234 @item stats (@emph{stats})
2235 Set the file name for multi-pass stats.
2236
2237 @item nal-hrd (@emph{nal-hrd})
2238 Set signal HRD information (requires @option{vbv-bufsize} to be set).
2239 Possible values:
2240
2241 @table @samp
2242 @item none (@emph{none})
2243 Disable HRD information signaling.
2244 @item vbr (@emph{vbr})
2245 Variable bit rate.
2246 @item cbr (@emph{cbr})
2247 Constant bit rate (not allowed in MP4 container).
2248 @end table
2249
2250 @item x264opts (N.A.)
2251 Set any x264 option, see @command{x264 --fullhelp} for a list.
2252
2253 Argument is a list of @var{key}=@var{value} couples separated by
2254 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
2255 themselves, use "," instead. They accept it as well since long ago but this
2256 is kept undocumented for some reason.
2257
2258 For example to specify libx264 encoding options with @command{ffmpeg}:
2259 @example
2260 ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
2261 @end example
2262
2263 @item a53cc @var{boolean}
2264 Import closed captions (which must be ATSC compatible format) into output.
2265 Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
2266
2267 @item x264-params (N.A.)
2268 Override the x264 configuration using a :-separated list of key=value
2269 parameters.
2270
2271 This option is functionally the same as the @option{x264opts}, but is
2272 duplicated for compatibility with the Libav fork.
2273
2274 For example to specify libx264 encoding options with @command{ffmpeg}:
2275 @example
2276 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
2277 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
2278 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
2279 @end example
2280 @end table
2281
2282 Encoding ffpresets for common usages are provided so they can be used with the
2283 general presets system (e.g. passing the @option{pre} option).
2284
2285 @section libx265
2286
2287 x265 H.265/HEVC encoder wrapper.
2288
2289 This encoder requires the presence of the libx265 headers and library
2290 during configuration. You need to explicitly configure the build with
2291 @option{--enable-libx265}.
2292
2293 @subsection Options
2294
2295 @table @option
2296 @item preset
2297 Set the x265 preset.
2298
2299 @item tune
2300 Set the x265 tune parameter.
2301
2302 @item profile
2303 Set profile restrictions.
2304
2305 @item crf
2306 Set the quality for constant quality mode.
2307
2308 @item forced-idr
2309 Normally, when forcing a I-frame type, the encoder can select any type
2310 of I-frame. This option forces it to choose an IDR-frame.
2311
2312 @item x265-params
2313 Set x265 options using a list of @var{key}=@var{value} couples separated
2314 by ":". See @command{x265 --help} for a list of options.
2315
2316 For example to specify libx265 encoding options with @option{-x265-params}:
2317
2318 @example
2319 ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
2320 @end example
2321 @end table
2322
2323 @section libxavs2
2324
2325 xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
2326
2327 This encoder requires the presence of the libxavs2 headers and library
2328 during configuration. You need to explicitly configure the build with
2329 @option{--enable-libxavs2}.
2330
2331 @subsection Options
2332
2333 @table @option
2334 @item lcu_row_threads
2335 Set the number of parallel threads for rows from 1 to 8 (default 5).
2336
2337 @item initial_qp
2338 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2339 used to set the initial qp for the first frame.
2340
2341 @item qp
2342 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2343 used to set the qp value under constant-QP mode.
2344
2345 @item max_qp
2346 Set the max qp for rate control from 1 to 63 (default 55).
2347
2348 @item min_qp
2349 Set the min qp for rate control from 1 to 63 (default 20).
2350
2351 @item speed_level
2352 Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
2353
2354 @item log_level
2355 Set the log level from -1 to 3 (default 0). -1: none, 0: error,
2356 1: warning, 2: info, 3: debug.
2357
2358 @item xavs2-params
2359 Set xavs2 options using a list of @var{key}=@var{value} couples separated
2360 by ":".
2361
2362 For example to specify libxavs2 encoding options with @option{-xavs2-params}:
2363
2364 @example
2365 ffmpeg -i input -c:v libxavs2 -xavs2-params preset_level=5 output.avs2
2366 @end example
2367 @end table
2368
2369 @section libxvid
2370
2371 Xvid MPEG-4 Part 2 encoder wrapper.
2372
2373 This encoder requires the presence of the libxvidcore headers and library
2374 during configuration. You need to explicitly configure the build with
2375 @code{--enable-libxvid --enable-gpl}.
2376
2377 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
2378 users can encode to this format without this library.
2379
2380 @subsection Options
2381
2382 The following options are supported by the libxvid wrapper. Some of
2383 the following options are listed but are not documented, and
2384 correspond to shared codec options. See @ref{codec-options,,the Codec
2385 Options chapter} for their documentation. The other shared options
2386 which are not listed have no effect for the libxvid encoder.
2387
2388 @table @option
2389 @item b
2390
2391 @item g
2392
2393 @item qmin
2394
2395 @item qmax
2396
2397 @item mpeg_quant
2398
2399 @item threads
2400
2401 @item bf
2402
2403 @item b_qfactor
2404
2405 @item b_qoffset
2406
2407 @item flags
2408 Set specific encoding flags. Possible values:
2409
2410 @table @samp
2411
2412 @item mv4
2413 Use four motion vector by macroblock.
2414
2415 @item aic
2416 Enable high quality AC prediction.
2417
2418 @item gray
2419 Only encode grayscale.
2420
2421 @item gmc
2422 Enable the use of global motion compensation (GMC).
2423
2424 @item qpel
2425 Enable quarter-pixel motion compensation.
2426
2427 @item cgop
2428 Enable closed GOP.
2429
2430 @item global_header
2431 Place global headers in extradata instead of every keyframe.
2432
2433 @end table
2434
2435 @item trellis
2436
2437 @item me_method
2438 Set motion estimation method. Possible values in decreasing order of
2439 speed and increasing order of quality:
2440
2441 @table @samp
2442 @item zero
2443 Use no motion estimation (default).
2444
2445 @item phods
2446 @item x1
2447 @item log
2448 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
2449 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
2450 @samp{phods}.
2451
2452 @item epzs
2453 Enable all of the things described above, plus advanced diamond zonal
2454 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
2455 estimation on chroma planes.
2456
2457 @item full
2458 Enable all of the things described above, plus extended 16x16 and 8x8
2459 blocks search.
2460 @end table
2461
2462 @item mbd
2463 Set macroblock decision algorithm. Possible values in the increasing
2464 order of quality:
2465
2466 @table @samp
2467 @item simple
2468 Use macroblock comparing function algorithm (default).
2469
2470 @item bits
2471 Enable rate distortion-based half pixel and quarter pixel refinement for
2472 16x16 blocks.
2473
2474 @item rd
2475 Enable all of the things described above, plus rate distortion-based
2476 half pixel and quarter pixel refinement for 8x8 blocks, and rate
2477 distortion-based search using square pattern.
2478 @end table
2479
2480 @item lumi_aq
2481 Enable lumi masking adaptive quantization when set to 1. Default is 0
2482 (disabled).
2483
2484 @item variance_aq
2485 Enable variance adaptive quantization when set to 1. Default is 0
2486 (disabled).
2487
2488 When combined with @option{lumi_aq}, the resulting quality will not
2489 be better than any of the two specified individually. In other
2490 words, the resulting quality will be the worse one of the two
2491 effects.
2492
2493 @item ssim
2494 Set structural similarity (SSIM) displaying method. Possible values:
2495
2496 @table @samp
2497 @item off
2498 Disable displaying of SSIM information.
2499
2500 @item avg
2501 Output average SSIM at the end of encoding to stdout. The format of
2502 showing the average SSIM is:
2503
2504 @example
2505 Average SSIM: %f
2506 @end example
2507
2508 For users who are not familiar with C, %f means a float number, or
2509 a decimal (e.g. 0.939232).
2510
2511 @item frame
2512 Output both per-frame SSIM data during encoding and average SSIM at
2513 the end of encoding to stdout. The format of per-frame information
2514 is:
2515
2516 @example
2517        SSIM: avg: %1.3f min: %1.3f max: %1.3f
2518 @end example
2519
2520 For users who are not familiar with C, %1.3f means a float number
2521 rounded to 3 digits after the dot (e.g. 0.932).
2522
2523 @end table
2524
2525 @item ssim_acc
2526 Set SSIM accuracy. Valid options are integers within the range of
2527 0-4, while 0 gives the most accurate result and 4 computes the
2528 fastest.
2529
2530 @end table
2531
2532 @section mpeg2
2533
2534 MPEG-2 video encoder.
2535
2536 @subsection Options
2537
2538 @table @option
2539 @item seq_disp_ext @var{integer}
2540 Specifies if the encoder should write a sequence_display_extension to the
2541 output.
2542 @table @option
2543 @item -1
2544 @itemx auto
2545 Decide automatically to write it or not (this is the default) by checking if
2546 the data to be written is different from the default or unspecified values.
2547 @item 0
2548 @itemx never
2549 Never write it.
2550 @item 1
2551 @itemx always
2552 Always write it.
2553 @end table
2554 @item video_format @var{integer}
2555 Specifies the video_format written into the sequence display extension
2556 indicating the source of the video pictures. The default is @samp{unspecified},
2557 can be @samp{component}, @samp{pal}, @samp{ntsc}, @samp{secam} or @samp{mac}.
2558 For maximum compatibility, use @samp{component}.
2559 @end table
2560
2561 @section png
2562
2563 PNG image encoder.
2564
2565 @subsection Private options
2566
2567 @table @option
2568 @item dpi @var{integer}
2569 Set physical density of pixels, in dots per inch, unset by default
2570 @item dpm @var{integer}
2571 Set physical density of pixels, in dots per meter, unset by default
2572 @end table
2573
2574 @section ProRes
2575
2576 Apple ProRes encoder.
2577
2578 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
2579 The used encoder can be chosen with the @code{-vcodec} option.
2580
2581 @subsection Private Options for prores-ks
2582
2583 @table @option
2584 @item profile @var{integer}
2585 Select the ProRes profile to encode
2586 @table @samp
2587 @item proxy
2588 @item lt
2589 @item standard
2590 @item hq
2591 @item 4444
2592 @item 4444xq
2593 @end table
2594
2595 @item quant_mat @var{integer}
2596 Select quantization matrix.
2597 @table @samp
2598 @item auto
2599 @item default
2600 @item proxy
2601 @item lt
2602 @item standard
2603 @item hq
2604 @end table
2605 If set to @var{auto}, the matrix matching the profile will be picked.
2606 If not set, the matrix providing the highest quality, @var{default}, will be
2607 picked.
2608
2609 @item bits_per_mb @var{integer}
2610 How many bits to allot for coding one macroblock. Different profiles use
2611 between 200 and 2400 bits per macroblock, the maximum is 8000.
2612
2613 @item mbs_per_slice @var{integer}
2614 Number of macroblocks in each slice (1-8); the default value (8)
2615 should be good in almost all situations.
2616
2617 @item vendor @var{string}
2618 Override the 4-byte vendor ID.
2619 A custom vendor ID like @var{apl0} would claim the stream was produced by
2620 the Apple encoder.
2621
2622 @item alpha_bits @var{integer}
2623 Specify number of bits for alpha component.
2624 Possible values are @var{0}, @var{8} and @var{16}.
2625 Use @var{0} to disable alpha plane coding.
2626
2627 @end table
2628
2629 @subsection Speed considerations
2630
2631 In the default mode of operation the encoder has to honor frame constraints
2632 (i.e. not produce frames with size bigger than requested) while still making
2633 output picture as good as possible.
2634 A frame containing a lot of small details is harder to compress and the encoder
2635 would spend more time searching for appropriate quantizers for each slice.
2636
2637 Setting a higher @option{bits_per_mb} limit will improve the speed.
2638
2639 For the fastest encoding speed set the @option{qscale} parameter (4 is the
2640 recommended value) and do not set a size constraint.
2641
2642 @section QSV encoders
2643
2644 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
2645
2646 The ratecontrol method is selected as follows:
2647
2648 @itemize @bullet
2649 @item
2650 When @option{global_quality} is specified, a quality-based mode is used.
2651 Specifically this means either
2652 @itemize @minus
2653 @item
2654 @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
2655 also set (the @option{-qscale} ffmpeg option).
2656
2657 @item
2658 @var{LA_ICQ} - intelligent constant quality with lookahead, when the
2659 @option{look_ahead} option is also set.
2660
2661 @item
2662 @var{ICQ} -- intelligent constant quality otherwise.
2663 @end itemize
2664
2665 @item
2666 Otherwise, a bitrate-based mode is used. For all of those, you should specify at
2667 least the desired average bitrate with the @option{b} option.
2668 @itemize @minus
2669 @item
2670 @var{LA} - VBR with lookahead, when the @option{look_ahead} option is specified.
2671
2672 @item
2673 @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
2674
2675 @item
2676 @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
2677 the average bitrate.
2678
2679 @item
2680 @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
2681 than the average bitrate.
2682
2683 @item
2684 @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
2685 is further configured by the @option{avbr_accuracy} and
2686 @option{avbr_convergence} options.
2687 @end itemize
2688 @end itemize
2689
2690 Note that depending on your system, a different mode than the one you specified
2691 may be selected by the encoder. Set the verbosity level to @var{verbose} or
2692 higher to see the actual settings used by the QSV runtime.
2693
2694 Additional libavcodec global options are mapped to MSDK options as follows:
2695
2696 @itemize
2697 @item
2698 @option{g/gop_size} -> @option{GopPicSize}
2699
2700 @item
2701 @option{bf/max_b_frames}+1 -> @option{GopRefDist}
2702
2703 @item
2704 @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
2705 @option{InitialDelayInKB}
2706
2707 @item
2708 @option{slices} -> @option{NumSlice}
2709
2710 @item
2711 @option{refs} -> @option{NumRefFrame}
2712
2713 @item
2714 @option{b_strategy/b_frame_strategy} -> @option{BRefType}
2715
2716 @item
2717 @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
2718
2719 @item
2720 For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
2721 @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
2722 and @var{QPP} and @var{QPB} respectively.
2723
2724 @item
2725 Setting the @option{coder} option to the value @var{vlc} will make the H.264
2726 encoder use CAVLC instead of CABAC.
2727
2728 @end itemize
2729
2730 @section snow
2731
2732 @subsection Options
2733
2734 @table @option
2735 @item iterative_dia_size
2736 dia size for the iterative motion estimation
2737 @end table
2738
2739 @section VAAPI encoders
2740
2741 Wrappers for hardware encoders accessible via VAAPI.
2742
2743 These encoders only accept input in VAAPI hardware surfaces.  If you have input
2744 in software frames, use the @option{hwupload} filter to upload them to the GPU.
2745
2746 The following standard libavcodec options are used:
2747 @itemize
2748 @item
2749 @option{g} / @option{gop_size}
2750 @item
2751 @option{bf} / @option{max_b_frames}
2752 @item
2753 @option{profile}
2754
2755 If not set, this will be determined automatically from the format of the input
2756 frames and the profiles supported by the driver.
2757 @item
2758 @option{level}
2759 @item
2760 @option{b} / @option{bit_rate}
2761 @item
2762 @option{maxrate} / @option{rc_max_rate}
2763 @item
2764 @option{bufsize} / @option{rc_buffer_size}
2765 @item
2766 @option{rc_init_occupancy} / @option{rc_initial_buffer_occupancy}
2767 @item
2768 @option{compression_level}
2769
2770 Speed / quality tradeoff: higher values are faster / worse quality.
2771 @item
2772 @option{q} / @option{global_quality}
2773
2774 Size / quality tradeoff: higher values are smaller / worse quality.
2775 @item
2776 @option{qmin}
2777 @item
2778 @option{qmax}
2779 @item
2780 @option{i_qfactor} / @option{i_quant_factor}
2781 @item
2782 @option{i_qoffset} / @option{i_quant_offset}
2783 @item
2784 @option{b_qfactor} / @option{b_quant_factor}
2785 @item
2786 @option{b_qoffset} / @option{b_quant_offset}
2787 @item
2788 @option{slices}
2789 @end itemize
2790
2791 All encoders support the following options:
2792 @itemize
2793 @item
2794 @option{low_power}
2795
2796 Some drivers/platforms offer a second encoder for some codecs intended to use
2797 less power than the default encoder; setting this option will attempt to use
2798 that encoder.  Note that it may support a reduced feature set, so some other
2799 options may not be available in this mode.
2800 @end itemize
2801
2802 Each encoder also has its own specific options:
2803 @table @option
2804
2805 @item h264_vaapi
2806 @option{profile} sets the value of @emph{profile_idc} and the @emph{constraint_set*_flag}s.
2807 @option{level} sets the value of @emph{level_idc}.
2808
2809 @table @option
2810 @item coder
2811 Set entropy encoder (default is @emph{cabac}).  Possible values:
2812
2813 @table @samp
2814 @item ac
2815 @item cabac
2816 Use CABAC.
2817
2818 @item vlc
2819 @item cavlc
2820 Use CAVLC.
2821 @end table
2822
2823 @item aud
2824 Include access unit delimiters in the stream (not included by default).
2825
2826 @item sei
2827 Set SEI message types to include.
2828 Some combination of the following values:
2829 @table @samp
2830 @item identifier
2831 Include a @emph{user_data_unregistered} message containing information about
2832 the encoder.
2833 @item timing
2834 Include picture timing parameters (@emph{buffering_period} and
2835 @emph{pic_timing} messages).
2836 @item recovery_point
2837 Include recovery points where appropriate (@emph{recovery_point} messages).
2838 @end table
2839
2840 @end table
2841
2842 @item hevc_vaapi
2843 @option{profile} and @option{level} set the values of
2844 @emph{general_profile_idc} and @emph{general_level_idc} respectively.
2845
2846 @table @option
2847 @item aud
2848 Include access unit delimiters in the stream (not included by default).
2849
2850 @item tier
2851 Set @emph{general_tier_flag}.  This may affect the level chosen for the stream
2852 if it is not explicitly specified.
2853
2854 @item sei
2855 Set SEI message types to include.
2856 Some combination of the following values:
2857 @table @samp
2858 @item hdr
2859 Include HDR metadata if the input frames have it
2860 (@emph{mastering_display_colour_volume} and @emph{content_light_level}
2861 messages).
2862 @end table
2863
2864 @end table
2865
2866 @item mjpeg_vaapi
2867 Only baseline DCT encoding is supported.  The encoder always uses the standard
2868 quantisation and huffman tables - @option{global_quality} scales the standard
2869 quantisation table (range 1-100).
2870
2871 For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported.  RGB is also
2872 supported, and will create an RGB JPEG.
2873
2874 @table @option
2875 @item jfif
2876 Include JFIF header in each frame (not included by default).
2877 @item huffman
2878 Include standard huffman tables (on by default).  Turning this off will save
2879 a few hundred bytes in each output frame, but may lose compatibility with some
2880 JPEG decoders which don't fully handle MJPEG.
2881 @end table
2882
2883 @item mpeg2_vaapi
2884 @option{profile} and @option{level} set the value of @emph{profile_and_level_indication}.
2885
2886 @item vp8_vaapi
2887 B-frames are not supported.
2888
2889 @option{global_quality} sets the @emph{q_idx} used for non-key frames (range 0-127).
2890
2891 @table @option
2892 @item loop_filter_level
2893 @item loop_filter_sharpness
2894 Manually set the loop filter parameters.
2895 @end table
2896
2897 @item vp9_vaapi
2898 @option{global_quality} sets the @emph{q_idx} used for P-frames (range 0-255).
2899
2900 @table @option
2901 @item loop_filter_level
2902 @item loop_filter_sharpness
2903 Manually set the loop filter parameters.
2904 @end table
2905
2906 B-frames are supported, but the output stream is always in encode order rather than display
2907 order.  If B-frames are enabled, it may be necessary to use the @option{vp9_raw_reorder}
2908 bitstream filter to modify the output stream to display frames in the correct order.
2909
2910 Only normal frames are produced - the @option{vp9_superframe} bitstream filter may be
2911 required to produce a stream usable with all decoders.
2912
2913 @end table
2914
2915 @section vc2
2916
2917 SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
2918 professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
2919 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
2920 other tasks which require low overhead and low compression (like screen
2921 recording).
2922
2923 @subsection Options
2924
2925 @table @option
2926
2927 @item b
2928 Sets target video bitrate. Usually that's around 1:6 of the uncompressed
2929 video bitrate (e.g. for 1920x1080 50fps yuv422p10 that's around 400Mbps). Higher
2930 values (close to the uncompressed bitrate) turn on lossless compression mode.
2931
2932 @item field_order
2933 Enables field coding when set (e.g. to tt - top field first) for interlaced
2934 inputs. Should increase compression with interlaced content as it splits the
2935 fields and encodes each separately.
2936
2937 @item wavelet_depth
2938 Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
2939 Lower values reduce compression and quality. Less capable decoders may not be
2940 able to handle values of @option{wavelet_depth} over 3.
2941
2942 @item wavelet_type
2943 Sets the transform type. Currently only @var{5_3} (LeGall) and @var{9_7}
2944 (Deslauriers-Dubuc)
2945 are implemented, with 9_7 being the one with better compression and thus
2946 is the default.
2947
2948 @item slice_width
2949 @item slice_height
2950 Sets the slice size for each slice. Larger values result in better compression.
2951 For compatibility with other more limited decoders use @option{slice_width} of
2952 32 and @option{slice_height} of 8.
2953
2954 @item tolerance
2955 Sets the undershoot tolerance of the rate control system in percent. This is
2956 to prevent an expensive search from being run.
2957
2958 @item qm
2959 Sets the quantization matrix preset to use by default or when @option{wavelet_depth}
2960 is set to 5
2961 @itemize @minus
2962 @item
2963 @var{default}
2964 Uses the default quantization matrix from the specifications, extended with
2965 values for the fifth level. This provides a good balance between keeping detail
2966 and omitting artifacts.
2967
2968 @item
2969 @var{flat}
2970 Use a completely zeroed out quantization matrix. This increases PSNR but might
2971 reduce perception. Use in bogus benchmarks.
2972
2973 @item
2974 @var{color}
2975 Reduces detail but attempts to preserve color at extremely low bitrates.
2976 @end itemize
2977
2978 @end table
2979
2980 @c man end VIDEO ENCODERS
2981
2982 @chapter Subtitles Encoders
2983 @c man begin SUBTITLES ENCODERS
2984
2985 @section dvdsub
2986
2987 This codec encodes the bitmap subtitle format that is used in DVDs.
2988 Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
2989 and they can also be used in Matroska files.
2990
2991 @subsection Options
2992
2993 @table @option
2994 @item even_rows_fix
2995 When set to 1, enable a work-around that makes the number of pixel rows
2996 even in all subtitles.  This fixes a problem with some players that
2997 cut off the bottom row if the number is odd.  The work-around just adds
2998 a fully transparent row if needed.  The overhead is low, typically
2999 one byte per subtitle on average.
3000
3001 By default, this work-around is disabled.
3002 @end table
3003
3004 @c man end SUBTITLES ENCODERS