avcodec: Add librav1e encoder
[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 eld_v2
737 Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1,
738 disabled if set to 0.
739
740 Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) > (4.0.0).
741
742 Default value is 0.
743
744 @item signaling
745 Set SBR/PS signaling style.
746
747 It can assume one of the following values:
748 @table @samp
749 @item default
750 choose signaling implicitly (explicit hierarchical by default,
751 implicit if global header is disabled)
752
753 @item implicit
754 implicit backwards compatible signaling
755
756 @item explicit_sbr
757 explicit SBR, implicit PS signaling
758
759 @item explicit_hierarchical
760 explicit hierarchical signaling
761 @end table
762
763 Default value is @samp{default}.
764
765 @item latm
766 Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
767
768 Default value is 0.
769
770 @item header_period
771 Set StreamMuxConfig and PCE repetition period (in frames) for sending
772 in-band configuration buffers within LATM/LOAS transport layer.
773
774 Must be a 16-bits non-negative integer.
775
776 Default value is 0.
777
778 @item vbr
779 Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
780 good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
781 (Constant Bit Rate) is enabled.
782
783 Currently only the @samp{aac_low} profile supports VBR encoding.
784
785 VBR modes 1-5 correspond to roughly the following average bit rates:
786
787 @table @samp
788 @item 1
789 32 kbps/channel
790 @item 2
791 40 kbps/channel
792 @item 3
793 48-56 kbps/channel
794 @item 4
795 64 kbps/channel
796 @item 5
797 about 80-96 kbps/channel
798 @end table
799
800 Default value is 0.
801 @end table
802
803 @subsection Examples
804
805 @itemize
806 @item
807 Use @command{ffmpeg} to convert an audio file to VBR AAC in an M4A (MP4)
808 container:
809 @example
810 ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
811 @end example
812
813 @item
814 Use @command{ffmpeg} to convert an audio file to CBR 64k kbps AAC, using the
815 High-Efficiency AAC profile:
816 @example
817 ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
818 @end example
819 @end itemize
820
821 @anchor{libmp3lame}
822 @section libmp3lame
823
824 LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper.
825
826 Requires the presence of the libmp3lame headers and library during
827 configuration. You need to explicitly configure the build with
828 @code{--enable-libmp3lame}.
829
830 See @ref{libshine} for a fixed-point MP3 encoder, although with a
831 lower quality.
832
833 @subsection Options
834
835 The following options are supported by the libmp3lame wrapper. The
836 @command{lame}-equivalent of the options are listed in parentheses.
837
838 @table @option
839 @item b (@emph{-b})
840 Set bitrate expressed in bits/s for CBR or ABR. LAME @code{bitrate} is
841 expressed in kilobits/s.
842
843 @item q (@emph{-V})
844 Set constant quality setting for VBR. This option is valid only
845 using the @command{ffmpeg} command-line tool. For library interface
846 users, use @option{global_quality}.
847
848 @item compression_level (@emph{-q})
849 Set algorithm quality. Valid arguments are integers in the 0-9 range,
850 with 0 meaning highest quality but slowest, and 9 meaning fastest
851 while producing the worst quality.
852
853 @item cutoff (@emph{--lowpass})
854 Set lowpass cutoff frequency. If unspecified, the encoder dynamically
855 adjusts the cutoff.
856
857 @item reservoir
858 Enable use of bit reservoir when set to 1. Default value is 1. LAME
859 has this enabled by default, but can be overridden by use
860 @option{--nores} option.
861
862 @item joint_stereo (@emph{-m j})
863 Enable the encoder to use (on a frame by frame basis) either L/R
864 stereo or mid/side stereo. Default value is 1.
865
866 @item abr (@emph{--abr})
867 Enable the encoder to use ABR when set to 1. The @command{lame}
868 @option{--abr} sets the target bitrate, while this options only
869 tells FFmpeg to use ABR still relies on @option{b} to set bitrate.
870
871 @end table
872
873 @section libopencore-amrnb
874
875 OpenCORE Adaptive Multi-Rate Narrowband encoder.
876
877 Requires the presence of the libopencore-amrnb headers and library during
878 configuration. You need to explicitly configure the build with
879 @code{--enable-libopencore-amrnb --enable-version3}.
880
881 This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
882 but you can override it by setting @option{strict} to @samp{unofficial} or
883 lower.
884
885 @subsection Options
886
887 @table @option
888
889 @item b
890 Set bitrate in bits per second. Only the following bitrates are supported,
891 otherwise libavcodec will round to the nearest valid bitrate.
892
893 @table @option
894 @item 4750
895 @item 5150
896 @item 5900
897 @item 6700
898 @item 7400
899 @item 7950
900 @item 10200
901 @item 12200
902 @end table
903
904 @item dtx
905 Allow discontinuous transmission (generate comfort noise) when set to 1. The
906 default value is 0 (disabled).
907
908 @end table
909
910 @section libopus
911
912 libopus Opus Interactive Audio Codec encoder wrapper.
913
914 Requires the presence of the libopus headers and library during
915 configuration. You need to explicitly configure the build with
916 @code{--enable-libopus}.
917
918 @subsection Option Mapping
919
920 Most libopus options are modelled after the @command{opusenc} utility from
921 opus-tools. The following is an option mapping chart describing options
922 supported by the libopus wrapper, and their @command{opusenc}-equivalent
923 in parentheses.
924
925 @table @option
926
927 @item b (@emph{bitrate})
928 Set the bit rate in bits/s.  FFmpeg's @option{b} option is
929 expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
930 kilobits/s.
931
932 @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
933 Set VBR mode. The FFmpeg @option{vbr} option has the following
934 valid arguments, with the @command{opusenc} equivalent options
935 in parentheses:
936
937 @table @samp
938 @item off (@emph{hard-cbr})
939 Use constant bit rate encoding.
940
941 @item on (@emph{vbr})
942 Use variable bit rate encoding (the default).
943
944 @item constrained (@emph{cvbr})
945 Use constrained variable bit rate encoding.
946 @end table
947
948 @item compression_level (@emph{comp})
949 Set encoding algorithm complexity. Valid options are integers in
950 the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
951 gives the highest quality but slowest encoding. The default is 10.
952
953 @item frame_duration (@emph{framesize})
954 Set maximum frame size, or duration of a frame in milliseconds. The
955 argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
956 frame sizes achieve lower latency but less quality at a given bitrate.
957 Sizes greater than 20ms are only interesting at fairly low bitrates.
958 The default is 20ms.
959
960 @item packet_loss (@emph{expect-loss})
961 Set expected packet loss percentage. The default is 0.
962
963 @item application (N.A.)
964 Set intended application type. Valid options are listed below:
965
966 @table @samp
967 @item voip
968 Favor improved speech intelligibility.
969 @item audio
970 Favor faithfulness to the input (the default).
971 @item lowdelay
972 Restrict to only the lowest delay modes.
973 @end table
974
975 @item cutoff (N.A.)
976 Set cutoff bandwidth in Hz. The argument must be exactly one of the
977 following: 4000, 6000, 8000, 12000, or 20000, corresponding to
978 narrowband, mediumband, wideband, super wideband, and fullband
979 respectively. The default is 0 (cutoff disabled).
980
981 @item mapping_family (@emph{mapping_family})
982 Set channel mapping family to be used by the encoder. The default value of -1
983 uses mapping family 0 for mono and stereo inputs, and mapping family 1
984 otherwise. The default also disables the surround masking and LFE bandwidth
985 optimzations in libopus, and requires that the input contains 8 channels or
986 fewer.
987
988 Other values include 0 for mono and stereo, 1 for surround sound with masking
989 and LFE bandwidth optimizations, and 255 for independent streams with an
990 unspecified channel layout.
991
992 @item apply_phase_inv (N.A.) (requires libopus >= 1.2)
993 If set to 0, disables the use of phase inversion for intensity stereo,
994 improving the quality of mono downmixes, but slightly reducing normal stereo
995 quality. The default is 1 (phase inversion enabled).
996
997 @end table
998
999 @anchor{libshine}
1000 @section libshine
1001
1002 Shine Fixed-Point MP3 encoder wrapper.
1003
1004 Shine is a fixed-point MP3 encoder. It has a far better performance on
1005 platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
1006 However, as it is more targeted on performance than quality, it is not on par
1007 with LAME and other production-grade encoders quality-wise. Also, according to
1008 the project's homepage, this encoder may not be free of bugs as the code was
1009 written a long time ago and the project was dead for at least 5 years.
1010
1011 This encoder only supports stereo and mono input. This is also CBR-only.
1012
1013 The original project (last updated in early 2007) is at
1014 @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
1015 updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
1016
1017 Requires the presence of the libshine headers and library during
1018 configuration. You need to explicitly configure the build with
1019 @code{--enable-libshine}.
1020
1021 See also @ref{libmp3lame}.
1022
1023 @subsection Options
1024
1025 The following options are supported by the libshine wrapper. The
1026 @command{shineenc}-equivalent of the options are listed in parentheses.
1027
1028 @table @option
1029 @item b (@emph{-b})
1030 Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
1031 is expressed in kilobits/s.
1032
1033 @end table
1034
1035 @section libtwolame
1036
1037 TwoLAME MP2 encoder wrapper.
1038
1039 Requires the presence of the libtwolame headers and library during
1040 configuration. You need to explicitly configure the build with
1041 @code{--enable-libtwolame}.
1042
1043 @subsection Options
1044
1045 The following options are supported by the libtwolame wrapper. The
1046 @command{twolame}-equivalent options follow the FFmpeg ones and are in
1047 parentheses.
1048
1049 @table @option
1050 @item b (@emph{-b})
1051 Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
1052 option is expressed in kilobits/s. Default value is 128k.
1053
1054 @item q (@emph{-V})
1055 Set quality for experimental VBR support. Maximum value range is
1056 from -50 to 50, useful range is from -10 to 10. The higher the
1057 value, the better the quality. This option is valid only using the
1058 @command{ffmpeg} command-line tool. For library interface users,
1059 use @option{global_quality}.
1060
1061 @item mode (@emph{--mode})
1062 Set the mode of the resulting audio. Possible values:
1063
1064 @table @samp
1065 @item auto
1066 Choose mode automatically based on the input. This is the default.
1067 @item stereo
1068 Stereo
1069 @item joint_stereo
1070 Joint stereo
1071 @item dual_channel
1072 Dual channel
1073 @item mono
1074 Mono
1075 @end table
1076
1077 @item psymodel (@emph{--psyc-mode})
1078 Set psychoacoustic model to use in encoding. The argument must be
1079 an integer between -1 and 4, inclusive. The higher the value, the
1080 better the quality. The default value is 3.
1081
1082 @item energy_levels (@emph{--energy})
1083 Enable energy levels extensions when set to 1. The default value is
1084 0 (disabled).
1085
1086 @item error_protection (@emph{--protect})
1087 Enable CRC error protection when set to 1. The default value is 0
1088 (disabled).
1089
1090 @item copyright (@emph{--copyright})
1091 Set MPEG audio copyright flag when set to 1. The default value is 0
1092 (disabled).
1093
1094 @item original (@emph{--original})
1095 Set MPEG audio original flag when set to 1. The default value is 0
1096 (disabled).
1097
1098 @end table
1099
1100 @section libvo-amrwbenc
1101
1102 VisualOn Adaptive Multi-Rate Wideband encoder.
1103
1104 Requires the presence of the libvo-amrwbenc headers and library during
1105 configuration. You need to explicitly configure the build with
1106 @code{--enable-libvo-amrwbenc --enable-version3}.
1107
1108 This is a mono-only encoder. Officially it only supports 16000Hz sample
1109 rate, but you can override it by setting @option{strict} to
1110 @samp{unofficial} or lower.
1111
1112 @subsection Options
1113
1114 @table @option
1115
1116 @item b
1117 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
1118 libavcodec will round to the nearest valid bitrate.
1119
1120 @table @samp
1121 @item 6600
1122 @item 8850
1123 @item 12650
1124 @item 14250
1125 @item 15850
1126 @item 18250
1127 @item 19850
1128 @item 23050
1129 @item 23850
1130 @end table
1131
1132 @item dtx
1133 Allow discontinuous transmission (generate comfort noise) when set to 1. The
1134 default value is 0 (disabled).
1135
1136 @end table
1137
1138 @section libvorbis
1139
1140 libvorbis encoder wrapper.
1141
1142 Requires the presence of the libvorbisenc headers and library during
1143 configuration. You need to explicitly configure the build with
1144 @code{--enable-libvorbis}.
1145
1146 @subsection Options
1147
1148 The following options are supported by the libvorbis wrapper. The
1149 @command{oggenc}-equivalent of the options are listed in parentheses.
1150
1151 To get a more accurate and extensive documentation of the libvorbis
1152 options, consult the libvorbisenc's and @command{oggenc}'s documentations.
1153 See @url{http://xiph.org/vorbis/},
1154 @url{http://wiki.xiph.org/Vorbis-tools}, and oggenc(1).
1155
1156 @table @option
1157 @item b (@emph{-b})
1158 Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
1159 expressed in kilobits/s.
1160
1161 @item q (@emph{-q})
1162 Set constant quality setting for VBR. The value should be a float
1163 number in the range of -1.0 to 10.0. The higher the value, the better
1164 the quality. The default value is @samp{3.0}.
1165
1166 This option is valid only using the @command{ffmpeg} command-line tool.
1167 For library interface users, use @option{global_quality}.
1168
1169 @item cutoff (@emph{--advanced-encode-option lowpass_frequency=N})
1170 Set cutoff bandwidth in Hz, a value of 0 disables cutoff. @command{oggenc}'s
1171 related option is expressed in kHz. The default value is @samp{0} (cutoff
1172 disabled).
1173
1174 @item minrate (@emph{-m})
1175 Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
1176 expressed in kilobits/s.
1177
1178 @item maxrate (@emph{-M})
1179 Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
1180 expressed in kilobits/s. This only has effect on ABR mode.
1181
1182 @item iblock (@emph{--advanced-encode-option impulse_noisetune=N})
1183 Set noise floor bias for impulse blocks. The value is a float number from
1184 -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
1185 to the crispness of transients in the encoded audio. The tradeoff for better
1186 transient response is a higher bitrate.
1187
1188 @end table
1189
1190 @anchor{libwavpack}
1191 @section libwavpack
1192
1193 A wrapper providing WavPack encoding through libwavpack.
1194
1195 Only lossless mode using 32-bit integer samples is supported currently.
1196
1197 Requires the presence of the libwavpack headers and library during
1198 configuration. You need to explicitly configure the build with
1199 @code{--enable-libwavpack}.
1200
1201 Note that a libavcodec-native encoder for the WavPack codec exists so users can
1202 encode audios with this codec without using this encoder. See @ref{wavpackenc}.
1203
1204 @subsection Options
1205
1206 @command{wavpack} command line utility's corresponding options are listed in
1207 parentheses, if any.
1208
1209 @table @option
1210 @item frame_size (@emph{--blocksize})
1211 Default is 32768.
1212
1213 @item compression_level
1214 Set speed vs. compression tradeoff. Acceptable arguments are listed below:
1215
1216 @table @samp
1217 @item 0 (@emph{-f})
1218 Fast mode.
1219
1220 @item 1
1221 Normal (default) settings.
1222
1223 @item 2 (@emph{-h})
1224 High quality.
1225
1226 @item 3 (@emph{-hh})
1227 Very high quality.
1228
1229 @item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
1230 Same as @samp{3}, but with extra processing enabled.
1231
1232 @samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
1233
1234 @end table
1235 @end table
1236
1237 @anchor{mjpegenc}
1238 @section mjpeg
1239
1240 Motion JPEG encoder.
1241
1242 @subsection Options
1243
1244 @table @option
1245 @item huffman
1246 Set the huffman encoding strategy. Possible values:
1247
1248 @table @samp
1249 @item default
1250 Use the default huffman tables. This is the default strategy.
1251
1252 @item optimal
1253 Compute and use optimal huffman tables.
1254
1255 @end table
1256 @end table
1257
1258 @anchor{wavpackenc}
1259 @section wavpack
1260
1261 WavPack lossless audio encoder.
1262
1263 This is a libavcodec-native WavPack encoder. There is also an encoder based on
1264 libwavpack, but there is virtually no reason to use that encoder.
1265
1266 See also @ref{libwavpack}.
1267
1268 @subsection Options
1269
1270 The equivalent options for @command{wavpack} command line utility are listed in
1271 parentheses.
1272
1273 @subsubsection Shared options
1274
1275 The following shared options are effective for this encoder. Only special notes
1276 about this particular encoder will be documented here. For the general meaning
1277 of the options, see @ref{codec-options,,the Codec Options chapter}.
1278
1279 @table @option
1280 @item frame_size (@emph{--blocksize})
1281 For this encoder, the range for this option is between 128 and 131072. Default
1282 is automatically decided based on sample rate and number of channel.
1283
1284 For the complete formula of calculating default, see
1285 @file{libavcodec/wavpackenc.c}.
1286
1287 @item compression_level (@emph{-f}, @emph{-h}, @emph{-hh}, and @emph{-x})
1288 This option's syntax is consistent with @ref{libwavpack}'s.
1289 @end table
1290
1291 @subsubsection Private options
1292
1293 @table @option
1294 @item joint_stereo (@emph{-j})
1295 Set whether to enable joint stereo. Valid values are:
1296
1297 @table @samp
1298 @item on (@emph{1})
1299 Force mid/side audio encoding.
1300 @item off (@emph{0})
1301 Force left/right audio encoding.
1302 @item auto
1303 Let the encoder decide automatically.
1304 @end table
1305
1306 @item optimize_mono
1307 Set whether to enable optimization for mono. This option is only effective for
1308 non-mono streams. Available values:
1309
1310 @table @samp
1311 @item on
1312 enabled
1313 @item off
1314 disabled
1315 @end table
1316
1317 @end table
1318
1319 @c man end AUDIO ENCODERS
1320
1321 @chapter Video Encoders
1322 @c man begin VIDEO ENCODERS
1323
1324 A description of some of the currently available video encoders
1325 follows.
1326
1327 @section Hap
1328
1329 Vidvox Hap video encoder.
1330
1331 @subsection Options
1332
1333 @table @option
1334 @item format @var{integer}
1335 Specifies the Hap format to encode.
1336
1337 @table @option
1338 @item hap
1339 @item hap_alpha
1340 @item hap_q
1341 @end table
1342
1343 Default value is @option{hap}.
1344
1345 @item chunks @var{integer}
1346 Specifies the number of chunks to split frames into, between 1 and 64. This
1347 permits multithreaded decoding of large frames, potentially at the cost of
1348 data-rate. The encoder may modify this value to divide frames evenly.
1349
1350 Default value is @var{1}.
1351
1352 @item compressor @var{integer}
1353 Specifies the second-stage compressor to use. If set to @option{none},
1354 @option{chunks} will be limited to 1, as chunked uncompressed frames offer no
1355 benefit.
1356
1357 @table @option
1358 @item none
1359 @item snappy
1360 @end table
1361
1362 Default value is @option{snappy}.
1363
1364 @end table
1365
1366 @section jpeg2000
1367
1368 The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
1369 option can be used to set the encoding quality. Lossless encoding
1370 can be selected with @code{-pred 1}.
1371
1372 @subsection Options
1373
1374 @table @option
1375 @item format
1376 Can be set to either @code{j2k} or @code{jp2} (the default) that
1377 makes it possible to store non-rgb pix_fmts.
1378
1379 @end table
1380
1381 @section librav1e
1382
1383 rav1e AV1 encoder wrapper.
1384
1385 Requires the presence of the rav1e headers and library during configuration.
1386 You need to explicitly configure the build with @code{--enable-librav1e}.
1387
1388 @subsection Options
1389
1390 @table @option
1391 @item qmax
1392 Sets the maximum quantizer to use when using bitrate mode.
1393
1394 @item qmin
1395 Sets the minimum quantizer to use when using bitrate mode.
1396
1397 @item qp
1398 Uses quantizer mode to encode at the given quantizer.
1399
1400 @item speed
1401 Selects the speed preset (0-10) to encode with.
1402
1403 @item tiles
1404 Selects how many tiles to encode with.
1405
1406 @item tile-rows
1407 Selects how many rows of tiles to encode with.
1408
1409 @item tile-columns
1410 Selects how many columns of tiles to encode with.
1411
1412 @item rav1e-params
1413 Set rav1e options using a list of @var{key}=@var{value} pairs separated
1414 by ":". See @command{rav1e --help} for a list of options.
1415
1416 For example to specify librav1e encoding options with @option{-rav1e-params}:
1417
1418 @example
1419 ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
1420 @end example
1421
1422 @end table
1423
1424 @section libaom-av1
1425
1426 libaom AV1 encoder wrapper.
1427
1428 Requires the presence of the libaom headers and library during
1429 configuration.  You need to explicitly configure the build with
1430 @code{--enable-libaom}.
1431
1432 @subsection Options
1433
1434 The wrapper supports the following standard libavcodec options:
1435
1436 @table @option
1437
1438 @item b
1439 Set bitrate target in bits/second.  By default this will use
1440 variable-bitrate mode.  If @option{maxrate} and @option{minrate} are
1441 also set to the same value then it will use constant-bitrate mode,
1442 otherwise if @option{crf} is set as well then it will use
1443 constrained-quality mode.
1444
1445 @item g keyint_min
1446 Set key frame placement.  The GOP size sets the maximum distance between
1447 key frames; if zero the output stream will be intra-only.  The minimum
1448 distance is ignored unless it is the same as the GOP size, in which case
1449 key frames will always appear at a fixed interval.  Not set by default,
1450 so without this option the library has completely free choice about
1451 where to place key frames.
1452
1453 @item qmin qmax
1454 Set minimum/maximum quantisation values.  Valid range is from 0 to 63
1455 (warning: this does not match the quantiser values actually used by AV1
1456 - divide by four to map real quantiser values to this range).  Defaults
1457 to min/max (no constraint).
1458
1459 @item minrate maxrate bufsize rc_init_occupancy
1460 Set rate control buffering parameters.  Not used if not set - defaults
1461 to unconstrained variable bitrate.
1462
1463 @item threads
1464 Set the number of threads to use while encoding.  This may require the
1465 @option{tiles} or @option{row-mt} options to also be set to actually
1466 use the specified number of threads fully. Defaults to the number of
1467 hardware threads supported by the host machine.
1468
1469 @item profile
1470 Set the encoding profile.  Defaults to using the profile which matches
1471 the bit depth and chroma subsampling of the input.
1472
1473 @end table
1474
1475 The wrapper also has some specific options:
1476
1477 @table @option
1478
1479 @item cpu-used
1480 Set the quality/encoding speed tradeoff.  Valid range is from 0 to 8,
1481 higher numbers indicating greater speed and lower quality.  The default
1482 value is 1, which will be slow and high quality.
1483
1484 @item auto-alt-ref
1485 Enable use of alternate reference frames.  Defaults to the internal
1486 default of the library.
1487
1488 @item arnr-max-frames (@emph{frames})
1489 Set altref noise reduction max frame count. Default is -1.
1490
1491 @item arnr-strength (@emph{strength})
1492 Set altref noise reduction filter strength. Range is -1 to 6. Default is -1.
1493
1494 @item aq-mode (@emph{aq-mode})
1495 Set adaptive quantization mode. Possible values:
1496
1497 @table @samp
1498 @item none (@emph{0})
1499 Disabled.
1500
1501 @item variance (@emph{1})
1502 Variance-based.
1503
1504 @item complexity (@emph{2})
1505 Complexity-based.
1506
1507 @item cyclic (@emph{3})
1508 Cyclic refresh.
1509 @end table
1510
1511 @item lag-in-frames
1512 Set the maximum number of frames which the encoder may keep in flight
1513 at any one time for lookahead purposes.  Defaults to the internal
1514 default of the library.
1515
1516 @item error-resilience
1517 Enable error resilience features:
1518 @table @option
1519 @item default
1520 Improve resilience against losses of whole frames.
1521 @end table
1522 Not enabled by default.
1523
1524 @item crf
1525 Set the quality/size tradeoff for constant-quality (no bitrate target)
1526 and constrained-quality (with maximum bitrate target) modes. Valid
1527 range is 0 to 63, higher numbers indicating lower quality and smaller
1528 output size.  Only used if set; by default only the bitrate target is
1529 used.
1530
1531 @item static-thresh
1532 Set a change threshold on blocks below which they will be skipped by
1533 the encoder.  Defined in arbitrary units as a nonnegative integer,
1534 defaulting to zero (no blocks are skipped).
1535
1536 @item drop-threshold
1537 Set a threshold for dropping frames when close to rate control bounds.
1538 Defined as a percentage of the target buffer - when the rate control
1539 buffer falls below this percentage, frames will be dropped until it
1540 has refilled above the threshold.  Defaults to zero (no frames are
1541 dropped).
1542
1543 @item denoise-noise-level (@emph{level})
1544 Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if
1545 this option is not set or set to 0.
1546
1547 @item denoise-block-size (@emph{pixels})
1548 Block size used for denoising for grain synthesis. If not set, AV1 codec
1549 uses the default value of 32.
1550
1551 @item undershoot-pct (@emph{pct})
1552 Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100.
1553 Default is -1.
1554
1555 @item overshoot-pct (@emph{pct})
1556 Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000.
1557 Default is -1.
1558
1559 @item minsection-pct (@emph{pct})
1560 Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct
1561 is not set, the libaomenc wrapper computes it as follows: @code{(minrate * 100 / bitrate)}.
1562 Range is -1 to 100. Default is -1 (unset).
1563
1564 @item maxsection-pct (@emph{pct})
1565 Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct
1566 is not set, the libaomenc wrapper computes it as follows: @code{(maxrate * 100 / bitrate)}.
1567 Range is -1 to 5000. Default is -1 (unset).
1568
1569 @item frame-parallel (@emph{boolean})
1570 Enable frame parallel decodability features. Default is true.
1571
1572 @item tiles
1573 Set the number of tiles to encode the input video with, as columns x
1574 rows.  Larger numbers allow greater parallelism in both encoding and
1575 decoding, but may decrease coding efficiency.  Defaults to the minimum
1576 number of tiles required by the size of the input video (this is 1x1
1577 (that is, a single tile) for sizes up to and including 4K).
1578
1579 @item tile-columns tile-rows
1580 Set the number of tiles as log2 of the number of tile rows and columns.
1581 Provided for compatibility with libvpx/VP9.
1582
1583 @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
1584 Enable row based multi-threading. Disabled by default.
1585
1586 @item enable-cdef (@emph{boolean})
1587 Enable Constrained Directional Enhancement Filter. The libaom-av1
1588 encoder enables CDEF by default.
1589
1590 @item enable-global-motion (@emph{boolean})
1591 Enable the use of global motion for block prediction. Default is true.
1592
1593 @item enable-intrabc (@emph{boolean})
1594 Enable block copy mode for intra block prediction. This mode is
1595 useful for screen content. Default is true.
1596
1597 @end table
1598
1599 @section libkvazaar
1600
1601 Kvazaar H.265/HEVC encoder.
1602
1603 Requires the presence of the libkvazaar headers and library during
1604 configuration. You need to explicitly configure the build with
1605 @option{--enable-libkvazaar}.
1606
1607 @subsection Options
1608
1609 @table @option
1610
1611 @item b
1612 Set target video bitrate in bit/s and enable rate control.
1613
1614 @item kvazaar-params
1615 Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
1616 by commas (,). See kvazaar documentation for a list of options.
1617
1618 @end table
1619
1620 @section libopenh264
1621
1622 Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
1623
1624 This encoder requires the presence of the libopenh264 headers and
1625 library during configuration. You need to explicitly configure the
1626 build with @code{--enable-libopenh264}. The library is detected using
1627 @command{pkg-config}.
1628
1629 For more information about the library see
1630 @url{http://www.openh264.org}.
1631
1632 @subsection Options
1633
1634 The following FFmpeg global options affect the configurations of the
1635 libopenh264 encoder.
1636
1637 @table @option
1638 @item b
1639 Set the bitrate (as a number of bits per second).
1640
1641 @item g
1642 Set the GOP size.
1643
1644 @item maxrate
1645 Set the max bitrate (as a number of bits per second).
1646
1647 @item flags +global_header
1648 Set global header in the bitstream.
1649
1650 @item slices
1651 Set the number of slices, used in parallelized encoding. Default value
1652 is 0. This is only used when @option{slice_mode} is set to
1653 @samp{fixed}.
1654
1655 @item slice_mode
1656 Set slice mode. Can assume one of the following possible values:
1657
1658 @table @samp
1659 @item fixed
1660 a fixed number of slices
1661 @item rowmb
1662 one slice per row of macroblocks
1663 @item auto
1664 automatic number of slices according to number of threads
1665 @item dyn
1666 dynamic slicing
1667 @end table
1668
1669 Default value is @samp{auto}.
1670
1671 @item loopfilter
1672 Enable loop filter, if set to 1 (automatically enabled). To disable
1673 set a value of 0.
1674
1675 @item profile
1676 Set profile restrictions. If set to the value of @samp{main} enable
1677 CABAC (set the @code{SEncParamExt.iEntropyCodingModeFlag} flag to 1).
1678
1679 @item max_nal_size
1680 Set maximum NAL size in bytes.
1681
1682 @item allow_skip_frames
1683 Allow skipping frames to hit the target bitrate if set to 1.
1684 @end table
1685
1686 @section libtheora
1687
1688 libtheora Theora encoder wrapper.
1689
1690 Requires the presence of the libtheora headers and library during
1691 configuration. You need to explicitly configure the build with
1692 @code{--enable-libtheora}.
1693
1694 For more information about the libtheora project see
1695 @url{http://www.theora.org/}.
1696
1697 @subsection Options
1698
1699 The following global options are mapped to internal libtheora options
1700 which affect the quality and the bitrate of the encoded stream.
1701
1702 @table @option
1703 @item b
1704 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1705 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1706
1707 @item flags
1708 Used to enable constant quality mode (VBR) encoding through the
1709 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1710 modes.
1711
1712 @item g
1713 Set the GOP size.
1714
1715 @item global_quality
1716 Set the global quality as an integer in lambda units.
1717
1718 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1719 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1720 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1721 value in the native libtheora range [0-63]. A higher value corresponds
1722 to a higher quality.
1723
1724 @item q
1725 Enable VBR mode when set to a non-negative value, and set constant
1726 quality value as a double floating point value in QP units.
1727
1728 The value is clipped in the [0-10] range, and then multiplied by 6.3
1729 to get a value in the native libtheora range [0-63].
1730
1731 This option is valid only using the @command{ffmpeg} command-line
1732 tool. For library interface users, use @option{global_quality}.
1733 @end table
1734
1735 @subsection Examples
1736
1737 @itemize
1738 @item
1739 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1740 @example
1741 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1742 @end example
1743
1744 @item
1745 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1746 @example
1747 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1748 @end example
1749 @end itemize
1750
1751 @section libvpx
1752
1753 VP8/VP9 format supported through libvpx.
1754
1755 Requires the presence of the libvpx headers and library during configuration.
1756 You need to explicitly configure the build with @code{--enable-libvpx}.
1757
1758 @subsection Options
1759
1760 The following options are supported by the libvpx wrapper. The
1761 @command{vpxenc}-equivalent options or values are listed in parentheses
1762 for easy migration.
1763
1764 To reduce the duplication of documentation, only the private options
1765 and some others requiring special attention are documented here. For
1766 the documentation of the undocumented generic options, see
1767 @ref{codec-options,,the Codec Options chapter}.
1768
1769 To get more documentation of the libvpx options, invoke the command
1770 @command{ffmpeg -h encoder=libvpx}, @command{ffmpeg -h encoder=libvpx-vp9} or
1771 @command{vpxenc --help}. Further information is available in the libvpx API
1772 documentation.
1773
1774 @table @option
1775
1776 @item b (@emph{target-bitrate})
1777 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1778 expressed in bits/s, while @command{vpxenc}'s @option{target-bitrate} is in
1779 kilobits/s.
1780
1781 @item g (@emph{kf-max-dist})
1782
1783 @item keyint_min (@emph{kf-min-dist})
1784
1785 @item qmin (@emph{min-q})
1786
1787 @item qmax (@emph{max-q})
1788
1789 @item bufsize (@emph{buf-sz}, @emph{buf-optimal-sz})
1790 Set ratecontrol buffer size (in bits). Note @command{vpxenc}'s options are
1791 specified in milliseconds, the libvpx wrapper converts this value as follows:
1792 @code{buf-sz = bufsize * 1000 / bitrate},
1793 @code{buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6}.
1794
1795 @item rc_init_occupancy (@emph{buf-initial-sz})
1796 Set number of bits which should be loaded into the rc buffer before decoding
1797 starts. Note @command{vpxenc}'s option is specified in milliseconds, the libvpx
1798 wrapper converts this value as follows:
1799 @code{rc_init_occupancy * 1000 / bitrate}.
1800
1801 @item undershoot-pct
1802 Set datarate undershoot (min) percentage of the target bitrate.
1803
1804 @item overshoot-pct
1805 Set datarate overshoot (max) percentage of the target bitrate.
1806
1807 @item skip_threshold (@emph{drop-frame})
1808
1809 @item qcomp (@emph{bias-pct})
1810
1811 @item maxrate (@emph{maxsection-pct})
1812 Set GOP max bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1813 percentage of the target bitrate, the libvpx wrapper converts this value as
1814 follows: @code{(maxrate * 100 / bitrate)}.
1815
1816 @item minrate (@emph{minsection-pct})
1817 Set GOP min bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1818 percentage of the target bitrate, the libvpx wrapper converts this value as
1819 follows: @code{(minrate * 100 / bitrate)}.
1820
1821 @item minrate, maxrate, b @emph{end-usage=cbr}
1822 @code{(minrate == maxrate == bitrate)}.
1823
1824 @item crf (@emph{end-usage=cq}, @emph{cq-level})
1825
1826 @item tune (@emph{tune})
1827 @table @samp
1828 @item psnr (@emph{psnr})
1829 @item ssim (@emph{ssim})
1830 @end table
1831
1832 @item quality, deadline (@emph{deadline})
1833 @table @samp
1834 @item best
1835 Use best quality deadline. Poorly named and quite slow, this option should be
1836 avoided as it may give worse quality output than good.
1837 @item good
1838 Use good quality deadline. This is a good trade-off between speed and quality
1839 when used with the @option{cpu-used} option.
1840 @item realtime
1841 Use realtime quality deadline.
1842 @end table
1843
1844 @item speed, cpu-used (@emph{cpu-used})
1845 Set quality/speed ratio modifier. Higher values speed up the encode at the cost
1846 of quality.
1847
1848 @item nr (@emph{noise-sensitivity})
1849
1850 @item static-thresh
1851 Set a change threshold on blocks below which they will be skipped by the
1852 encoder.
1853
1854 @item slices (@emph{token-parts})
1855 Note that FFmpeg's @option{slices} option gives the total number of partitions,
1856 while @command{vpxenc}'s @option{token-parts} is given as
1857 @code{log2(partitions)}.
1858
1859 @item max-intra-rate
1860 Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
1861 means unlimited.
1862
1863 @item force_key_frames
1864 @code{VPX_EFLAG_FORCE_KF}
1865
1866 @item Alternate reference frame related
1867 @table @option
1868 @item auto-alt-ref
1869 Enable use of alternate reference frames (2-pass only).
1870 Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
1871 @item arnr-maxframes
1872 Set altref noise reduction max frame count.
1873 @item arnr-type
1874 Set altref noise reduction filter type: backward, forward, centered.
1875 @item arnr-strength
1876 Set altref noise reduction filter strength.
1877 @item rc-lookahead, lag-in-frames (@emph{lag-in-frames})
1878 Set number of frames to look ahead for frametype and ratecontrol.
1879 @end table
1880
1881 @item error-resilient
1882 Enable error resiliency features.
1883
1884 @item sharpness @var{integer}
1885 Increase sharpness at the expense of lower PSNR.
1886 The valid range is [0, 7].
1887
1888 @item VP8-specific options
1889 @table @option
1890 @item ts-parameters
1891 Sets the temporal scalability configuration using a :-separated list of
1892 key=value pairs. For example, to specify temporal scalability parameters
1893 with @code{ffmpeg}:
1894 @example
1895 ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
1896 ts_target_bitrate=250000,500000,1000000:ts_rate_decimator=4,2,1:\
1897 ts_periodicity=4:ts_layer_id=0,2,1,2 OUTPUT
1898 @end example
1899 Below is a brief explanation of each of the parameters, please
1900 refer to @code{struct vpx_codec_enc_cfg} in @code{vpx/vpx_encoder.h} for more
1901 details.
1902 @table @option
1903 @item ts_number_layers
1904 Number of temporal coding layers.
1905 @item ts_target_bitrate
1906 Target bitrate for each temporal layer.
1907 @item ts_rate_decimator
1908 Frame rate decimation factor for each temporal layer.
1909 @item ts_periodicity
1910 Length of the sequence defining frame temporal layer membership.
1911 @item ts_layer_id
1912 Template defining the membership of frames to temporal layers.
1913 @end table
1914 @end table
1915
1916 @item VP9-specific options
1917 @table @option
1918 @item lossless
1919 Enable lossless mode.
1920 @item tile-columns
1921 Set number of tile columns to use. Note this is given as
1922 @code{log2(tile_columns)}. For example, 8 tile columns would be requested by
1923 setting the @option{tile-columns} option to 3.
1924 @item tile-rows
1925 Set number of tile rows to use. Note this is given as @code{log2(tile_rows)}.
1926 For example, 4 tile rows would be requested by setting the @option{tile-rows}
1927 option to 2.
1928 @item frame-parallel
1929 Enable frame parallel decodability features.
1930 @item aq-mode
1931 Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
1932 cyclic refresh, 4: equator360).
1933 @item colorspace @emph{color-space}
1934 Set input color space. The VP9 bitstream supports signaling the following
1935 colorspaces:
1936 @table @option
1937 @item @samp{rgb} @emph{sRGB}
1938 @item @samp{bt709} @emph{bt709}
1939 @item @samp{unspecified} @emph{unknown}
1940 @item @samp{bt470bg} @emph{bt601}
1941 @item @samp{smpte170m} @emph{smpte170}
1942 @item @samp{smpte240m} @emph{smpte240}
1943 @item @samp{bt2020_ncl} @emph{bt2020}
1944 @end table
1945 @item row-mt @var{boolean}
1946 Enable row based multi-threading.
1947 @item tune-content
1948 Set content type: default (0), screen (1), film (2).
1949 @item corpus-complexity
1950 Corpus VBR mode is a variant of standard VBR where the complexity distribution
1951 midpoint is passed in rather than calculated for a specific clip or chunk.
1952
1953 The valid range is [0, 10000]. 0 (default) uses standard VBR.
1954 @item enable-tpl @var{boolean}
1955 Enable temporal dependency model.
1956 @end table
1957
1958 @end table
1959
1960 For more information about libvpx see:
1961 @url{http://www.webmproject.org/}
1962
1963 @section libwebp
1964
1965 libwebp WebP Image encoder wrapper
1966
1967 libwebp is Google's official encoder for WebP images. It can encode in either
1968 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
1969 frame. Lossless images are a separate codec developed by Google.
1970
1971 @subsection Pixel Format
1972
1973 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
1974 to limitations of the format and libwebp. Alpha is supported for either mode.
1975 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
1976 passed in for encoding lossless, the pixel format will automatically be
1977 converted using functions from libwebp. This is not ideal and is done only for
1978 convenience.
1979
1980 @subsection Options
1981
1982 @table @option
1983
1984 @item -lossless @var{boolean}
1985 Enables/Disables use of lossless mode. Default is 0.
1986
1987 @item -compression_level @var{integer}
1988 For lossy, this is a quality/speed tradeoff. Higher values give better quality
1989 for a given size at the cost of increased encoding time. For lossless, this is
1990 a size/speed tradeoff. Higher values give smaller size at the cost of increased
1991 encoding time. More specifically, it controls the number of extra algorithms
1992 and compression tools used, and varies the combination of these tools. This
1993 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
1994 Default is 4.
1995
1996 @item -qscale @var{float}
1997 For lossy encoding, this controls image quality, 0 to 100. For lossless
1998 encoding, this controls the effort and time spent at compressing more. The
1999 default value is 75. Note that for usage via libavcodec, this option is called
2000 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
2001
2002 @item -preset @var{type}
2003 Configuration preset. This does some automatic settings based on the general
2004 type of the image.
2005 @table @option
2006 @item none
2007 Do not use a preset.
2008 @item default
2009 Use the encoder default.
2010 @item picture
2011 Digital picture, like portrait, inner shot
2012 @item photo
2013 Outdoor photograph, with natural lighting
2014 @item drawing
2015 Hand or line drawing, with high-contrast details
2016 @item icon
2017 Small-sized colorful images
2018 @item text
2019 Text-like
2020 @end table
2021
2022 @end table
2023
2024 @section libx264, libx264rgb
2025
2026 x264 H.264/MPEG-4 AVC encoder wrapper.
2027
2028 This encoder requires the presence of the libx264 headers and library
2029 during configuration. You need to explicitly configure the build with
2030 @code{--enable-libx264}.
2031
2032 libx264 supports an impressive number of features, including 8x8 and
2033 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
2034 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
2035 for detail retention (adaptive quantization, psy-RD, psy-trellis).
2036
2037 Many libx264 encoder options are mapped to FFmpeg global codec
2038 options, while unique encoder options are provided through private
2039 options. Additionally the @option{x264opts} and @option{x264-params}
2040 private options allows one to pass a list of key=value tuples as accepted
2041 by the libx264 @code{x264_param_parse} function.
2042
2043 The x264 project website is at
2044 @url{http://www.videolan.org/developers/x264.html}.
2045
2046 The libx264rgb encoder is the same as libx264, except it accepts packed RGB
2047 pixel formats as input instead of YUV.
2048
2049 @subsection Supported Pixel Formats
2050
2051 x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
2052 x264's configure time. FFmpeg only supports one bit depth in one particular
2053 build. In other words, it is not possible to build one FFmpeg with multiple
2054 versions of x264 with different bit depths.
2055
2056 @subsection Options
2057
2058 The following options are supported by the libx264 wrapper. The
2059 @command{x264}-equivalent options or values are listed in parentheses
2060 for easy migration.
2061
2062 To reduce the duplication of documentation, only the private options
2063 and some others requiring special attention are documented here. For
2064 the documentation of the undocumented generic options, see
2065 @ref{codec-options,,the Codec Options chapter}.
2066
2067 To get a more accurate and extensive documentation of the libx264
2068 options, invoke the command @command{x264 --fullhelp} or consult
2069 the libx264 documentation.
2070
2071 @table @option
2072 @item b (@emph{bitrate})
2073 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
2074 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
2075 kilobits/s.
2076
2077 @item bf (@emph{bframes})
2078
2079 @item g (@emph{keyint})
2080
2081 @item qmin (@emph{qpmin})
2082 Minimum quantizer scale.
2083
2084 @item qmax (@emph{qpmax})
2085 Maximum quantizer scale.
2086
2087 @item qdiff (@emph{qpstep})
2088 Maximum difference between quantizer scales.
2089
2090 @item qblur (@emph{qblur})
2091 Quantizer curve blur
2092
2093 @item qcomp (@emph{qcomp})
2094 Quantizer curve compression factor
2095
2096 @item refs (@emph{ref})
2097 Number of reference frames each P-frame can use. The range is from @var{0-16}.
2098
2099 @item sc_threshold (@emph{scenecut})
2100 Sets the threshold for the scene change detection.
2101
2102 @item trellis (@emph{trellis})
2103 Performs Trellis quantization to increase efficiency. Enabled by default.
2104
2105 @item nr  (@emph{nr})
2106
2107 @item me_range (@emph{merange})
2108 Maximum range of the motion search in pixels.
2109
2110 @item me_method (@emph{me})
2111 Set motion estimation method. Possible values in the decreasing order
2112 of speed:
2113
2114 @table @samp
2115 @item dia (@emph{dia})
2116 @item epzs (@emph{dia})
2117 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
2118 @samp{dia}.
2119 @item hex (@emph{hex})
2120 Hexagonal search with radius 2.
2121 @item umh (@emph{umh})
2122 Uneven multi-hexagon search.
2123 @item esa (@emph{esa})
2124 Exhaustive search.
2125 @item tesa (@emph{tesa})
2126 Hadamard exhaustive search (slowest).
2127 @end table
2128
2129 @item forced-idr
2130 Normally, when forcing a I-frame type, the encoder can select any type
2131 of I-frame. This option forces it to choose an IDR-frame.
2132
2133 @item subq (@emph{subme})
2134 Sub-pixel motion estimation method.
2135
2136 @item b_strategy (@emph{b-adapt})
2137 Adaptive B-frame placement decision algorithm. Use only on first-pass.
2138
2139 @item keyint_min (@emph{min-keyint})
2140 Minimum GOP size.
2141
2142 @item coder
2143 Set entropy encoder. Possible values:
2144
2145 @table @samp
2146 @item ac
2147 Enable CABAC.
2148
2149 @item vlc
2150 Enable CAVLC and disable CABAC. It generates the same effect as
2151 @command{x264}'s @option{--no-cabac} option.
2152 @end table
2153
2154 @item cmp
2155 Set full pixel motion estimation comparison algorithm. Possible values:
2156
2157 @table @samp
2158 @item chroma
2159 Enable chroma in motion estimation.
2160
2161 @item sad
2162 Ignore chroma in motion estimation. It generates the same effect as
2163 @command{x264}'s @option{--no-chroma-me} option.
2164 @end table
2165
2166 @item threads (@emph{threads})
2167 Number of encoding threads.
2168
2169 @item thread_type
2170 Set multithreading technique. Possible values:
2171
2172 @table @samp
2173 @item slice
2174 Slice-based multithreading. It generates the same effect as
2175 @command{x264}'s @option{--sliced-threads} option.
2176 @item frame
2177 Frame-based multithreading.
2178 @end table
2179
2180 @item flags
2181 Set encoding flags. It can be used to disable closed GOP and enable
2182 open GOP by setting it to @code{-cgop}. The result is similar to
2183 the behavior of @command{x264}'s @option{--open-gop} option.
2184
2185 @item rc_init_occupancy (@emph{vbv-init})
2186
2187 @item preset (@emph{preset})
2188 Set the encoding preset.
2189
2190 @item tune (@emph{tune})
2191 Set tuning of the encoding params.
2192
2193 @item profile (@emph{profile})
2194 Set profile restrictions.
2195
2196 @item fastfirstpass
2197 Enable fast settings when encoding first pass, when set to 1. When set
2198 to 0, it has the same effect of @command{x264}'s
2199 @option{--slow-firstpass} option.
2200
2201 @item crf (@emph{crf})
2202 Set the quality for constant quality mode.
2203
2204 @item crf_max (@emph{crf-max})
2205 In CRF mode, prevents VBV from lowering quality beyond this point.
2206
2207 @item qp (@emph{qp})
2208 Set constant quantization rate control method parameter.
2209
2210 @item aq-mode (@emph{aq-mode})
2211 Set AQ method. Possible values:
2212
2213 @table @samp
2214 @item none (@emph{0})
2215 Disabled.
2216
2217 @item variance (@emph{1})
2218 Variance AQ (complexity mask).
2219
2220 @item autovariance (@emph{2})
2221 Auto-variance AQ (experimental).
2222 @end table
2223
2224 @item aq-strength (@emph{aq-strength})
2225 Set AQ strength, reduce blocking and blurring in flat and textured areas.
2226
2227 @item psy
2228 Use psychovisual optimizations when set to 1. When set to 0, it has the
2229 same effect as @command{x264}'s @option{--no-psy} option.
2230
2231 @item psy-rd  (@emph{psy-rd})
2232 Set strength of psychovisual optimization, in
2233 @var{psy-rd}:@var{psy-trellis} format.
2234
2235 @item rc-lookahead (@emph{rc-lookahead})
2236 Set number of frames to look ahead for frametype and ratecontrol.
2237
2238 @item weightb
2239 Enable weighted prediction for B-frames when set to 1. When set to 0,
2240 it has the same effect as @command{x264}'s @option{--no-weightb} option.
2241
2242 @item weightp (@emph{weightp})
2243 Set weighted prediction method for P-frames. Possible values:
2244
2245 @table @samp
2246 @item none (@emph{0})
2247 Disabled
2248 @item simple (@emph{1})
2249 Enable only weighted refs
2250 @item smart (@emph{2})
2251 Enable both weighted refs and duplicates
2252 @end table
2253
2254 @item ssim (@emph{ssim})
2255 Enable calculation and printing SSIM stats after the encoding.
2256
2257 @item intra-refresh (@emph{intra-refresh})
2258 Enable the use of Periodic Intra Refresh instead of IDR frames when set
2259 to 1.
2260
2261 @item avcintra-class (@emph{class})
2262 Configure the encoder to generate AVC-Intra.
2263 Valid values are 50,100 and 200
2264
2265 @item bluray-compat (@emph{bluray-compat})
2266 Configure the encoder to be compatible with the bluray standard.
2267 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
2268
2269 @item b-bias (@emph{b-bias})
2270 Set the influence on how often B-frames are used.
2271
2272 @item b-pyramid (@emph{b-pyramid})
2273 Set method for keeping of some B-frames as references. Possible values:
2274
2275 @table @samp
2276 @item none (@emph{none})
2277 Disabled.
2278 @item strict (@emph{strict})
2279 Strictly hierarchical pyramid.
2280 @item normal (@emph{normal})
2281 Non-strict (not Blu-ray compatible).
2282 @end table
2283
2284 @item mixed-refs
2285 Enable the use of one reference per partition, as opposed to one
2286 reference per macroblock when set to 1. When set to 0, it has the
2287 same effect as @command{x264}'s @option{--no-mixed-refs} option.
2288
2289 @item 8x8dct
2290 Enable adaptive spatial transform (high profile 8x8 transform)
2291 when set to 1. When set to 0, it has the same effect as
2292 @command{x264}'s @option{--no-8x8dct} option.
2293
2294 @item fast-pskip
2295 Enable early SKIP detection on P-frames when set to 1. When set
2296 to 0, it has the same effect as @command{x264}'s
2297 @option{--no-fast-pskip} option.
2298
2299 @item aud (@emph{aud})
2300 Enable use of access unit delimiters when set to 1.
2301
2302 @item mbtree
2303 Enable use macroblock tree ratecontrol when set to 1. When set
2304 to 0, it has the same effect as @command{x264}'s
2305 @option{--no-mbtree} option.
2306
2307 @item deblock (@emph{deblock})
2308 Set loop filter parameters, in @var{alpha}:@var{beta} form.
2309
2310 @item cplxblur (@emph{cplxblur})
2311 Set fluctuations reduction in QP (before curve compression).
2312
2313 @item partitions (@emph{partitions})
2314 Set partitions to consider as a comma-separated list of. Possible
2315 values in the list:
2316
2317 @table @samp
2318 @item p8x8
2319 8x8 P-frame partition.
2320 @item p4x4
2321 4x4 P-frame partition.
2322 @item b8x8
2323 4x4 B-frame partition.
2324 @item i8x8
2325 8x8 I-frame partition.
2326 @item i4x4
2327 4x4 I-frame partition.
2328 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
2329 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
2330 option) to be enabled.)
2331 @item none (@emph{none})
2332 Do not consider any partitions.
2333 @item all (@emph{all})
2334 Consider every partition.
2335 @end table
2336
2337 @item direct-pred (@emph{direct})
2338 Set direct MV prediction mode. Possible values:
2339
2340 @table @samp
2341 @item none (@emph{none})
2342 Disable MV prediction.
2343 @item spatial (@emph{spatial})
2344 Enable spatial predicting.
2345 @item temporal (@emph{temporal})
2346 Enable temporal predicting.
2347 @item auto (@emph{auto})
2348 Automatically decided.
2349 @end table
2350
2351 @item slice-max-size (@emph{slice-max-size})
2352 Set the limit of the size of each slice in bytes. If not specified
2353 but RTP payload size (@option{ps}) is specified, that is used.
2354
2355 @item stats (@emph{stats})
2356 Set the file name for multi-pass stats.
2357
2358 @item nal-hrd (@emph{nal-hrd})
2359 Set signal HRD information (requires @option{vbv-bufsize} to be set).
2360 Possible values:
2361
2362 @table @samp
2363 @item none (@emph{none})
2364 Disable HRD information signaling.
2365 @item vbr (@emph{vbr})
2366 Variable bit rate.
2367 @item cbr (@emph{cbr})
2368 Constant bit rate (not allowed in MP4 container).
2369 @end table
2370
2371 @item x264opts (N.A.)
2372 Set any x264 option, see @command{x264 --fullhelp} for a list.
2373
2374 Argument is a list of @var{key}=@var{value} couples separated by
2375 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
2376 themselves, use "," instead. They accept it as well since long ago but this
2377 is kept undocumented for some reason.
2378
2379 For example to specify libx264 encoding options with @command{ffmpeg}:
2380 @example
2381 ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
2382 @end example
2383
2384 @item a53cc @var{boolean}
2385 Import closed captions (which must be ATSC compatible format) into output.
2386 Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
2387
2388 @item x264-params (N.A.)
2389 Override the x264 configuration using a :-separated list of key=value
2390 parameters.
2391
2392 This option is functionally the same as the @option{x264opts}, but is
2393 duplicated for compatibility with the Libav fork.
2394
2395 For example to specify libx264 encoding options with @command{ffmpeg}:
2396 @example
2397 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
2398 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
2399 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
2400 @end example
2401 @end table
2402
2403 Encoding ffpresets for common usages are provided so they can be used with the
2404 general presets system (e.g. passing the @option{pre} option).
2405
2406 @section libx265
2407
2408 x265 H.265/HEVC encoder wrapper.
2409
2410 This encoder requires the presence of the libx265 headers and library
2411 during configuration. You need to explicitly configure the build with
2412 @option{--enable-libx265}.
2413
2414 @subsection Options
2415
2416 @table @option
2417 @item preset
2418 Set the x265 preset.
2419
2420 @item tune
2421 Set the x265 tune parameter.
2422
2423 @item profile
2424 Set profile restrictions.
2425
2426 @item crf
2427 Set the quality for constant quality mode.
2428
2429 @item forced-idr
2430 Normally, when forcing a I-frame type, the encoder can select any type
2431 of I-frame. This option forces it to choose an IDR-frame.
2432
2433 @item x265-params
2434 Set x265 options using a list of @var{key}=@var{value} couples separated
2435 by ":". See @command{x265 --help} for a list of options.
2436
2437 For example to specify libx265 encoding options with @option{-x265-params}:
2438
2439 @example
2440 ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
2441 @end example
2442 @end table
2443
2444 @section libxavs2
2445
2446 xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
2447
2448 This encoder requires the presence of the libxavs2 headers and library
2449 during configuration. You need to explicitly configure the build with
2450 @option{--enable-libxavs2}.
2451
2452 The following standard libavcodec options are used:
2453 @itemize
2454 @item
2455 @option{b} / @option{bit_rate}
2456 @item
2457 @option{g} / @option{gop_size}
2458 @item
2459 @option{bf} / @option{max_b_frames}
2460 @end itemize
2461
2462 The encoder also has its own specific options:
2463 @subsection Options
2464
2465 @table @option
2466 @item lcu_row_threads
2467 Set the number of parallel threads for rows from 1 to 8 (default 5).
2468
2469 @item initial_qp
2470 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2471 used to set the initial qp for the first frame.
2472
2473 @item qp
2474 Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
2475 used to set the qp value under constant-QP mode.
2476
2477 @item max_qp
2478 Set the max qp for rate control from 1 to 63 (default 55).
2479
2480 @item min_qp
2481 Set the min qp for rate control from 1 to 63 (default 20).
2482
2483 @item speed_level
2484 Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
2485
2486 @item log_level
2487 Set the log level from -1 to 3 (default 0). -1: none, 0: error,
2488 1: warning, 2: info, 3: debug.
2489
2490 @item xavs2-params
2491 Set xavs2 options using a list of @var{key}=@var{value} couples separated
2492 by ":".
2493
2494 For example to specify libxavs2 encoding options with @option{-xavs2-params}:
2495
2496 @example
2497 ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
2498 @end example
2499 @end table
2500
2501 @section libxvid
2502
2503 Xvid MPEG-4 Part 2 encoder wrapper.
2504
2505 This encoder requires the presence of the libxvidcore headers and library
2506 during configuration. You need to explicitly configure the build with
2507 @code{--enable-libxvid --enable-gpl}.
2508
2509 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
2510 users can encode to this format without this library.
2511
2512 @subsection Options
2513
2514 The following options are supported by the libxvid wrapper. Some of
2515 the following options are listed but are not documented, and
2516 correspond to shared codec options. See @ref{codec-options,,the Codec
2517 Options chapter} for their documentation. The other shared options
2518 which are not listed have no effect for the libxvid encoder.
2519
2520 @table @option
2521 @item b
2522
2523 @item g
2524
2525 @item qmin
2526
2527 @item qmax
2528
2529 @item mpeg_quant
2530
2531 @item threads
2532
2533 @item bf
2534
2535 @item b_qfactor
2536
2537 @item b_qoffset
2538
2539 @item flags
2540 Set specific encoding flags. Possible values:
2541
2542 @table @samp
2543
2544 @item mv4
2545 Use four motion vector by macroblock.
2546
2547 @item aic
2548 Enable high quality AC prediction.
2549
2550 @item gray
2551 Only encode grayscale.
2552
2553 @item gmc
2554 Enable the use of global motion compensation (GMC).
2555
2556 @item qpel
2557 Enable quarter-pixel motion compensation.
2558
2559 @item cgop
2560 Enable closed GOP.
2561
2562 @item global_header
2563 Place global headers in extradata instead of every keyframe.
2564
2565 @end table
2566
2567 @item trellis
2568
2569 @item me_method
2570 Set motion estimation method. Possible values in decreasing order of
2571 speed and increasing order of quality:
2572
2573 @table @samp
2574 @item zero
2575 Use no motion estimation (default).
2576
2577 @item phods
2578 @item x1
2579 @item log
2580 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
2581 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
2582 @samp{phods}.
2583
2584 @item epzs
2585 Enable all of the things described above, plus advanced diamond zonal
2586 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
2587 estimation on chroma planes.
2588
2589 @item full
2590 Enable all of the things described above, plus extended 16x16 and 8x8
2591 blocks search.
2592 @end table
2593
2594 @item mbd
2595 Set macroblock decision algorithm. Possible values in the increasing
2596 order of quality:
2597
2598 @table @samp
2599 @item simple
2600 Use macroblock comparing function algorithm (default).
2601
2602 @item bits
2603 Enable rate distortion-based half pixel and quarter pixel refinement for
2604 16x16 blocks.
2605
2606 @item rd
2607 Enable all of the things described above, plus rate distortion-based
2608 half pixel and quarter pixel refinement for 8x8 blocks, and rate
2609 distortion-based search using square pattern.
2610 @end table
2611
2612 @item lumi_aq
2613 Enable lumi masking adaptive quantization when set to 1. Default is 0
2614 (disabled).
2615
2616 @item variance_aq
2617 Enable variance adaptive quantization when set to 1. Default is 0
2618 (disabled).
2619
2620 When combined with @option{lumi_aq}, the resulting quality will not
2621 be better than any of the two specified individually. In other
2622 words, the resulting quality will be the worse one of the two
2623 effects.
2624
2625 @item ssim
2626 Set structural similarity (SSIM) displaying method. Possible values:
2627
2628 @table @samp
2629 @item off
2630 Disable displaying of SSIM information.
2631
2632 @item avg
2633 Output average SSIM at the end of encoding to stdout. The format of
2634 showing the average SSIM is:
2635
2636 @example
2637 Average SSIM: %f
2638 @end example
2639
2640 For users who are not familiar with C, %f means a float number, or
2641 a decimal (e.g. 0.939232).
2642
2643 @item frame
2644 Output both per-frame SSIM data during encoding and average SSIM at
2645 the end of encoding to stdout. The format of per-frame information
2646 is:
2647
2648 @example
2649        SSIM: avg: %1.3f min: %1.3f max: %1.3f
2650 @end example
2651
2652 For users who are not familiar with C, %1.3f means a float number
2653 rounded to 3 digits after the dot (e.g. 0.932).
2654
2655 @end table
2656
2657 @item ssim_acc
2658 Set SSIM accuracy. Valid options are integers within the range of
2659 0-4, while 0 gives the most accurate result and 4 computes the
2660 fastest.
2661
2662 @end table
2663
2664 @section mpeg2
2665
2666 MPEG-2 video encoder.
2667
2668 @subsection Options
2669
2670 @table @option
2671 @item seq_disp_ext @var{integer}
2672 Specifies if the encoder should write a sequence_display_extension to the
2673 output.
2674 @table @option
2675 @item -1
2676 @itemx auto
2677 Decide automatically to write it or not (this is the default) by checking if
2678 the data to be written is different from the default or unspecified values.
2679 @item 0
2680 @itemx never
2681 Never write it.
2682 @item 1
2683 @itemx always
2684 Always write it.
2685 @end table
2686 @item video_format @var{integer}
2687 Specifies the video_format written into the sequence display extension
2688 indicating the source of the video pictures. The default is @samp{unspecified},
2689 can be @samp{component}, @samp{pal}, @samp{ntsc}, @samp{secam} or @samp{mac}.
2690 For maximum compatibility, use @samp{component}.
2691 @item a53cc @var{boolean}
2692 Import closed captions (which must be ATSC compatible format) into output.
2693 Default is 1 (on).
2694 @end table
2695
2696 @section png
2697
2698 PNG image encoder.
2699
2700 @subsection Private options
2701
2702 @table @option
2703 @item dpi @var{integer}
2704 Set physical density of pixels, in dots per inch, unset by default
2705 @item dpm @var{integer}
2706 Set physical density of pixels, in dots per meter, unset by default
2707 @end table
2708
2709 @section ProRes
2710
2711 Apple ProRes encoder.
2712
2713 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
2714 The used encoder can be chosen with the @code{-vcodec} option.
2715
2716 @subsection Private Options for prores-ks
2717
2718 @table @option
2719 @item profile @var{integer}
2720 Select the ProRes profile to encode
2721 @table @samp
2722 @item proxy
2723 @item lt
2724 @item standard
2725 @item hq
2726 @item 4444
2727 @item 4444xq
2728 @end table
2729
2730 @item quant_mat @var{integer}
2731 Select quantization matrix.
2732 @table @samp
2733 @item auto
2734 @item default
2735 @item proxy
2736 @item lt
2737 @item standard
2738 @item hq
2739 @end table
2740 If set to @var{auto}, the matrix matching the profile will be picked.
2741 If not set, the matrix providing the highest quality, @var{default}, will be
2742 picked.
2743
2744 @item bits_per_mb @var{integer}
2745 How many bits to allot for coding one macroblock. Different profiles use
2746 between 200 and 2400 bits per macroblock, the maximum is 8000.
2747
2748 @item mbs_per_slice @var{integer}
2749 Number of macroblocks in each slice (1-8); the default value (8)
2750 should be good in almost all situations.
2751
2752 @item vendor @var{string}
2753 Override the 4-byte vendor ID.
2754 A custom vendor ID like @var{apl0} would claim the stream was produced by
2755 the Apple encoder.
2756
2757 @item alpha_bits @var{integer}
2758 Specify number of bits for alpha component.
2759 Possible values are @var{0}, @var{8} and @var{16}.
2760 Use @var{0} to disable alpha plane coding.
2761
2762 @end table
2763
2764 @subsection Speed considerations
2765
2766 In the default mode of operation the encoder has to honor frame constraints
2767 (i.e. not produce frames with size bigger than requested) while still making
2768 output picture as good as possible.
2769 A frame containing a lot of small details is harder to compress and the encoder
2770 would spend more time searching for appropriate quantizers for each slice.
2771
2772 Setting a higher @option{bits_per_mb} limit will improve the speed.
2773
2774 For the fastest encoding speed set the @option{qscale} parameter (4 is the
2775 recommended value) and do not set a size constraint.
2776
2777 @section QSV encoders
2778
2779 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
2780
2781 The ratecontrol method is selected as follows:
2782
2783 @itemize @bullet
2784 @item
2785 When @option{global_quality} is specified, a quality-based mode is used.
2786 Specifically this means either
2787 @itemize @minus
2788 @item
2789 @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
2790 also set (the @option{-qscale} ffmpeg option).
2791
2792 @item
2793 @var{LA_ICQ} - intelligent constant quality with lookahead, when the
2794 @option{look_ahead} option is also set.
2795
2796 @item
2797 @var{ICQ} -- intelligent constant quality otherwise.
2798 @end itemize
2799
2800 @item
2801 Otherwise, a bitrate-based mode is used. For all of those, you should specify at
2802 least the desired average bitrate with the @option{b} option.
2803 @itemize @minus
2804 @item
2805 @var{LA} - VBR with lookahead, when the @option{look_ahead} option is specified.
2806
2807 @item
2808 @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
2809
2810 @item
2811 @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
2812 the average bitrate.
2813
2814 @item
2815 @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
2816 than the average bitrate.
2817
2818 @item
2819 @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
2820 is further configured by the @option{avbr_accuracy} and
2821 @option{avbr_convergence} options.
2822 @end itemize
2823 @end itemize
2824
2825 Note that depending on your system, a different mode than the one you specified
2826 may be selected by the encoder. Set the verbosity level to @var{verbose} or
2827 higher to see the actual settings used by the QSV runtime.
2828
2829 Additional libavcodec global options are mapped to MSDK options as follows:
2830
2831 @itemize
2832 @item
2833 @option{g/gop_size} -> @option{GopPicSize}
2834
2835 @item
2836 @option{bf/max_b_frames}+1 -> @option{GopRefDist}
2837
2838 @item
2839 @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
2840 @option{InitialDelayInKB}
2841
2842 @item
2843 @option{slices} -> @option{NumSlice}
2844
2845 @item
2846 @option{refs} -> @option{NumRefFrame}
2847
2848 @item
2849 @option{b_strategy/b_frame_strategy} -> @option{BRefType}
2850
2851 @item
2852 @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
2853
2854 @item
2855 For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
2856 @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
2857 and @var{QPP} and @var{QPB} respectively.
2858
2859 @item
2860 Setting the @option{coder} option to the value @var{vlc} will make the H.264
2861 encoder use CAVLC instead of CABAC.
2862
2863 @end itemize
2864
2865 @section snow
2866
2867 @subsection Options
2868
2869 @table @option
2870 @item iterative_dia_size
2871 dia size for the iterative motion estimation
2872 @end table
2873
2874 @section VAAPI encoders
2875
2876 Wrappers for hardware encoders accessible via VAAPI.
2877
2878 These encoders only accept input in VAAPI hardware surfaces.  If you have input
2879 in software frames, use the @option{hwupload} filter to upload them to the GPU.
2880
2881 The following standard libavcodec options are used:
2882 @itemize
2883 @item
2884 @option{g} / @option{gop_size}
2885 @item
2886 @option{bf} / @option{max_b_frames}
2887 @item
2888 @option{profile}
2889
2890 If not set, this will be determined automatically from the format of the input
2891 frames and the profiles supported by the driver.
2892 @item
2893 @option{level}
2894 @item
2895 @option{b} / @option{bit_rate}
2896 @item
2897 @option{maxrate} / @option{rc_max_rate}
2898 @item
2899 @option{bufsize} / @option{rc_buffer_size}
2900 @item
2901 @option{rc_init_occupancy} / @option{rc_initial_buffer_occupancy}
2902 @item
2903 @option{compression_level}
2904
2905 Speed / quality tradeoff: higher values are faster / worse quality.
2906 @item
2907 @option{q} / @option{global_quality}
2908
2909 Size / quality tradeoff: higher values are smaller / worse quality.
2910 @item
2911 @option{qmin}
2912 @item
2913 @option{qmax}
2914 @item
2915 @option{i_qfactor} / @option{i_quant_factor}
2916 @item
2917 @option{i_qoffset} / @option{i_quant_offset}
2918 @item
2919 @option{b_qfactor} / @option{b_quant_factor}
2920 @item
2921 @option{b_qoffset} / @option{b_quant_offset}
2922 @item
2923 @option{slices}
2924 @end itemize
2925
2926 All encoders support the following options:
2927 @table @option
2928 @item low_power
2929 Some drivers/platforms offer a second encoder for some codecs intended to use
2930 less power than the default encoder; setting this option will attempt to use
2931 that encoder.  Note that it may support a reduced feature set, so some other
2932 options may not be available in this mode.
2933
2934 @item idr_interval
2935 Set the number of normal intra frames between full-refresh (IDR) frames in
2936 open-GOP mode.  The intra frames are still IRAPs, but will not include global
2937 headers and may have non-decodable leading pictures.
2938
2939 @item b_depth
2940 Set the B-frame reference depth.  When set to one (the default), all B-frames
2941 will refer only to P- or I-frames.  When set to greater values multiple layers
2942 of B-frames will be present, frames in each layer only referring to frames in
2943 higher layers.
2944
2945 @item rc_mode
2946 Set the rate control mode to use.  A given driver may only support a subset of
2947 modes.
2948
2949 Possible modes:
2950 @table @option
2951 @item auto
2952 Choose the mode automatically based on driver support and the other options.
2953 This is the default.
2954 @item CQP
2955 Constant-quality.
2956 @item CBR
2957 Constant-bitrate.
2958 @item VBR
2959 Variable-bitrate.
2960 @item ICQ
2961 Intelligent constant-quality.
2962 @item QVBR
2963 Quality-defined variable-bitrate.
2964 @item AVBR
2965 Average variable bitrate.
2966 @end table
2967
2968 @end table
2969
2970 Each encoder also has its own specific options:
2971 @table @option
2972
2973 @item h264_vaapi
2974 @option{profile} sets the value of @emph{profile_idc} and the @emph{constraint_set*_flag}s.
2975 @option{level} sets the value of @emph{level_idc}.
2976
2977 @table @option
2978 @item coder
2979 Set entropy encoder (default is @emph{cabac}).  Possible values:
2980
2981 @table @samp
2982 @item ac
2983 @item cabac
2984 Use CABAC.
2985
2986 @item vlc
2987 @item cavlc
2988 Use CAVLC.
2989 @end table
2990
2991 @item aud
2992 Include access unit delimiters in the stream (not included by default).
2993
2994 @item sei
2995 Set SEI message types to include.
2996 Some combination of the following values:
2997 @table @samp
2998 @item identifier
2999 Include a @emph{user_data_unregistered} message containing information about
3000 the encoder.
3001 @item timing
3002 Include picture timing parameters (@emph{buffering_period} and
3003 @emph{pic_timing} messages).
3004 @item recovery_point
3005 Include recovery points where appropriate (@emph{recovery_point} messages).
3006 @end table
3007
3008 @end table
3009
3010 @item hevc_vaapi
3011 @option{profile} and @option{level} set the values of
3012 @emph{general_profile_idc} and @emph{general_level_idc} respectively.
3013
3014 @table @option
3015 @item aud
3016 Include access unit delimiters in the stream (not included by default).
3017
3018 @item tier
3019 Set @emph{general_tier_flag}.  This may affect the level chosen for the stream
3020 if it is not explicitly specified.
3021
3022 @item sei
3023 Set SEI message types to include.
3024 Some combination of the following values:
3025 @table @samp
3026 @item hdr
3027 Include HDR metadata if the input frames have it
3028 (@emph{mastering_display_colour_volume} and @emph{content_light_level}
3029 messages).
3030 @end table
3031
3032 @end table
3033
3034 @item mjpeg_vaapi
3035 Only baseline DCT encoding is supported.  The encoder always uses the standard
3036 quantisation and huffman tables - @option{global_quality} scales the standard
3037 quantisation table (range 1-100).
3038
3039 For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported.  RGB is also
3040 supported, and will create an RGB JPEG.
3041
3042 @table @option
3043 @item jfif
3044 Include JFIF header in each frame (not included by default).
3045 @item huffman
3046 Include standard huffman tables (on by default).  Turning this off will save
3047 a few hundred bytes in each output frame, but may lose compatibility with some
3048 JPEG decoders which don't fully handle MJPEG.
3049 @end table
3050
3051 @item mpeg2_vaapi
3052 @option{profile} and @option{level} set the value of @emph{profile_and_level_indication}.
3053
3054 @item vp8_vaapi
3055 B-frames are not supported.
3056
3057 @option{global_quality} sets the @emph{q_idx} used for non-key frames (range 0-127).
3058
3059 @table @option
3060 @item loop_filter_level
3061 @item loop_filter_sharpness
3062 Manually set the loop filter parameters.
3063 @end table
3064
3065 @item vp9_vaapi
3066 @option{global_quality} sets the @emph{q_idx} used for P-frames (range 0-255).
3067
3068 @table @option
3069 @item loop_filter_level
3070 @item loop_filter_sharpness
3071 Manually set the loop filter parameters.
3072 @end table
3073
3074 B-frames are supported, but the output stream is always in encode order rather than display
3075 order.  If B-frames are enabled, it may be necessary to use the @option{vp9_raw_reorder}
3076 bitstream filter to modify the output stream to display frames in the correct order.
3077
3078 Only normal frames are produced - the @option{vp9_superframe} bitstream filter may be
3079 required to produce a stream usable with all decoders.
3080
3081 @end table
3082
3083 @section vc2
3084
3085 SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
3086 professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
3087 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
3088 other tasks which require low overhead and low compression (like screen
3089 recording).
3090
3091 @subsection Options
3092
3093 @table @option
3094
3095 @item b
3096 Sets target video bitrate. Usually that's around 1:6 of the uncompressed
3097 video bitrate (e.g. for 1920x1080 50fps yuv422p10 that's around 400Mbps). Higher
3098 values (close to the uncompressed bitrate) turn on lossless compression mode.
3099
3100 @item field_order
3101 Enables field coding when set (e.g. to tt - top field first) for interlaced
3102 inputs. Should increase compression with interlaced content as it splits the
3103 fields and encodes each separately.
3104
3105 @item wavelet_depth
3106 Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
3107 Lower values reduce compression and quality. Less capable decoders may not be
3108 able to handle values of @option{wavelet_depth} over 3.
3109
3110 @item wavelet_type
3111 Sets the transform type. Currently only @var{5_3} (LeGall) and @var{9_7}
3112 (Deslauriers-Dubuc)
3113 are implemented, with 9_7 being the one with better compression and thus
3114 is the default.
3115
3116 @item slice_width
3117 @item slice_height
3118 Sets the slice size for each slice. Larger values result in better compression.
3119 For compatibility with other more limited decoders use @option{slice_width} of
3120 32 and @option{slice_height} of 8.
3121
3122 @item tolerance
3123 Sets the undershoot tolerance of the rate control system in percent. This is
3124 to prevent an expensive search from being run.
3125
3126 @item qm
3127 Sets the quantization matrix preset to use by default or when @option{wavelet_depth}
3128 is set to 5
3129 @itemize @minus
3130 @item
3131 @var{default}
3132 Uses the default quantization matrix from the specifications, extended with
3133 values for the fifth level. This provides a good balance between keeping detail
3134 and omitting artifacts.
3135
3136 @item
3137 @var{flat}
3138 Use a completely zeroed out quantization matrix. This increases PSNR but might
3139 reduce perception. Use in bogus benchmarks.
3140
3141 @item
3142 @var{color}
3143 Reduces detail but attempts to preserve color at extremely low bitrates.
3144 @end itemize
3145
3146 @end table
3147
3148 @c man end VIDEO ENCODERS
3149
3150 @chapter Subtitles Encoders
3151 @c man begin SUBTITLES ENCODERS
3152
3153 @section dvdsub
3154
3155 This codec encodes the bitmap subtitle format that is used in DVDs.
3156 Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
3157 and they can also be used in Matroska files.
3158
3159 @subsection Options
3160
3161 @table @option
3162 @item even_rows_fix
3163 When set to 1, enable a work-around that makes the number of pixel rows
3164 even in all subtitles.  This fixes a problem with some players that
3165 cut off the bottom row if the number is odd.  The work-around just adds
3166 a fully transparent row if needed.  The overhead is low, typically
3167 one byte per subtitle on average.
3168
3169 By default, this work-around is disabled.
3170 @end table
3171
3172 @c man end SUBTITLES ENCODERS