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