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