avcodec/libvpxenc: add VP8/9 sharpness config option
[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} or @option{row-mt} options to also be set to actually
1415 use the specified number of threads fully. Defaults to the number of
1416 hardware threads 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 columns 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 @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
1481 Enable row based multi-threading. Disabled by default.
1482
1483 @end table
1484
1485 @section libkvazaar
1486
1487 Kvazaar H.265/HEVC encoder.
1488
1489 Requires the presence of the libkvazaar headers and library during
1490 configuration. You need to explicitly configure the build with
1491 @option{--enable-libkvazaar}.
1492
1493 @subsection Options
1494
1495 @table @option
1496
1497 @item b
1498 Set target video bitrate in bit/s and enable rate control.
1499
1500 @item kvazaar-params
1501 Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
1502 by commas (,). See kvazaar documentation for a list of options.
1503
1504 @end table
1505
1506 @section libopenh264
1507
1508 Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
1509
1510 This encoder requires the presence of the libopenh264 headers and
1511 library during configuration. You need to explicitly configure the
1512 build with @code{--enable-libopenh264}. The library is detected using
1513 @command{pkg-config}.
1514
1515 For more information about the library see
1516 @url{http://www.openh264.org}.
1517
1518 @subsection Options
1519
1520 The following FFmpeg global options affect the configurations of the
1521 libopenh264 encoder.
1522
1523 @table @option
1524 @item b
1525 Set the bitrate (as a number of bits per second).
1526
1527 @item g
1528 Set the GOP size.
1529
1530 @item maxrate
1531 Set the max bitrate (as a number of bits per second).
1532
1533 @item flags +global_header
1534 Set global header in the bitstream.
1535
1536 @item slices
1537 Set the number of slices, used in parallelized encoding. Default value
1538 is 0. This is only used when @option{slice_mode} is set to
1539 @samp{fixed}.
1540
1541 @item slice_mode
1542 Set slice mode. Can assume one of the following possible values:
1543
1544 @table @samp
1545 @item fixed
1546 a fixed number of slices
1547 @item rowmb
1548 one slice per row of macroblocks
1549 @item auto
1550 automatic number of slices according to number of threads
1551 @item dyn
1552 dynamic slicing
1553 @end table
1554
1555 Default value is @samp{auto}.
1556
1557 @item loopfilter
1558 Enable loop filter, if set to 1 (automatically enabled). To disable
1559 set a value of 0.
1560
1561 @item profile
1562 Set profile restrictions. If set to the value of @samp{main} enable
1563 CABAC (set the @code{SEncParamExt.iEntropyCodingModeFlag} flag to 1).
1564
1565 @item max_nal_size
1566 Set maximum NAL size in bytes.
1567
1568 @item allow_skip_frames
1569 Allow skipping frames to hit the target bitrate if set to 1.
1570 @end table
1571
1572 @section libtheora
1573
1574 libtheora Theora encoder wrapper.
1575
1576 Requires the presence of the libtheora headers and library during
1577 configuration. You need to explicitly configure the build with
1578 @code{--enable-libtheora}.
1579
1580 For more information about the libtheora project see
1581 @url{http://www.theora.org/}.
1582
1583 @subsection Options
1584
1585 The following global options are mapped to internal libtheora options
1586 which affect the quality and the bitrate of the encoded stream.
1587
1588 @table @option
1589 @item b
1590 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1591 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1592
1593 @item flags
1594 Used to enable constant quality mode (VBR) encoding through the
1595 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1596 modes.
1597
1598 @item g
1599 Set the GOP size.
1600
1601 @item global_quality
1602 Set the global quality as an integer in lambda units.
1603
1604 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1605 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1606 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1607 value in the native libtheora range [0-63]. A higher value corresponds
1608 to a higher quality.
1609
1610 @item q
1611 Enable VBR mode when set to a non-negative value, and set constant
1612 quality value as a double floating point value in QP units.
1613
1614 The value is clipped in the [0-10] range, and then multiplied by 6.3
1615 to get a value in the native libtheora range [0-63].
1616
1617 This option is valid only using the @command{ffmpeg} command-line
1618 tool. For library interface users, use @option{global_quality}.
1619 @end table
1620
1621 @subsection Examples
1622
1623 @itemize
1624 @item
1625 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1626 @example
1627 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1628 @end example
1629
1630 @item
1631 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1632 @example
1633 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1634 @end example
1635 @end itemize
1636
1637 @section libvpx
1638
1639 VP8/VP9 format supported through libvpx.
1640
1641 Requires the presence of the libvpx headers and library during configuration.
1642 You need to explicitly configure the build with @code{--enable-libvpx}.
1643
1644 @subsection Options
1645
1646 The following options are supported by the libvpx wrapper. The
1647 @command{vpxenc}-equivalent options or values are listed in parentheses
1648 for easy migration.
1649
1650 To reduce the duplication of documentation, only the private options
1651 and some others requiring special attention are documented here. For
1652 the documentation of the undocumented generic options, see
1653 @ref{codec-options,,the Codec Options chapter}.
1654
1655 To get more documentation of the libvpx options, invoke the command
1656 @command{ffmpeg -h encoder=libvpx}, @command{ffmpeg -h encoder=libvpx-vp9} or
1657 @command{vpxenc --help}. Further information is available in the libvpx API
1658 documentation.
1659
1660 @table @option
1661
1662 @item b (@emph{target-bitrate})
1663 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1664 expressed in bits/s, while @command{vpxenc}'s @option{target-bitrate} is in
1665 kilobits/s.
1666
1667 @item g (@emph{kf-max-dist})
1668
1669 @item keyint_min (@emph{kf-min-dist})
1670
1671 @item qmin (@emph{min-q})
1672
1673 @item qmax (@emph{max-q})
1674
1675 @item bufsize (@emph{buf-sz}, @emph{buf-optimal-sz})
1676 Set ratecontrol buffer size (in bits). Note @command{vpxenc}'s options are
1677 specified in milliseconds, the libvpx wrapper converts this value as follows:
1678 @code{buf-sz = bufsize * 1000 / bitrate},
1679 @code{buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6}.
1680
1681 @item rc_init_occupancy (@emph{buf-initial-sz})
1682 Set number of bits which should be loaded into the rc buffer before decoding
1683 starts. Note @command{vpxenc}'s option is specified in milliseconds, the libvpx
1684 wrapper converts this value as follows:
1685 @code{rc_init_occupancy * 1000 / bitrate}.
1686
1687 @item undershoot-pct
1688 Set datarate undershoot (min) percentage of the target bitrate.
1689
1690 @item overshoot-pct
1691 Set datarate overshoot (max) percentage of the target bitrate.
1692
1693 @item skip_threshold (@emph{drop-frame})
1694
1695 @item qcomp (@emph{bias-pct})
1696
1697 @item maxrate (@emph{maxsection-pct})
1698 Set GOP max bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1699 percentage of the target bitrate, the libvpx wrapper converts this value as
1700 follows: @code{(maxrate * 100 / bitrate)}.
1701
1702 @item minrate (@emph{minsection-pct})
1703 Set GOP min bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1704 percentage of the target bitrate, the libvpx wrapper converts this value as
1705 follows: @code{(minrate * 100 / bitrate)}.
1706
1707 @item minrate, maxrate, b @emph{end-usage=cbr}
1708 @code{(minrate == maxrate == bitrate)}.
1709
1710 @item crf (@emph{end-usage=cq}, @emph{cq-level})
1711
1712 @item tune (@emph{tune})
1713 @table @samp
1714 @item psnr (@emph{psnr})
1715 @item ssim (@emph{ssim})
1716 @end table
1717
1718 @item quality, deadline (@emph{deadline})
1719 @table @samp
1720 @item best
1721 Use best quality deadline. Poorly named and quite slow, this option should be
1722 avoided as it may give worse quality output than good.
1723 @item good
1724 Use good quality deadline. This is a good trade-off between speed and quality
1725 when used with the @option{cpu-used} option.
1726 @item realtime
1727 Use realtime quality deadline.
1728 @end table
1729
1730 @item speed, cpu-used (@emph{cpu-used})
1731 Set quality/speed ratio modifier. Higher values speed up the encode at the cost
1732 of quality.
1733
1734 @item nr (@emph{noise-sensitivity})
1735
1736 @item static-thresh
1737 Set a change threshold on blocks below which they will be skipped by the
1738 encoder.
1739
1740 @item slices (@emph{token-parts})
1741 Note that FFmpeg's @option{slices} option gives the total number of partitions,
1742 while @command{vpxenc}'s @option{token-parts} is given as
1743 @code{log2(partitions)}.
1744
1745 @item max-intra-rate
1746 Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
1747 means unlimited.
1748
1749 @item force_key_frames
1750 @code{VPX_EFLAG_FORCE_KF}
1751
1752 @item Alternate reference frame related
1753 @table @option
1754 @item auto-alt-ref
1755 Enable use of alternate reference frames (2-pass only).
1756 Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
1757 @item arnr-max-frames
1758 Set altref noise reduction max frame count.
1759 @item arnr-type
1760 Set altref noise reduction filter type: backward, forward, centered.
1761 @item arnr-strength
1762 Set altref noise reduction filter strength.
1763 @item rc-lookahead, lag-in-frames (@emph{lag-in-frames})
1764 Set number of frames to look ahead for frametype and ratecontrol.
1765 @end table
1766
1767 @item error-resilient
1768 Enable error resiliency features.
1769
1770 @item sharpness @var{integer}
1771 Increase sharpness at the expense of lower PSNR.
1772 The valid range is [0, 7].
1773
1774 @item VP8-specific options
1775 @table @option
1776 @item ts-parameters
1777 Sets the temporal scalability configuration using a :-separated list of
1778 key=value pairs. For example, to specify temporal scalability parameters
1779 with @code{ffmpeg}:
1780 @example
1781 ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
1782 ts_target_bitrate=250000,500000,1000000:ts_rate_decimator=4,2,1:\
1783 ts_periodicity=4:ts_layer_id=0,2,1,2 OUTPUT
1784 @end example
1785 Below is a brief explanation of each of the parameters, please
1786 refer to @code{struct vpx_codec_enc_cfg} in @code{vpx/vpx_encoder.h} for more
1787 details.
1788 @table @option
1789 @item ts_number_layers
1790 Number of temporal coding layers.
1791 @item ts_target_bitrate
1792 Target bitrate for each temporal layer.
1793 @item ts_rate_decimator
1794 Frame rate decimation factor for each temporal layer.
1795 @item ts_periodicity
1796 Length of the sequence defining frame temporal layer membership.
1797 @item ts_layer_id
1798 Template defining the membership of frames to temporal layers.
1799 @end table
1800 @end table
1801
1802 @item VP9-specific options
1803 @table @option
1804 @item lossless
1805 Enable lossless mode.
1806 @item tile-columns
1807 Set number of tile columns to use. Note this is given as
1808 @code{log2(tile_columns)}. For example, 8 tile columns would be requested by
1809 setting the @option{tile-columns} option to 3.
1810 @item tile-rows
1811 Set number of tile rows to use. Note this is given as @code{log2(tile_rows)}.
1812 For example, 4 tile rows would be requested by setting the @option{tile-rows}
1813 option to 2.
1814 @item frame-parallel
1815 Enable frame parallel decodability features.
1816 @item aq-mode
1817 Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
1818 cyclic refresh, 4: equator360).
1819 @item colorspace @emph{color-space}
1820 Set input color space. The VP9 bitstream supports signaling the following
1821 colorspaces:
1822 @table @option
1823 @item @samp{rgb} @emph{sRGB}
1824 @item @samp{bt709} @emph{bt709}
1825 @item @samp{unspecified} @emph{unknown}
1826 @item @samp{bt470bg} @emph{bt601}
1827 @item @samp{smpte170m} @emph{smpte170}
1828 @item @samp{smpte240m} @emph{smpte240}
1829 @item @samp{bt2020_ncl} @emph{bt2020}
1830 @end table
1831 @item row-mt @var{boolean}
1832 Enable row based multi-threading.
1833 @item tune-content
1834 Set content type: default (0), screen (1), film (2).
1835 @item corpus-complexity
1836 Corpus VBR mode is a variant of standard VBR where the complexity distribution
1837 midpoint is passed in rather than calculated for a specific clip or chunk.
1838
1839 The valid range is [0, 10000]. 0 (default) uses standard VBR.
1840 @item enable-tpl @var{boolean}
1841 Enable temporal dependency model.
1842 @end table
1843
1844 @end table
1845
1846 For more information about libvpx see:
1847 @url{http://www.webmproject.org/}
1848
1849 @section libwebp
1850
1851 libwebp WebP Image encoder wrapper
1852
1853 libwebp is Google's official encoder for WebP images. It can encode in either
1854 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
1855 frame. Lossless images are a separate codec developed by Google.
1856
1857 @subsection Pixel Format
1858
1859 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
1860 to limitations of the format and libwebp. Alpha is supported for either mode.
1861 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
1862 passed in for encoding lossless, the pixel format will automatically be
1863 converted using functions from libwebp. This is not ideal and is done only for
1864 convenience.
1865
1866 @subsection Options
1867
1868 @table @option
1869
1870 @item -lossless @var{boolean}
1871 Enables/Disables use of lossless mode. Default is 0.
1872
1873 @item -compression_level @var{integer}
1874 For lossy, this is a quality/speed tradeoff. Higher values give better quality
1875 for a given size at the cost of increased encoding time. For lossless, this is
1876 a size/speed tradeoff. Higher values give smaller size at the cost of increased
1877 encoding time. More specifically, it controls the number of extra algorithms
1878 and compression tools used, and varies the combination of these tools. This
1879 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
1880 Default is 4.
1881
1882 @item -qscale @var{float}
1883 For lossy encoding, this controls image quality, 0 to 100. For lossless
1884 encoding, this controls the effort and time spent at compressing more. The
1885 default value is 75. Note that for usage via libavcodec, this option is called
1886 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
1887
1888 @item -preset @var{type}
1889 Configuration preset. This does some automatic settings based on the general
1890 type of the image.
1891 @table @option
1892 @item none
1893 Do not use a preset.
1894 @item default
1895 Use the encoder default.
1896 @item picture
1897 Digital picture, like portrait, inner shot
1898 @item photo
1899 Outdoor photograph, with natural lighting
1900 @item drawing
1901 Hand or line drawing, with high-contrast details
1902 @item icon
1903 Small-sized colorful images
1904 @item text
1905 Text-like
1906 @end table
1907
1908 @end table
1909
1910 @section libx264, libx264rgb
1911
1912 x264 H.264/MPEG-4 AVC encoder wrapper.
1913
1914 This encoder requires the presence of the libx264 headers and library
1915 during configuration. You need to explicitly configure the build with
1916 @code{--enable-libx264}.
1917
1918 libx264 supports an impressive number of features, including 8x8 and
1919 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
1920 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
1921 for detail retention (adaptive quantization, psy-RD, psy-trellis).
1922
1923 Many libx264 encoder options are mapped to FFmpeg global codec
1924 options, while unique encoder options are provided through private
1925 options. Additionally the @option{x264opts} and @option{x264-params}
1926 private options allows one to pass a list of key=value tuples as accepted
1927 by the libx264 @code{x264_param_parse} function.
1928
1929 The x264 project website is at
1930 @url{http://www.videolan.org/developers/x264.html}.
1931
1932 The libx264rgb encoder is the same as libx264, except it accepts packed RGB
1933 pixel formats as input instead of YUV.
1934
1935 @subsection Supported Pixel Formats
1936
1937 x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
1938 x264's configure time. FFmpeg only supports one bit depth in one particular
1939 build. In other words, it is not possible to build one FFmpeg with multiple
1940 versions of x264 with different bit depths.
1941
1942 @subsection Options
1943
1944 The following options are supported by the libx264 wrapper. The
1945 @command{x264}-equivalent options or values are listed in parentheses
1946 for easy migration.
1947
1948 To reduce the duplication of documentation, only the private options
1949 and some others requiring special attention are documented here. For
1950 the documentation of the undocumented generic options, see
1951 @ref{codec-options,,the Codec Options chapter}.
1952
1953 To get a more accurate and extensive documentation of the libx264
1954 options, invoke the command @command{x264 --fullhelp} or consult
1955 the libx264 documentation.
1956
1957 @table @option
1958 @item b (@emph{bitrate})
1959 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1960 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
1961 kilobits/s.
1962
1963 @item bf (@emph{bframes})
1964
1965 @item g (@emph{keyint})
1966
1967 @item qmin (@emph{qpmin})
1968 Minimum quantizer scale.
1969
1970 @item qmax (@emph{qpmax})
1971 Maximum quantizer scale.
1972
1973 @item qdiff (@emph{qpstep})
1974 Maximum difference between quantizer scales.
1975
1976 @item qblur (@emph{qblur})
1977 Quantizer curve blur
1978
1979 @item qcomp (@emph{qcomp})
1980 Quantizer curve compression factor
1981
1982 @item refs (@emph{ref})
1983 Number of reference frames each P-frame can use. The range is from @var{0-16}.
1984
1985 @item sc_threshold (@emph{scenecut})
1986 Sets the threshold for the scene change detection.
1987
1988 @item trellis (@emph{trellis})
1989 Performs Trellis quantization to increase efficiency. Enabled by default.
1990
1991 @item nr  (@emph{nr})
1992
1993 @item me_range (@emph{merange})
1994 Maximum range of the motion search in pixels.
1995
1996 @item me_method (@emph{me})
1997 Set motion estimation method. Possible values in the decreasing order
1998 of speed:
1999
2000 @table @samp
2001 @item dia (@emph{dia})
2002 @item epzs (@emph{dia})
2003 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
2004 @samp{dia}.
2005 @item hex (@emph{hex})
2006 Hexagonal search with radius 2.
2007 @item umh (@emph{umh})
2008 Uneven multi-hexagon search.
2009 @item esa (@emph{esa})
2010 Exhaustive search.
2011 @item tesa (@emph{tesa})
2012 Hadamard exhaustive search (slowest).
2013 @end table
2014
2015 @item forced-idr
2016 Normally, when forcing a I-frame type, the encoder can select any type
2017 of I-frame. This option forces it to choose an IDR-frame.
2018
2019 @item subq (@emph{subme})
2020 Sub-pixel motion estimation method.
2021
2022 @item b_strategy (@emph{b-adapt})
2023 Adaptive B-frame placement decision algorithm. Use only on first-pass.
2024
2025 @item keyint_min (@emph{min-keyint})
2026 Minimum GOP size.
2027
2028 @item coder
2029 Set entropy encoder. Possible values:
2030
2031 @table @samp
2032 @item ac
2033 Enable CABAC.
2034
2035 @item vlc
2036 Enable CAVLC and disable CABAC. It generates the same effect as
2037 @command{x264}'s @option{--no-cabac} option.
2038 @end table
2039
2040 @item cmp
2041 Set full pixel motion estimation comparison algorithm. Possible values:
2042
2043 @table @samp
2044 @item chroma
2045 Enable chroma in motion estimation.
2046
2047 @item sad
2048 Ignore chroma in motion estimation. It generates the same effect as
2049 @command{x264}'s @option{--no-chroma-me} option.
2050 @end table
2051
2052 @item threads (@emph{threads})
2053 Number of encoding threads.
2054
2055 @item thread_type
2056 Set multithreading technique. Possible values:
2057
2058 @table @samp
2059 @item slice
2060 Slice-based multithreading. It generates the same effect as
2061 @command{x264}'s @option{--sliced-threads} option.
2062 @item frame
2063 Frame-based multithreading.
2064 @end table
2065
2066 @item flags
2067 Set encoding flags. It can be used to disable closed GOP and enable
2068 open GOP by setting it to @code{-cgop}. The result is similar to
2069 the behavior of @command{x264}'s @option{--open-gop} option.
2070
2071 @item rc_init_occupancy (@emph{vbv-init})
2072
2073 @item preset (@emph{preset})
2074 Set the encoding preset.
2075
2076 @item tune (@emph{tune})
2077 Set tuning of the encoding params.
2078
2079 @item profile (@emph{profile})
2080 Set profile restrictions.
2081
2082 @item fastfirstpass
2083 Enable fast settings when encoding first pass, when set to 1. When set
2084 to 0, it has the same effect of @command{x264}'s
2085 @option{--slow-firstpass} option.
2086
2087 @item crf (@emph{crf})
2088 Set the quality for constant quality mode.
2089
2090 @item crf_max (@emph{crf-max})
2091 In CRF mode, prevents VBV from lowering quality beyond this point.
2092
2093 @item qp (@emph{qp})
2094 Set constant quantization rate control method parameter.
2095
2096 @item aq-mode (@emph{aq-mode})
2097 Set AQ method. Possible values:
2098
2099 @table @samp
2100 @item none (@emph{0})
2101 Disabled.
2102
2103 @item variance (@emph{1})
2104 Variance AQ (complexity mask).
2105
2106 @item autovariance (@emph{2})
2107 Auto-variance AQ (experimental).
2108 @end table
2109
2110 @item aq-strength (@emph{aq-strength})
2111 Set AQ strength, reduce blocking and blurring in flat and textured areas.
2112
2113 @item psy
2114 Use psychovisual optimizations when set to 1. When set to 0, it has the
2115 same effect as @command{x264}'s @option{--no-psy} option.
2116
2117 @item psy-rd  (@emph{psy-rd})
2118 Set strength of psychovisual optimization, in
2119 @var{psy-rd}:@var{psy-trellis} format.
2120
2121 @item rc-lookahead (@emph{rc-lookahead})
2122 Set number of frames to look ahead for frametype and ratecontrol.
2123
2124 @item weightb
2125 Enable weighted prediction for B-frames when set to 1. When set to 0,
2126 it has the same effect as @command{x264}'s @option{--no-weightb} option.
2127
2128 @item weightp (@emph{weightp})
2129 Set weighted prediction method for P-frames. Possible values:
2130
2131 @table @samp
2132 @item none (@emph{0})
2133 Disabled
2134 @item simple (@emph{1})
2135 Enable only weighted refs
2136 @item smart (@emph{2})
2137 Enable both weighted refs and duplicates
2138 @end table
2139
2140 @item ssim (@emph{ssim})
2141 Enable calculation and printing SSIM stats after the encoding.
2142
2143 @item intra-refresh (@emph{intra-refresh})
2144 Enable the use of Periodic Intra Refresh instead of IDR frames when set
2145 to 1.
2146
2147 @item avcintra-class (@emph{class})
2148 Configure the encoder to generate AVC-Intra.
2149 Valid values are 50,100 and 200
2150
2151 @item bluray-compat (@emph{bluray-compat})
2152 Configure the encoder to be compatible with the bluray standard.
2153 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
2154
2155 @item b-bias (@emph{b-bias})
2156 Set the influence on how often B-frames are used.
2157
2158 @item b-pyramid (@emph{b-pyramid})
2159 Set method for keeping of some B-frames as references. Possible values:
2160
2161 @table @samp
2162 @item none (@emph{none})
2163 Disabled.
2164 @item strict (@emph{strict})
2165 Strictly hierarchical pyramid.
2166 @item normal (@emph{normal})
2167 Non-strict (not Blu-ray compatible).
2168 @end table
2169
2170 @item mixed-refs
2171 Enable the use of one reference per partition, as opposed to one
2172 reference per macroblock when set to 1. When set to 0, it has the
2173 same effect as @command{x264}'s @option{--no-mixed-refs} option.
2174
2175 @item 8x8dct
2176 Enable adaptive spatial transform (high profile 8x8 transform)
2177 when set to 1. When set to 0, it has the same effect as
2178 @command{x264}'s @option{--no-8x8dct} option.
2179
2180 @item fast-pskip
2181 Enable early SKIP detection on P-frames when set to 1. When set
2182 to 0, it has the same effect as @command{x264}'s
2183 @option{--no-fast-pskip} option.
2184
2185 @item aud (@emph{aud})
2186 Enable use of access unit delimiters when set to 1.
2187
2188 @item mbtree
2189 Enable use macroblock tree ratecontrol when set to 1. When set
2190 to 0, it has the same effect as @command{x264}'s
2191 @option{--no-mbtree} option.
2192
2193 @item deblock (@emph{deblock})
2194 Set loop filter parameters, in @var{alpha}:@var{beta} form.
2195
2196 @item cplxblur (@emph{cplxblur})
2197 Set fluctuations reduction in QP (before curve compression).
2198
2199 @item partitions (@emph{partitions})
2200 Set partitions to consider as a comma-separated list of. Possible
2201 values in the list:
2202
2203 @table @samp
2204 @item p8x8
2205 8x8 P-frame partition.
2206 @item p4x4
2207 4x4 P-frame partition.
2208 @item b8x8
2209 4x4 B-frame partition.
2210 @item i8x8
2211 8x8 I-frame partition.
2212 @item i4x4
2213 4x4 I-frame partition.
2214 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
2215 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
2216 option) to be enabled.)
2217 @item none (@emph{none})
2218 Do not consider any partitions.
2219 @item all (@emph{all})
2220 Consider every partition.
2221 @end table
2222
2223 @item direct-pred (@emph{direct})
2224 Set direct MV prediction mode. Possible values:
2225
2226 @table @samp
2227 @item none (@emph{none})
2228 Disable MV prediction.
2229 @item spatial (@emph{spatial})
2230 Enable spatial predicting.
2231 @item temporal (@emph{temporal})
2232 Enable temporal predicting.
2233 @item auto (@emph{auto})
2234 Automatically decided.
2235 @end table
2236
2237 @item slice-max-size (@emph{slice-max-size})
2238 Set the limit of the size of each slice in bytes. If not specified
2239 but RTP payload size (@option{ps}) is specified, that is used.
2240
2241 @item stats (@emph{stats})
2242 Set the file name for multi-pass stats.
2243
2244 @item nal-hrd (@emph{nal-hrd})
2245 Set signal HRD information (requires @option{vbv-bufsize} to be set).
2246 Possible values:
2247
2248 @table @samp
2249 @item none (@emph{none})
2250 Disable HRD information signaling.
2251 @item vbr (@emph{vbr})
2252 Variable bit rate.
2253 @item cbr (@emph{cbr})
2254 Constant bit rate (not allowed in MP4 container).
2255 @end table
2256
2257 @item x264opts (N.A.)
2258 Set any x264 option, see @command{x264 --fullhelp} for a list.
2259
2260 Argument is a list of @var{key}=@var{value} couples separated by
2261 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
2262 themselves, use "," instead. They accept it as well since long ago but this
2263 is kept undocumented for some reason.
2264
2265 For example to specify libx264 encoding options with @command{ffmpeg}:
2266 @example
2267 ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
2268 @end example
2269
2270 @item a53cc @var{boolean}
2271 Import closed captions (which must be ATSC compatible format) into output.
2272 Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
2273
2274 @item x264-params (N.A.)
2275 Override the x264 configuration using a :-separated list of key=value
2276 parameters.
2277
2278 This option is functionally the same as the @option{x264opts}, but is
2279 duplicated for compatibility with the Libav fork.
2280
2281 For example to specify libx264 encoding options with @command{ffmpeg}:
2282 @example
2283 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
2284 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
2285 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
2286 @end example
2287 @end table
2288
2289 Encoding ffpresets for common usages are provided so they can be used with the
2290 general presets system (e.g. passing the @option{pre} option).
2291
2292 @section libx265
2293
2294 x265 H.265/HEVC encoder wrapper.
2295
2296 This encoder requires the presence of the libx265 headers and library
2297 during configuration. You need to explicitly configure the build with
2298 @option{--enable-libx265}.
2299
2300 @subsection Options
2301
2302 @table @option
2303 @item preset
2304 Set the x265 preset.
2305
2306 @item tune
2307 Set the x265 tune parameter.
2308
2309 @item profile
2310 Set profile restrictions.
2311
2312 @item crf
2313 Set the quality for constant quality mode.
2314
2315 @item forced-idr
2316 Normally, when forcing a I-frame type, the encoder can select any type
2317 of I-frame. This option forces it to choose an IDR-frame.
2318
2319 @item x265-params
2320 Set x265 options using a list of @var{key}=@var{value} couples separated
2321 by ":". See @command{x265 --help} for a list of options.
2322
2323 For example to specify libx265 encoding options with @option{-x265-params}:
2324
2325 @example
2326 ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
2327 @end example
2328 @end table
2329
2330 @section libxavs2
2331
2332 xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
2333
2334 This encoder requires the presence of the libxavs2 headers and library
2335 during configuration. You need to explicitly configure the build with
2336 @option{--enable-libxavs2}.
2337
2338 @subsection Options
2339
2340 @table @option
2341 @item lcu_row_threads
2342 Set the number of parallel threads for rows from 1 to 8 (default 5).
2343
2344 @item initial_qp
2345 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2346 used to set the initial qp for the first frame.
2347
2348 @item qp
2349 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2350 used to set the qp value under constant-QP mode.
2351
2352 @item max_qp
2353 Set the max qp for rate control from 1 to 63 (default 55).
2354
2355 @item min_qp
2356 Set the min qp for rate control from 1 to 63 (default 20).
2357
2358 @item speed_level
2359 Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
2360
2361 @item log_level
2362 Set the log level from -1 to 3 (default 0). -1: none, 0: error,
2363 1: warning, 2: info, 3: debug.
2364
2365 @item xavs2-params
2366 Set xavs2 options using a list of @var{key}=@var{value} couples separated
2367 by ":".
2368
2369 For example to specify libxavs2 encoding options with @option{-xavs2-params}:
2370
2371 @example
2372 ffmpeg -i input -c:v libxavs2 -xavs2-params preset_level=5 output.avs2
2373 @end example
2374 @end table
2375
2376 @section libxvid
2377
2378 Xvid MPEG-4 Part 2 encoder wrapper.
2379
2380 This encoder requires the presence of the libxvidcore headers and library
2381 during configuration. You need to explicitly configure the build with
2382 @code{--enable-libxvid --enable-gpl}.
2383
2384 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
2385 users can encode to this format without this library.
2386
2387 @subsection Options
2388
2389 The following options are supported by the libxvid wrapper. Some of
2390 the following options are listed but are not documented, and
2391 correspond to shared codec options. See @ref{codec-options,,the Codec
2392 Options chapter} for their documentation. The other shared options
2393 which are not listed have no effect for the libxvid encoder.
2394
2395 @table @option
2396 @item b
2397
2398 @item g
2399
2400 @item qmin
2401
2402 @item qmax
2403
2404 @item mpeg_quant
2405
2406 @item threads
2407
2408 @item bf
2409
2410 @item b_qfactor
2411
2412 @item b_qoffset
2413
2414 @item flags
2415 Set specific encoding flags. Possible values:
2416
2417 @table @samp
2418
2419 @item mv4
2420 Use four motion vector by macroblock.
2421
2422 @item aic
2423 Enable high quality AC prediction.
2424
2425 @item gray
2426 Only encode grayscale.
2427
2428 @item gmc
2429 Enable the use of global motion compensation (GMC).
2430
2431 @item qpel
2432 Enable quarter-pixel motion compensation.
2433
2434 @item cgop
2435 Enable closed GOP.
2436
2437 @item global_header
2438 Place global headers in extradata instead of every keyframe.
2439
2440 @end table
2441
2442 @item trellis
2443
2444 @item me_method
2445 Set motion estimation method. Possible values in decreasing order of
2446 speed and increasing order of quality:
2447
2448 @table @samp
2449 @item zero
2450 Use no motion estimation (default).
2451
2452 @item phods
2453 @item x1
2454 @item log
2455 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
2456 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
2457 @samp{phods}.
2458
2459 @item epzs
2460 Enable all of the things described above, plus advanced diamond zonal
2461 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
2462 estimation on chroma planes.
2463
2464 @item full
2465 Enable all of the things described above, plus extended 16x16 and 8x8
2466 blocks search.
2467 @end table
2468
2469 @item mbd
2470 Set macroblock decision algorithm. Possible values in the increasing
2471 order of quality:
2472
2473 @table @samp
2474 @item simple
2475 Use macroblock comparing function algorithm (default).
2476
2477 @item bits
2478 Enable rate distortion-based half pixel and quarter pixel refinement for
2479 16x16 blocks.
2480
2481 @item rd
2482 Enable all of the things described above, plus rate distortion-based
2483 half pixel and quarter pixel refinement for 8x8 blocks, and rate
2484 distortion-based search using square pattern.
2485 @end table
2486
2487 @item lumi_aq
2488 Enable lumi masking adaptive quantization when set to 1. Default is 0
2489 (disabled).
2490
2491 @item variance_aq
2492 Enable variance adaptive quantization when set to 1. Default is 0
2493 (disabled).
2494
2495 When combined with @option{lumi_aq}, the resulting quality will not
2496 be better than any of the two specified individually. In other
2497 words, the resulting quality will be the worse one of the two
2498 effects.
2499
2500 @item ssim
2501 Set structural similarity (SSIM) displaying method. Possible values:
2502
2503 @table @samp
2504 @item off
2505 Disable displaying of SSIM information.
2506
2507 @item avg
2508 Output average SSIM at the end of encoding to stdout. The format of
2509 showing the average SSIM is:
2510
2511 @example
2512 Average SSIM: %f
2513 @end example
2514
2515 For users who are not familiar with C, %f means a float number, or
2516 a decimal (e.g. 0.939232).
2517
2518 @item frame
2519 Output both per-frame SSIM data during encoding and average SSIM at
2520 the end of encoding to stdout. The format of per-frame information
2521 is:
2522
2523 @example
2524        SSIM: avg: %1.3f min: %1.3f max: %1.3f
2525 @end example
2526
2527 For users who are not familiar with C, %1.3f means a float number
2528 rounded to 3 digits after the dot (e.g. 0.932).
2529
2530 @end table
2531
2532 @item ssim_acc
2533 Set SSIM accuracy. Valid options are integers within the range of
2534 0-4, while 0 gives the most accurate result and 4 computes the
2535 fastest.
2536
2537 @end table
2538
2539 @section mpeg2
2540
2541 MPEG-2 video encoder.
2542
2543 @subsection Options
2544
2545 @table @option
2546 @item seq_disp_ext @var{integer}
2547 Specifies if the encoder should write a sequence_display_extension to the
2548 output.
2549 @table @option
2550 @item -1
2551 @itemx auto
2552 Decide automatically to write it or not (this is the default) by checking if
2553 the data to be written is different from the default or unspecified values.
2554 @item 0
2555 @itemx never
2556 Never write it.
2557 @item 1
2558 @itemx always
2559 Always write it.
2560 @end table
2561 @item video_format @var{integer}
2562 Specifies the video_format written into the sequence display extension
2563 indicating the source of the video pictures. The default is @samp{unspecified},
2564 can be @samp{component}, @samp{pal}, @samp{ntsc}, @samp{secam} or @samp{mac}.
2565 For maximum compatibility, use @samp{component}.
2566 @end table
2567
2568 @section png
2569
2570 PNG image encoder.
2571
2572 @subsection Private options
2573
2574 @table @option
2575 @item dpi @var{integer}
2576 Set physical density of pixels, in dots per inch, unset by default
2577 @item dpm @var{integer}
2578 Set physical density of pixels, in dots per meter, unset by default
2579 @end table
2580
2581 @section ProRes
2582
2583 Apple ProRes encoder.
2584
2585 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
2586 The used encoder can be chosen with the @code{-vcodec} option.
2587
2588 @subsection Private Options for prores-ks
2589
2590 @table @option
2591 @item profile @var{integer}
2592 Select the ProRes profile to encode
2593 @table @samp
2594 @item proxy
2595 @item lt
2596 @item standard
2597 @item hq
2598 @item 4444
2599 @item 4444xq
2600 @end table
2601
2602 @item quant_mat @var{integer}
2603 Select quantization matrix.
2604 @table @samp
2605 @item auto
2606 @item default
2607 @item proxy
2608 @item lt
2609 @item standard
2610 @item hq
2611 @end table
2612 If set to @var{auto}, the matrix matching the profile will be picked.
2613 If not set, the matrix providing the highest quality, @var{default}, will be
2614 picked.
2615
2616 @item bits_per_mb @var{integer}
2617 How many bits to allot for coding one macroblock. Different profiles use
2618 between 200 and 2400 bits per macroblock, the maximum is 8000.
2619
2620 @item mbs_per_slice @var{integer}
2621 Number of macroblocks in each slice (1-8); the default value (8)
2622 should be good in almost all situations.
2623
2624 @item vendor @var{string}
2625 Override the 4-byte vendor ID.
2626 A custom vendor ID like @var{apl0} would claim the stream was produced by
2627 the Apple encoder.
2628
2629 @item alpha_bits @var{integer}
2630 Specify number of bits for alpha component.
2631 Possible values are @var{0}, @var{8} and @var{16}.
2632 Use @var{0} to disable alpha plane coding.
2633
2634 @end table
2635
2636 @subsection Speed considerations
2637
2638 In the default mode of operation the encoder has to honor frame constraints
2639 (i.e. not produce frames with size bigger than requested) while still making
2640 output picture as good as possible.
2641 A frame containing a lot of small details is harder to compress and the encoder
2642 would spend more time searching for appropriate quantizers for each slice.
2643
2644 Setting a higher @option{bits_per_mb} limit will improve the speed.
2645
2646 For the fastest encoding speed set the @option{qscale} parameter (4 is the
2647 recommended value) and do not set a size constraint.
2648
2649 @section QSV encoders
2650
2651 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
2652
2653 The ratecontrol method is selected as follows:
2654
2655 @itemize @bullet
2656 @item
2657 When @option{global_quality} is specified, a quality-based mode is used.
2658 Specifically this means either
2659 @itemize @minus
2660 @item
2661 @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
2662 also set (the @option{-qscale} ffmpeg option).
2663
2664 @item
2665 @var{LA_ICQ} - intelligent constant quality with lookahead, when the
2666 @option{look_ahead} option is also set.
2667
2668 @item
2669 @var{ICQ} -- intelligent constant quality otherwise.
2670 @end itemize
2671
2672 @item
2673 Otherwise, a bitrate-based mode is used. For all of those, you should specify at
2674 least the desired average bitrate with the @option{b} option.
2675 @itemize @minus
2676 @item
2677 @var{LA} - VBR with lookahead, when the @option{look_ahead} option is specified.
2678
2679 @item
2680 @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
2681
2682 @item
2683 @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
2684 the average bitrate.
2685
2686 @item
2687 @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
2688 than the average bitrate.
2689
2690 @item
2691 @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
2692 is further configured by the @option{avbr_accuracy} and
2693 @option{avbr_convergence} options.
2694 @end itemize
2695 @end itemize
2696
2697 Note that depending on your system, a different mode than the one you specified
2698 may be selected by the encoder. Set the verbosity level to @var{verbose} or
2699 higher to see the actual settings used by the QSV runtime.
2700
2701 Additional libavcodec global options are mapped to MSDK options as follows:
2702
2703 @itemize
2704 @item
2705 @option{g/gop_size} -> @option{GopPicSize}
2706
2707 @item
2708 @option{bf/max_b_frames}+1 -> @option{GopRefDist}
2709
2710 @item
2711 @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
2712 @option{InitialDelayInKB}
2713
2714 @item
2715 @option{slices} -> @option{NumSlice}
2716
2717 @item
2718 @option{refs} -> @option{NumRefFrame}
2719
2720 @item
2721 @option{b_strategy/b_frame_strategy} -> @option{BRefType}
2722
2723 @item
2724 @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
2725
2726 @item
2727 For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
2728 @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
2729 and @var{QPP} and @var{QPB} respectively.
2730
2731 @item
2732 Setting the @option{coder} option to the value @var{vlc} will make the H.264
2733 encoder use CAVLC instead of CABAC.
2734
2735 @end itemize
2736
2737 @section snow
2738
2739 @subsection Options
2740
2741 @table @option
2742 @item iterative_dia_size
2743 dia size for the iterative motion estimation
2744 @end table
2745
2746 @section VAAPI encoders
2747
2748 Wrappers for hardware encoders accessible via VAAPI.
2749
2750 These encoders only accept input in VAAPI hardware surfaces.  If you have input
2751 in software frames, use the @option{hwupload} filter to upload them to the GPU.
2752
2753 The following standard libavcodec options are used:
2754 @itemize
2755 @item
2756 @option{g} / @option{gop_size}
2757 @item
2758 @option{bf} / @option{max_b_frames}
2759 @item
2760 @option{profile}
2761
2762 If not set, this will be determined automatically from the format of the input
2763 frames and the profiles supported by the driver.
2764 @item
2765 @option{level}
2766 @item
2767 @option{b} / @option{bit_rate}
2768 @item
2769 @option{maxrate} / @option{rc_max_rate}
2770 @item
2771 @option{bufsize} / @option{rc_buffer_size}
2772 @item
2773 @option{rc_init_occupancy} / @option{rc_initial_buffer_occupancy}
2774 @item
2775 @option{compression_level}
2776
2777 Speed / quality tradeoff: higher values are faster / worse quality.
2778 @item
2779 @option{q} / @option{global_quality}
2780
2781 Size / quality tradeoff: higher values are smaller / worse quality.
2782 @item
2783 @option{qmin}
2784 @item
2785 @option{qmax}
2786 @item
2787 @option{i_qfactor} / @option{i_quant_factor}
2788 @item
2789 @option{i_qoffset} / @option{i_quant_offset}
2790 @item
2791 @option{b_qfactor} / @option{b_quant_factor}
2792 @item
2793 @option{b_qoffset} / @option{b_quant_offset}
2794 @item
2795 @option{slices}
2796 @end itemize
2797
2798 All encoders support the following options:
2799 @itemize
2800 @item
2801 @option{low_power}
2802
2803 Some drivers/platforms offer a second encoder for some codecs intended to use
2804 less power than the default encoder; setting this option will attempt to use
2805 that encoder.  Note that it may support a reduced feature set, so some other
2806 options may not be available in this mode.
2807 @end itemize
2808
2809 Each encoder also has its own specific options:
2810 @table @option
2811
2812 @item h264_vaapi
2813 @option{profile} sets the value of @emph{profile_idc} and the @emph{constraint_set*_flag}s.
2814 @option{level} sets the value of @emph{level_idc}.
2815
2816 @table @option
2817 @item coder
2818 Set entropy encoder (default is @emph{cabac}).  Possible values:
2819
2820 @table @samp
2821 @item ac
2822 @item cabac
2823 Use CABAC.
2824
2825 @item vlc
2826 @item cavlc
2827 Use CAVLC.
2828 @end table
2829
2830 @item aud
2831 Include access unit delimiters in the stream (not included by default).
2832
2833 @item sei
2834 Set SEI message types to include.
2835 Some combination of the following values:
2836 @table @samp
2837 @item identifier
2838 Include a @emph{user_data_unregistered} message containing information about
2839 the encoder.
2840 @item timing
2841 Include picture timing parameters (@emph{buffering_period} and
2842 @emph{pic_timing} messages).
2843 @item recovery_point
2844 Include recovery points where appropriate (@emph{recovery_point} messages).
2845 @end table
2846
2847 @end table
2848
2849 @item hevc_vaapi
2850 @option{profile} and @option{level} set the values of
2851 @emph{general_profile_idc} and @emph{general_level_idc} respectively.
2852
2853 @table @option
2854 @item aud
2855 Include access unit delimiters in the stream (not included by default).
2856
2857 @item tier
2858 Set @emph{general_tier_flag}.  This may affect the level chosen for the stream
2859 if it is not explicitly specified.
2860
2861 @item sei
2862 Set SEI message types to include.
2863 Some combination of the following values:
2864 @table @samp
2865 @item hdr
2866 Include HDR metadata if the input frames have it
2867 (@emph{mastering_display_colour_volume} and @emph{content_light_level}
2868 messages).
2869 @end table
2870
2871 @end table
2872
2873 @item mjpeg_vaapi
2874 Only baseline DCT encoding is supported.  The encoder always uses the standard
2875 quantisation and huffman tables - @option{global_quality} scales the standard
2876 quantisation table (range 1-100).
2877
2878 For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported.  RGB is also
2879 supported, and will create an RGB JPEG.
2880
2881 @table @option
2882 @item jfif
2883 Include JFIF header in each frame (not included by default).
2884 @item huffman
2885 Include standard huffman tables (on by default).  Turning this off will save
2886 a few hundred bytes in each output frame, but may lose compatibility with some
2887 JPEG decoders which don't fully handle MJPEG.
2888 @end table
2889
2890 @item mpeg2_vaapi
2891 @option{profile} and @option{level} set the value of @emph{profile_and_level_indication}.
2892
2893 @item vp8_vaapi
2894 B-frames are not supported.
2895
2896 @option{global_quality} sets the @emph{q_idx} used for non-key frames (range 0-127).
2897
2898 @table @option
2899 @item loop_filter_level
2900 @item loop_filter_sharpness
2901 Manually set the loop filter parameters.
2902 @end table
2903
2904 @item vp9_vaapi
2905 @option{global_quality} sets the @emph{q_idx} used for P-frames (range 0-255).
2906
2907 @table @option
2908 @item loop_filter_level
2909 @item loop_filter_sharpness
2910 Manually set the loop filter parameters.
2911 @end table
2912
2913 B-frames are supported, but the output stream is always in encode order rather than display
2914 order.  If B-frames are enabled, it may be necessary to use the @option{vp9_raw_reorder}
2915 bitstream filter to modify the output stream to display frames in the correct order.
2916
2917 Only normal frames are produced - the @option{vp9_superframe} bitstream filter may be
2918 required to produce a stream usable with all decoders.
2919
2920 @end table
2921
2922 @section vc2
2923
2924 SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
2925 professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
2926 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
2927 other tasks which require low overhead and low compression (like screen
2928 recording).
2929
2930 @subsection Options
2931
2932 @table @option
2933
2934 @item b
2935 Sets target video bitrate. Usually that's around 1:6 of the uncompressed
2936 video bitrate (e.g. for 1920x1080 50fps yuv422p10 that's around 400Mbps). Higher
2937 values (close to the uncompressed bitrate) turn on lossless compression mode.
2938
2939 @item field_order
2940 Enables field coding when set (e.g. to tt - top field first) for interlaced
2941 inputs. Should increase compression with interlaced content as it splits the
2942 fields and encodes each separately.
2943
2944 @item wavelet_depth
2945 Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
2946 Lower values reduce compression and quality. Less capable decoders may not be
2947 able to handle values of @option{wavelet_depth} over 3.
2948
2949 @item wavelet_type
2950 Sets the transform type. Currently only @var{5_3} (LeGall) and @var{9_7}
2951 (Deslauriers-Dubuc)
2952 are implemented, with 9_7 being the one with better compression and thus
2953 is the default.
2954
2955 @item slice_width
2956 @item slice_height
2957 Sets the slice size for each slice. Larger values result in better compression.
2958 For compatibility with other more limited decoders use @option{slice_width} of
2959 32 and @option{slice_height} of 8.
2960
2961 @item tolerance
2962 Sets the undershoot tolerance of the rate control system in percent. This is
2963 to prevent an expensive search from being run.
2964
2965 @item qm
2966 Sets the quantization matrix preset to use by default or when @option{wavelet_depth}
2967 is set to 5
2968 @itemize @minus
2969 @item
2970 @var{default}
2971 Uses the default quantization matrix from the specifications, extended with
2972 values for the fifth level. This provides a good balance between keeping detail
2973 and omitting artifacts.
2974
2975 @item
2976 @var{flat}
2977 Use a completely zeroed out quantization matrix. This increases PSNR but might
2978 reduce perception. Use in bogus benchmarks.
2979
2980 @item
2981 @var{color}
2982 Reduces detail but attempts to preserve color at extremely low bitrates.
2983 @end itemize
2984
2985 @end table
2986
2987 @c man end VIDEO ENCODERS
2988
2989 @chapter Subtitles Encoders
2990 @c man begin SUBTITLES ENCODERS
2991
2992 @section dvdsub
2993
2994 This codec encodes the bitmap subtitle format that is used in DVDs.
2995 Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
2996 and they can also be used in Matroska files.
2997
2998 @subsection Options
2999
3000 @table @option
3001 @item even_rows_fix
3002 When set to 1, enable a work-around that makes the number of pixel rows
3003 even in all subtitles.  This fixes a problem with some players that
3004 cut off the bottom row if the number is odd.  The work-around just adds
3005 a fully transparent row if needed.  The overhead is low, typically
3006 one byte per subtitle on average.
3007
3008 By default, this work-around is disabled.
3009 @end table
3010
3011 @c man end SUBTITLES ENCODERS