doc/encoders: add documentation for the Hap encoder
[ffmpeg.git] / doc / encoders.texi
1 @chapter Encoders
2 @c man begin ENCODERS
3
4 Encoders are configured elements in FFmpeg which allow the encoding of
5 multimedia streams.
6
7 When you configure your FFmpeg build, all the supported native encoders
8 are enabled by default. Encoders requiring an external library must be enabled
9 manually via the corresponding @code{--enable-lib} option. You can list all
10 available encoders using the configure option @code{--list-encoders}.
11
12 You can disable all the encoders with the configure option
13 @code{--disable-encoders} and selectively enable / disable single encoders
14 with the options @code{--enable-encoder=@var{ENCODER}} /
15 @code{--disable-encoder=@var{ENCODER}}.
16
17 The option @code{-encoders} of the ff* tools will display the list of
18 enabled encoders.
19
20 @c man end ENCODERS
21
22 @chapter Audio Encoders
23 @c man begin AUDIO ENCODERS
24
25 A description of some of the currently available audio encoders
26 follows.
27
28 @anchor{aacenc}
29 @section aac
30
31 Advanced Audio Coding (AAC) encoder.
32
33 This encoder is the default AAC encoder, natively implemented into FFmpeg. Its
34 quality is on par or better than libfdk_aac at the default bitrate of 128kbps.
35 This encoder also implements more options, profiles and samplerates than
36 other encoders (with only the AAC-HE profile pending to be implemented) so this
37 encoder has become the default and is the recommended choice.
38
39 @subsection Options
40
41 @table @option
42 @item b
43 Set bit rate in bits/s. Setting this automatically activates constant bit rate
44 (CBR) mode. If this option is unspecified it is set to 128kbps.
45
46 @item q
47 Set quality for variable bit rate (VBR) mode. This option is valid only using
48 the @command{ffmpeg} command-line tool. For library interface users, use
49 @option{global_quality}.
50
51 @item cutoff
52 Set cutoff frequency. If unspecified will allow the encoder to dynamically
53 adjust the cutoff to improve clarity on low bitrates.
54
55 @item aac_coder
56 Set AAC encoder coding method. Possible values:
57
58 @table @samp
59 @item twoloop
60 Two loop searching (TLS) method.
61
62 This method first sets quantizers depending on band thresholds and then tries
63 to find an optimal combination by adding or subtracting a specific value from
64 all quantizers and adjusting some individual quantizer a little.  Will tune
65 itself based on whether @option{aac_is}, @option{aac_ms} and @option{aac_pns}
66 are enabled.
67 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 @anchor{libshine}
874 @section libshine
875
876 Shine Fixed-Point MP3 encoder wrapper.
877
878 Shine is a fixed-point MP3 encoder. It has a far better performance on
879 platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
880 However, as it is more targeted on performance than quality, it is not on par
881 with LAME and other production-grade encoders quality-wise. Also, according to
882 the project's homepage, this encoder may not be free of bugs as the code was
883 written a long time ago and the project was dead for at least 5 years.
884
885 This encoder only supports stereo and mono input. This is also CBR-only.
886
887 The original project (last updated in early 2007) is at
888 @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
889 updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
890
891 Requires the presence of the libshine headers and library during
892 configuration. You need to explicitly configure the build with
893 @code{--enable-libshine}.
894
895 See also @ref{libmp3lame}.
896
897 @subsection Options
898
899 The following options are supported by the libshine wrapper. The
900 @command{shineenc}-equivalent of the options are listed in parentheses.
901
902 @table @option
903 @item b (@emph{-b})
904 Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
905 is expressed in kilobits/s.
906
907 @end table
908
909 @section libtwolame
910
911 TwoLAME MP2 encoder wrapper.
912
913 Requires the presence of the libtwolame headers and library during
914 configuration. You need to explicitly configure the build with
915 @code{--enable-libtwolame}.
916
917 @subsection Options
918
919 The following options are supported by the libtwolame wrapper. The
920 @command{twolame}-equivalent options follow the FFmpeg ones and are in
921 parentheses.
922
923 @table @option
924 @item b (@emph{-b})
925 Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
926 option is expressed in kilobits/s. Default value is 128k.
927
928 @item q (@emph{-V})
929 Set quality for experimental VBR support. Maximum value range is
930 from -50 to 50, useful range is from -10 to 10. The higher the
931 value, the better the quality. This option is valid only using the
932 @command{ffmpeg} command-line tool. For library interface users,
933 use @option{global_quality}.
934
935 @item mode (@emph{--mode})
936 Set the mode of the resulting audio. Possible values:
937
938 @table @samp
939 @item auto
940 Choose mode automatically based on the input. This is the default.
941 @item stereo
942 Stereo
943 @item joint_stereo
944 Joint stereo
945 @item dual_channel
946 Dual channel
947 @item mono
948 Mono
949 @end table
950
951 @item psymodel (@emph{--psyc-mode})
952 Set psychoacoustic model to use in encoding. The argument must be
953 an integer between -1 and 4, inclusive. The higher the value, the
954 better the quality. The default value is 3.
955
956 @item energy_levels (@emph{--energy})
957 Enable energy levels extensions when set to 1. The default value is
958 0 (disabled).
959
960 @item error_protection (@emph{--protect})
961 Enable CRC error protection when set to 1. The default value is 0
962 (disabled).
963
964 @item copyright (@emph{--copyright})
965 Set MPEG audio copyright flag when set to 1. The default value is 0
966 (disabled).
967
968 @item original (@emph{--original})
969 Set MPEG audio original flag when set to 1. The default value is 0
970 (disabled).
971
972 @end table
973
974 @section libvo-amrwbenc
975
976 VisualOn Adaptive Multi-Rate Wideband encoder.
977
978 Requires the presence of the libvo-amrwbenc headers and library during
979 configuration. You need to explicitly configure the build with
980 @code{--enable-libvo-amrwbenc --enable-version3}.
981
982 This is a mono-only encoder. Officially it only supports 16000Hz sample
983 rate, but you can override it by setting @option{strict} to
984 @samp{unofficial} or lower.
985
986 @subsection Options
987
988 @table @option
989
990 @item b
991 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
992 libavcodec will round to the nearest valid bitrate.
993
994 @table @samp
995 @item 6600
996 @item 8850
997 @item 12650
998 @item 14250
999 @item 15850
1000 @item 18250
1001 @item 19850
1002 @item 23050
1003 @item 23850
1004 @end table
1005
1006 @item dtx
1007 Allow discontinuous transmission (generate comfort noise) when set to 1. The
1008 default value is 0 (disabled).
1009
1010 @end table
1011
1012 @section libopus
1013
1014 libopus Opus Interactive Audio Codec encoder wrapper.
1015
1016 Requires the presence of the libopus headers and library during
1017 configuration. You need to explicitly configure the build with
1018 @code{--enable-libopus}.
1019
1020 @subsection Option Mapping
1021
1022 Most libopus options are modelled after the @command{opusenc} utility from
1023 opus-tools. The following is an option mapping chart describing options
1024 supported by the libopus wrapper, and their @command{opusenc}-equivalent
1025 in parentheses.
1026
1027 @table @option
1028
1029 @item b (@emph{bitrate})
1030 Set the bit rate in bits/s.  FFmpeg's @option{b} option is
1031 expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
1032 kilobits/s.
1033
1034 @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
1035 Set VBR mode. The FFmpeg @option{vbr} option has the following
1036 valid arguments, with the @command{opusenc} equivalent options
1037 in parentheses:
1038
1039 @table @samp
1040 @item off (@emph{hard-cbr})
1041 Use constant bit rate encoding.
1042
1043 @item on (@emph{vbr})
1044 Use variable bit rate encoding (the default).
1045
1046 @item constrained (@emph{cvbr})
1047 Use constrained variable bit rate encoding.
1048 @end table
1049
1050 @item compression_level (@emph{comp})
1051 Set encoding algorithm complexity. Valid options are integers in
1052 the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
1053 gives the highest quality but slowest encoding. The default is 10.
1054
1055 @item frame_duration (@emph{framesize})
1056 Set maximum frame size, or duration of a frame in milliseconds. The
1057 argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
1058 frame sizes achieve lower latency but less quality at a given bitrate.
1059 Sizes greater than 20ms are only interesting at fairly low bitrates.
1060 The default is 20ms.
1061
1062 @item packet_loss (@emph{expect-loss})
1063 Set expected packet loss percentage. The default is 0.
1064
1065 @item application (N.A.)
1066 Set intended application type. Valid options are listed below:
1067
1068 @table @samp
1069 @item voip
1070 Favor improved speech intelligibility.
1071 @item audio
1072 Favor faithfulness to the input (the default).
1073 @item lowdelay
1074 Restrict to only the lowest delay modes.
1075 @end table
1076
1077 @item cutoff (N.A.)
1078 Set cutoff bandwidth in Hz. The argument must be exactly one of the
1079 following: 4000, 6000, 8000, 12000, or 20000, corresponding to
1080 narrowband, mediumband, wideband, super wideband, and fullband
1081 respectively. The default is 0 (cutoff disabled).
1082
1083 @item mapping_family (@emph{mapping_family})
1084 Set channel mapping family to be used by the encoder. The default value of -1
1085 uses mapping family 0 for mono and stereo inputs, and mapping family 1
1086 otherwise. The default also disables the surround masking and LFE bandwidth
1087 optimzations in libopus, and requires that the input contains 8 channels or
1088 fewer.
1089
1090 Other values include 0 for mono and stereo, 1 for surround sound with masking
1091 and LFE bandwidth optimizations, and 255 for independent streams with an
1092 unspecified channel layout.
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 libopenh264
1265
1266 Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
1267
1268 This encoder requires the presence of the libopenh264 headers and
1269 library during configuration. You need to explicitly configure the
1270 build with @code{--enable-libopenh264}. The library is detected using
1271 @command{pkg-config}.
1272
1273 For more information about the library see
1274 @url{http://www.openh264.org}.
1275
1276 @subsection Options
1277
1278 The following FFmpeg global options affect the configurations of the
1279 libopenh264 encoder.
1280
1281 @table @option
1282 @item b
1283 Set the bitrate (as a number of bits per second).
1284
1285 @item g
1286 Set the GOP size.
1287
1288 @item maxrate
1289 Set the max bitrate (as a number of bits per second).
1290
1291 @item flags +global_header
1292 Set global header in the bitstream.
1293
1294 @item slices
1295 Set the number of slices, used in parallelized encoding. Default value
1296 is 0. This is only used when @option{slice_mode} is set to
1297 @samp{fixed}.
1298
1299 @item slice_mode
1300 Set slice mode. Can assume one of the following possible values:
1301
1302 @table @samp
1303 @item fixed
1304 a fixed number of slices
1305 @item rowmb
1306 one slice per row of macroblocks
1307 @item auto
1308 automatic number of slices according to number of threads
1309 @item dyn
1310 dynamic slicing
1311 @end table
1312
1313 Default value is @samp{auto}.
1314
1315 @item loopfilter
1316 Enable loop filter, if set to 1 (automatically enabled). To disable
1317 set a value of 0.
1318
1319 @item profile
1320 Set profile restrictions. If set to the value of @samp{main} enable
1321 CABAC (set the @code{SEncParamExt.iEntropyCodingModeFlag} flag to 1).
1322
1323 @item max_nal_size
1324 Set maximum NAL size in bytes.
1325
1326 @item allow_skip_frames
1327 Allow skipping frames to hit the target bitrate if set to 1.
1328 @end table
1329
1330 @section jpeg2000
1331
1332 The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
1333 option can be used to set the encoding quality. Lossless encoding
1334 can be selected with @code{-pred 1}.
1335
1336 @subsection Options
1337
1338 @table @option
1339 @item format
1340 Can be set to either @code{j2k} or @code{jp2} (the default) that
1341 makes it possible to store non-rgb pix_fmts.
1342
1343 @end table
1344
1345 @section snow
1346
1347 @subsection Options
1348
1349 @table @option
1350 @item iterative_dia_size
1351 dia size for the iterative motion estimation
1352 @end table
1353
1354 @section libtheora
1355
1356 libtheora Theora encoder wrapper.
1357
1358 Requires the presence of the libtheora headers and library during
1359 configuration. You need to explicitly configure the build with
1360 @code{--enable-libtheora}.
1361
1362 For more information about the libtheora project see
1363 @url{http://www.theora.org/}.
1364
1365 @subsection Options
1366
1367 The following global options are mapped to internal libtheora options
1368 which affect the quality and the bitrate of the encoded stream.
1369
1370 @table @option
1371 @item b
1372 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1373 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1374
1375 @item flags
1376 Used to enable constant quality mode (VBR) encoding through the
1377 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1378 modes.
1379
1380 @item g
1381 Set the GOP size.
1382
1383 @item global_quality
1384 Set the global quality as an integer in lambda units.
1385
1386 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1387 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1388 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1389 value in the native libtheora range [0-63]. A higher value corresponds
1390 to a higher quality.
1391
1392 @item q
1393 Enable VBR mode when set to a non-negative value, and set constant
1394 quality value as a double floating point value in QP units.
1395
1396 The value is clipped in the [0-10] range, and then multiplied by 6.3
1397 to get a value in the native libtheora range [0-63].
1398
1399 This option is valid only using the @command{ffmpeg} command-line
1400 tool. For library interface users, use @option{global_quality}.
1401 @end table
1402
1403 @subsection Examples
1404
1405 @itemize
1406 @item
1407 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1408 @example
1409 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1410 @end example
1411
1412 @item
1413 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1414 @example
1415 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1416 @end example
1417 @end itemize
1418
1419 @section libvpx
1420
1421 VP8/VP9 format supported through libvpx.
1422
1423 Requires the presence of the libvpx headers and library during configuration.
1424 You need to explicitly configure the build with @code{--enable-libvpx}.
1425
1426 @subsection Options
1427
1428 The following options are supported by the libvpx wrapper. The
1429 @command{vpxenc}-equivalent options or values are listed in parentheses
1430 for easy migration.
1431
1432 To reduce the duplication of documentation, only the private options
1433 and some others requiring special attention are documented here. For
1434 the documentation of the undocumented generic options, see
1435 @ref{codec-options,,the Codec Options chapter}.
1436
1437 To get more documentation of the libvpx options, invoke the command
1438 @command{ffmpeg -h encoder=libvpx}, @command{ffmpeg -h encoder=libvpx-vp9} or
1439 @command{vpxenc --help}. Further information is available in the libvpx API
1440 documentation.
1441
1442 @table @option
1443
1444 @item b (@emph{target-bitrate})
1445 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1446 expressed in bits/s, while @command{vpxenc}'s @option{target-bitrate} is in
1447 kilobits/s.
1448
1449 @item g (@emph{kf-max-dist})
1450
1451 @item keyint_min (@emph{kf-min-dist})
1452
1453 @item qmin (@emph{min-q})
1454
1455 @item qmax (@emph{max-q})
1456
1457 @item bufsize (@emph{buf-sz}, @emph{buf-optimal-sz})
1458 Set ratecontrol buffer size (in bits). Note @command{vpxenc}'s options are
1459 specified in milliseconds, the libvpx wrapper converts this value as follows:
1460 @code{buf-sz = bufsize * 1000 / bitrate},
1461 @code{buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6}.
1462
1463 @item rc_init_occupancy (@emph{buf-initial-sz})
1464 Set number of bits which should be loaded into the rc buffer before decoding
1465 starts. Note @command{vpxenc}'s option is specified in milliseconds, the libvpx
1466 wrapper converts this value as follows:
1467 @code{rc_init_occupancy * 1000 / bitrate}.
1468
1469 @item undershoot-pct
1470 Set datarate undershoot (min) percentage of the target bitrate.
1471
1472 @item overshoot-pct
1473 Set datarate overshoot (max) percentage of the target bitrate.
1474
1475 @item skip_threshold (@emph{drop-frame})
1476
1477 @item qcomp (@emph{bias-pct})
1478
1479 @item maxrate (@emph{maxsection-pct})
1480 Set GOP max bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1481 percentage of the target bitrate, the libvpx wrapper converts this value as
1482 follows: @code{(maxrate * 100 / bitrate)}.
1483
1484 @item minrate (@emph{minsection-pct})
1485 Set GOP min bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
1486 percentage of the target bitrate, the libvpx wrapper converts this value as
1487 follows: @code{(minrate * 100 / bitrate)}.
1488
1489 @item minrate, maxrate, b @emph{end-usage=cbr}
1490 @code{(minrate == maxrate == bitrate)}.
1491
1492 @item crf (@emph{end-usage=cq}, @emph{cq-level})
1493
1494 @item tune (@emph{tune})
1495 @table @samp
1496 @item psnr (@emph{psnr})
1497 @item ssim (@emph{ssim})
1498 @end table
1499
1500 @item quality, deadline (@emph{deadline})
1501 @table @samp
1502 @item best
1503 Use best quality deadline. Poorly named and quite slow, this option should be
1504 avoided as it may give worse quality output than good.
1505 @item good
1506 Use good quality deadline. This is a good trade-off between speed and quality
1507 when used with the @option{cpu-used} option.
1508 @item realtime
1509 Use realtime quality deadline.
1510 @end table
1511
1512 @item speed, cpu-used (@emph{cpu-used})
1513 Set quality/speed ratio modifier. Higher values speed up the encode at the cost
1514 of quality.
1515
1516 @item nr (@emph{noise-sensitivity})
1517
1518 @item static-thresh
1519 Set a change threshold on blocks below which they will be skipped by the
1520 encoder.
1521
1522 @item slices (@emph{token-parts})
1523 Note that FFmpeg's @option{slices} option gives the total number of partitions,
1524 while @command{vpxenc}'s @option{token-parts} is given as
1525 @code{log2(partitions)}.
1526
1527 @item max-intra-rate
1528 Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
1529 means unlimited.
1530
1531 @item force_key_frames
1532 @code{VPX_EFLAG_FORCE_KF}
1533
1534 @item Alternate reference frame related
1535 @table @option
1536 @item auto-alt-ref
1537 Enable use of alternate reference frames (2-pass only).
1538 @item arnr-max-frames
1539 Set altref noise reduction max frame count.
1540 @item arnr-type
1541 Set altref noise reduction filter type: backward, forward, centered.
1542 @item arnr-strength
1543 Set altref noise reduction filter strength.
1544 @item rc-lookahead, lag-in-frames (@emph{lag-in-frames})
1545 Set number of frames to look ahead for frametype and ratecontrol.
1546 @end table
1547
1548 @item error-resilient
1549 Enable error resiliency features.
1550
1551 @item VP9-specific options
1552 @table @option
1553 @item lossless
1554 Enable lossless mode.
1555 @item tile-columns
1556 Set number of tile columns to use. Note this is given as
1557 @code{log2(tile_columns)}. For example, 8 tile columns would be requested by
1558 setting the @option{tile-columns} option to 3.
1559 @item tile-rows
1560 Set number of tile rows to use. Note this is given as @code{log2(tile_rows)}.
1561 For example, 4 tile rows would be requested by setting the @option{tile-rows}
1562 option to 2.
1563 @item frame-parallel
1564 Enable frame parallel decodability features.
1565 @item aq-mode
1566 Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
1567 cyclic refresh).
1568 @item colorspace @emph{color-space}
1569 Set input color space. The VP9 bitstream supports signaling the following
1570 colorspaces:
1571 @table @option
1572 @item @samp{rgb} @emph{sRGB}
1573 @item @samp{bt709} @emph{bt709}
1574 @item @samp{unspecified} @emph{unknown}
1575 @item @samp{bt470bg} @emph{bt601}
1576 @item @samp{smpte170m} @emph{smpte170}
1577 @item @samp{smpte240m} @emph{smpte240}
1578 @item @samp{bt2020_ncl} @emph{bt2020}
1579 @end table
1580 @end table
1581
1582 @end table
1583
1584 For more information about libvpx see:
1585 @url{http://www.webmproject.org/}
1586
1587
1588 @section libwebp
1589
1590 libwebp WebP Image encoder wrapper
1591
1592 libwebp is Google's official encoder for WebP images. It can encode in either
1593 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
1594 frame. Lossless images are a separate codec developed by Google.
1595
1596 @subsection Pixel Format
1597
1598 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
1599 to limitations of the format and libwebp. Alpha is supported for either mode.
1600 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
1601 passed in for encoding lossless, the pixel format will automatically be
1602 converted using functions from libwebp. This is not ideal and is done only for
1603 convenience.
1604
1605 @subsection Options
1606
1607 @table @option
1608
1609 @item -lossless @var{boolean}
1610 Enables/Disables use of lossless mode. Default is 0.
1611
1612 @item -compression_level @var{integer}
1613 For lossy, this is a quality/speed tradeoff. Higher values give better quality
1614 for a given size at the cost of increased encoding time. For lossless, this is
1615 a size/speed tradeoff. Higher values give smaller size at the cost of increased
1616 encoding time. More specifically, it controls the number of extra algorithms
1617 and compression tools used, and varies the combination of these tools. This
1618 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
1619 Default is 4.
1620
1621 @item -qscale @var{float}
1622 For lossy encoding, this controls image quality, 0 to 100. For lossless
1623 encoding, this controls the effort and time spent at compressing more. The
1624 default value is 75. Note that for usage via libavcodec, this option is called
1625 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
1626
1627 @item -preset @var{type}
1628 Configuration preset. This does some automatic settings based on the general
1629 type of the image.
1630 @table @option
1631 @item none
1632 Do not use a preset.
1633 @item default
1634 Use the encoder default.
1635 @item picture
1636 Digital picture, like portrait, inner shot
1637 @item photo
1638 Outdoor photograph, with natural lighting
1639 @item drawing
1640 Hand or line drawing, with high-contrast details
1641 @item icon
1642 Small-sized colorful images
1643 @item text
1644 Text-like
1645 @end table
1646
1647 @end table
1648
1649 @section libx264, libx264rgb
1650
1651 x264 H.264/MPEG-4 AVC encoder wrapper.
1652
1653 This encoder requires the presence of the libx264 headers and library
1654 during configuration. You need to explicitly configure the build with
1655 @code{--enable-libx264}.
1656
1657 libx264 supports an impressive number of features, including 8x8 and
1658 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
1659 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
1660 for detail retention (adaptive quantization, psy-RD, psy-trellis).
1661
1662 Many libx264 encoder options are mapped to FFmpeg global codec
1663 options, while unique encoder options are provided through private
1664 options. Additionally the @option{x264opts} and @option{x264-params}
1665 private options allows one to pass a list of key=value tuples as accepted
1666 by the libx264 @code{x264_param_parse} function.
1667
1668 The x264 project website is at
1669 @url{http://www.videolan.org/developers/x264.html}.
1670
1671 The libx264rgb encoder is the same as libx264, except it accepts packed RGB
1672 pixel formats as input instead of YUV.
1673
1674 @subsection Supported Pixel Formats
1675
1676 x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
1677 x264's configure time. FFmpeg only supports one bit depth in one particular
1678 build. In other words, it is not possible to build one FFmpeg with multiple
1679 versions of x264 with different bit depths.
1680
1681 @subsection Options
1682
1683 The following options are supported by the libx264 wrapper. The
1684 @command{x264}-equivalent options or values are listed in parentheses
1685 for easy migration.
1686
1687 To reduce the duplication of documentation, only the private options
1688 and some others requiring special attention are documented here. For
1689 the documentation of the undocumented generic options, see
1690 @ref{codec-options,,the Codec Options chapter}.
1691
1692 To get a more accurate and extensive documentation of the libx264
1693 options, invoke the command @command{x264 --full-help} or consult
1694 the libx264 documentation.
1695
1696 @table @option
1697 @item b (@emph{bitrate})
1698 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1699 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
1700 kilobits/s.
1701
1702 @item bf (@emph{bframes})
1703
1704 @item g (@emph{keyint})
1705
1706 @item qmin (@emph{qpmin})
1707 Minimum quantizer scale.
1708
1709 @item qmax (@emph{qpmax})
1710 Maximum quantizer scale.
1711
1712 @item qdiff (@emph{qpstep})
1713 Maximum difference between quantizer scales.
1714
1715 @item qblur (@emph{qblur})
1716 Quantizer curve blur
1717
1718 @item qcomp (@emph{qcomp})
1719 Quantizer curve compression factor
1720
1721 @item refs (@emph{ref})
1722 Number of reference frames each P-frame can use. The range is from @var{0-16}.
1723
1724 @item sc_threshold (@emph{scenecut})
1725 Sets the threshold for the scene change detection.
1726
1727 @item trellis (@emph{trellis})
1728 Performs Trellis quantization to increase efficiency. Enabled by default.
1729
1730 @item nr  (@emph{nr})
1731
1732 @item me_range (@emph{merange})
1733 Maximum range of the motion search in pixels.
1734
1735 @item me_method (@emph{me})
1736 Set motion estimation method. Possible values in the decreasing order
1737 of speed:
1738
1739 @table @samp
1740 @item dia (@emph{dia})
1741 @item epzs (@emph{dia})
1742 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
1743 @samp{dia}.
1744 @item hex (@emph{hex})
1745 Hexagonal search with radius 2.
1746 @item umh (@emph{umh})
1747 Uneven multi-hexagon search.
1748 @item esa (@emph{esa})
1749 Exhaustive search.
1750 @item tesa (@emph{tesa})
1751 Hadamard exhaustive search (slowest).
1752 @end table
1753
1754 @item forced-idr
1755 Normally, when forcing a I-frame type, the encoder can select any type
1756 of I-frame. This option forces it to choose an IDR-frame.
1757
1758 @item subq (@emph{subme})
1759 Sub-pixel motion estimation method.
1760
1761 @item b_strategy (@emph{b-adapt})
1762 Adaptive B-frame placement decision algorithm. Use only on first-pass.
1763
1764 @item keyint_min (@emph{min-keyint})
1765 Minimum GOP size.
1766
1767 @item coder
1768 Set entropy encoder. Possible values:
1769
1770 @table @samp
1771 @item ac
1772 Enable CABAC.
1773
1774 @item vlc
1775 Enable CAVLC and disable CABAC. It generates the same effect as
1776 @command{x264}'s @option{--no-cabac} option.
1777 @end table
1778
1779 @item cmp
1780 Set full pixel motion estimation comparison algorithm. Possible values:
1781
1782 @table @samp
1783 @item chroma
1784 Enable chroma in motion estimation.
1785
1786 @item sad
1787 Ignore chroma in motion estimation. It generates the same effect as
1788 @command{x264}'s @option{--no-chroma-me} option.
1789 @end table
1790
1791 @item threads (@emph{threads})
1792 Number of encoding threads.
1793
1794 @item thread_type
1795 Set multithreading technique. Possible values:
1796
1797 @table @samp
1798 @item slice
1799 Slice-based multithreading. It generates the same effect as
1800 @command{x264}'s @option{--sliced-threads} option.
1801 @item frame
1802 Frame-based multithreading.
1803 @end table
1804
1805 @item flags
1806 Set encoding flags. It can be used to disable closed GOP and enable
1807 open GOP by setting it to @code{-cgop}. The result is similar to
1808 the behavior of @command{x264}'s @option{--open-gop} option.
1809
1810 @item rc_init_occupancy (@emph{vbv-init})
1811
1812 @item preset (@emph{preset})
1813 Set the encoding preset.
1814
1815 @item tune (@emph{tune})
1816 Set tuning of the encoding params.
1817
1818 @item profile (@emph{profile})
1819 Set profile restrictions.
1820
1821 @item fastfirstpass
1822 Enable fast settings when encoding first pass, when set to 1. When set
1823 to 0, it has the same effect of @command{x264}'s
1824 @option{--slow-firstpass} option.
1825
1826 @item crf (@emph{crf})
1827 Set the quality for constant quality mode.
1828
1829 @item crf_max (@emph{crf-max})
1830 In CRF mode, prevents VBV from lowering quality beyond this point.
1831
1832 @item qp (@emph{qp})
1833 Set constant quantization rate control method parameter.
1834
1835 @item aq-mode (@emph{aq-mode})
1836 Set AQ method. Possible values:
1837
1838 @table @samp
1839 @item none (@emph{0})
1840 Disabled.
1841
1842 @item variance (@emph{1})
1843 Variance AQ (complexity mask).
1844
1845 @item autovariance (@emph{2})
1846 Auto-variance AQ (experimental).
1847 @end table
1848
1849 @item aq-strength (@emph{aq-strength})
1850 Set AQ strength, reduce blocking and blurring in flat and textured areas.
1851
1852 @item psy
1853 Use psychovisual optimizations when set to 1. When set to 0, it has the
1854 same effect as @command{x264}'s @option{--no-psy} option.
1855
1856 @item psy-rd  (@emph{psy-rd})
1857 Set strength of psychovisual optimization, in
1858 @var{psy-rd}:@var{psy-trellis} format.
1859
1860 @item rc-lookahead (@emph{rc-lookahead})
1861 Set number of frames to look ahead for frametype and ratecontrol.
1862
1863 @item weightb
1864 Enable weighted prediction for B-frames when set to 1. When set to 0,
1865 it has the same effect as @command{x264}'s @option{--no-weightb} option.
1866
1867 @item weightp (@emph{weightp})
1868 Set weighted prediction method for P-frames. Possible values:
1869
1870 @table @samp
1871 @item none (@emph{0})
1872 Disabled
1873 @item simple (@emph{1})
1874 Enable only weighted refs
1875 @item smart (@emph{2})
1876 Enable both weighted refs and duplicates
1877 @end table
1878
1879 @item ssim (@emph{ssim})
1880 Enable calculation and printing SSIM stats after the encoding.
1881
1882 @item intra-refresh (@emph{intra-refresh})
1883 Enable the use of Periodic Intra Refresh instead of IDR frames when set
1884 to 1.
1885
1886 @item avcintra-class (@emph{class})
1887 Configure the encoder to generate AVC-Intra.
1888 Valid values are 50,100 and 200
1889
1890 @item bluray-compat (@emph{bluray-compat})
1891 Configure the encoder to be compatible with the bluray standard.
1892 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
1893
1894 @item b-bias (@emph{b-bias})
1895 Set the influence on how often B-frames are used.
1896
1897 @item b-pyramid (@emph{b-pyramid})
1898 Set method for keeping of some B-frames as references. Possible values:
1899
1900 @table @samp
1901 @item none (@emph{none})
1902 Disabled.
1903 @item strict (@emph{strict})
1904 Strictly hierarchical pyramid.
1905 @item normal (@emph{normal})
1906 Non-strict (not Blu-ray compatible).
1907 @end table
1908
1909 @item mixed-refs
1910 Enable the use of one reference per partition, as opposed to one
1911 reference per macroblock when set to 1. When set to 0, it has the
1912 same effect as @command{x264}'s @option{--no-mixed-refs} option.
1913
1914 @item 8x8dct
1915 Enable adaptive spatial transform (high profile 8x8 transform)
1916 when set to 1. When set to 0, it has the same effect as
1917 @command{x264}'s @option{--no-8x8dct} option.
1918
1919 @item fast-pskip
1920 Enable early SKIP detection on P-frames when set to 1. When set
1921 to 0, it has the same effect as @command{x264}'s
1922 @option{--no-fast-pskip} option.
1923
1924 @item aud (@emph{aud})
1925 Enable use of access unit delimiters when set to 1.
1926
1927 @item mbtree
1928 Enable use macroblock tree ratecontrol when set to 1. When set
1929 to 0, it has the same effect as @command{x264}'s
1930 @option{--no-mbtree} option.
1931
1932 @item deblock (@emph{deblock})
1933 Set loop filter parameters, in @var{alpha}:@var{beta} form.
1934
1935 @item cplxblur (@emph{cplxblur})
1936 Set fluctuations reduction in QP (before curve compression).
1937
1938 @item partitions (@emph{partitions})
1939 Set partitions to consider as a comma-separated list of. Possible
1940 values in the list:
1941
1942 @table @samp
1943 @item p8x8
1944 8x8 P-frame partition.
1945 @item p4x4
1946 4x4 P-frame partition.
1947 @item b8x8
1948 4x4 B-frame partition.
1949 @item i8x8
1950 8x8 I-frame partition.
1951 @item i4x4
1952 4x4 I-frame partition.
1953 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
1954 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
1955 option) to be enabled.)
1956 @item none (@emph{none})
1957 Do not consider any partitions.
1958 @item all (@emph{all})
1959 Consider every partition.
1960 @end table
1961
1962 @item direct-pred (@emph{direct})
1963 Set direct MV prediction mode. Possible values:
1964
1965 @table @samp
1966 @item none (@emph{none})
1967 Disable MV prediction.
1968 @item spatial (@emph{spatial})
1969 Enable spatial predicting.
1970 @item temporal (@emph{temporal})
1971 Enable temporal predicting.
1972 @item auto (@emph{auto})
1973 Automatically decided.
1974 @end table
1975
1976 @item slice-max-size (@emph{slice-max-size})
1977 Set the limit of the size of each slice in bytes. If not specified
1978 but RTP payload size (@option{ps}) is specified, that is used.
1979
1980 @item stats (@emph{stats})
1981 Set the file name for multi-pass stats.
1982
1983 @item nal-hrd (@emph{nal-hrd})
1984 Set signal HRD information (requires @option{vbv-bufsize} to be set).
1985 Possible values:
1986
1987 @table @samp
1988 @item none (@emph{none})
1989 Disable HRD information signaling.
1990 @item vbr (@emph{vbr})
1991 Variable bit rate.
1992 @item cbr (@emph{cbr})
1993 Constant bit rate (not allowed in MP4 container).
1994 @end table
1995
1996 @item x264opts (N.A.)
1997 Set any x264 option, see @command{x264 --fullhelp} for a list.
1998
1999 Argument is a list of @var{key}=@var{value} couples separated by
2000 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
2001 themselves, use "," instead. They accept it as well since long ago but this
2002 is kept undocumented for some reason.
2003
2004 For example to specify libx264 encoding options with @command{ffmpeg}:
2005 @example
2006 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
2007 @end example
2008
2009 @item a53cc @var{boolean}
2010 Import closed captions (which must be ATSC compatible format) into output.
2011 Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
2012
2013 @item x264-params (N.A.)
2014 Override the x264 configuration using a :-separated list of key=value
2015 parameters.
2016
2017 This option is functionally the same as the @option{x264opts}, but is
2018 duplicated for compatibility with the Libav fork.
2019
2020 For example to specify libx264 encoding options with @command{ffmpeg}:
2021 @example
2022 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
2023 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
2024 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
2025 @end example
2026 @end table
2027
2028 Encoding ffpresets for common usages are provided so they can be used with the
2029 general presets system (e.g. passing the @option{pre} option).
2030
2031 @section libx265
2032
2033 x265 H.265/HEVC encoder wrapper.
2034
2035 This encoder requires the presence of the libx265 headers and library
2036 during configuration. You need to explicitly configure the build with
2037 @option{--enable-libx265}.
2038
2039 @subsection Options
2040
2041 @table @option
2042 @item preset
2043 Set the x265 preset.
2044
2045 @item tune
2046 Set the x265 tune parameter.
2047
2048 @item forced-idr
2049 Normally, when forcing a I-frame type, the encoder can select any type
2050 of I-frame. This option forces it to choose an IDR-frame.
2051
2052 @item x265-params
2053 Set x265 options using a list of @var{key}=@var{value} couples separated
2054 by ":". See @command{x265 --help} for a list of options.
2055
2056 For example to specify libx265 encoding options with @option{-x265-params}:
2057
2058 @example
2059 ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
2060 @end example
2061 @end table
2062
2063 @section libxvid
2064
2065 Xvid MPEG-4 Part 2 encoder wrapper.
2066
2067 This encoder requires the presence of the libxvidcore headers and library
2068 during configuration. You need to explicitly configure the build with
2069 @code{--enable-libxvid --enable-gpl}.
2070
2071 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
2072 users can encode to this format without this library.
2073
2074 @subsection Options
2075
2076 The following options are supported by the libxvid wrapper. Some of
2077 the following options are listed but are not documented, and
2078 correspond to shared codec options. See @ref{codec-options,,the Codec
2079 Options chapter} for their documentation. The other shared options
2080 which are not listed have no effect for the libxvid encoder.
2081
2082 @table @option
2083 @item b
2084
2085 @item g
2086
2087 @item qmin
2088
2089 @item qmax
2090
2091 @item mpeg_quant
2092
2093 @item threads
2094
2095 @item bf
2096
2097 @item b_qfactor
2098
2099 @item b_qoffset
2100
2101 @item flags
2102 Set specific encoding flags. Possible values:
2103
2104 @table @samp
2105
2106 @item mv4
2107 Use four motion vector by macroblock.
2108
2109 @item aic
2110 Enable high quality AC prediction.
2111
2112 @item gray
2113 Only encode grayscale.
2114
2115 @item gmc
2116 Enable the use of global motion compensation (GMC).
2117
2118 @item qpel
2119 Enable quarter-pixel motion compensation.
2120
2121 @item cgop
2122 Enable closed GOP.
2123
2124 @item global_header
2125 Place global headers in extradata instead of every keyframe.
2126
2127 @end table
2128
2129 @item trellis
2130
2131 @item me_method
2132 Set motion estimation method. Possible values in decreasing order of
2133 speed and increasing order of quality:
2134
2135 @table @samp
2136 @item zero
2137 Use no motion estimation (default).
2138
2139 @item phods
2140 @item x1
2141 @item log
2142 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
2143 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
2144 @samp{phods}.
2145
2146 @item epzs
2147 Enable all of the things described above, plus advanced diamond zonal
2148 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
2149 estimation on chroma planes.
2150
2151 @item full
2152 Enable all of the things described above, plus extended 16x16 and 8x8
2153 blocks search.
2154 @end table
2155
2156 @item mbd
2157 Set macroblock decision algorithm. Possible values in the increasing
2158 order of quality:
2159
2160 @table @samp
2161 @item simple
2162 Use macroblock comparing function algorithm (default).
2163
2164 @item bits
2165 Enable rate distortion-based half pixel and quarter pixel refinement for
2166 16x16 blocks.
2167
2168 @item rd
2169 Enable all of the things described above, plus rate distortion-based
2170 half pixel and quarter pixel refinement for 8x8 blocks, and rate
2171 distortion-based search using square pattern.
2172 @end table
2173
2174 @item lumi_aq
2175 Enable lumi masking adaptive quantization when set to 1. Default is 0
2176 (disabled).
2177
2178 @item variance_aq
2179 Enable variance adaptive quantization when set to 1. Default is 0
2180 (disabled).
2181
2182 When combined with @option{lumi_aq}, the resulting quality will not
2183 be better than any of the two specified individually. In other
2184 words, the resulting quality will be the worse one of the two
2185 effects.
2186
2187 @item ssim
2188 Set structural similarity (SSIM) displaying method. Possible values:
2189
2190 @table @samp
2191 @item off
2192 Disable displaying of SSIM information.
2193
2194 @item avg
2195 Output average SSIM at the end of encoding to stdout. The format of
2196 showing the average SSIM is:
2197
2198 @example
2199 Average SSIM: %f
2200 @end example
2201
2202 For users who are not familiar with C, %f means a float number, or
2203 a decimal (e.g. 0.939232).
2204
2205 @item frame
2206 Output both per-frame SSIM data during encoding and average SSIM at
2207 the end of encoding to stdout. The format of per-frame information
2208 is:
2209
2210 @example
2211        SSIM: avg: %1.3f min: %1.3f max: %1.3f
2212 @end example
2213
2214 For users who are not familiar with C, %1.3f means a float number
2215 rounded to 3 digits after the dot (e.g. 0.932).
2216
2217 @end table
2218
2219 @item ssim_acc
2220 Set SSIM accuracy. Valid options are integers within the range of
2221 0-4, while 0 gives the most accurate result and 4 computes the
2222 fastest.
2223
2224 @end table
2225
2226 @section mpeg2
2227
2228 MPEG-2 video encoder.
2229
2230 @subsection Options
2231
2232 @table @option
2233 @item seq_disp_ext @var{integer}
2234 Specifies if the encoder should write a sequence_display_extension to the
2235 output.
2236 @table @option
2237 @item -1
2238 @itemx auto
2239 Decide automatically to write it or not (this is the default) by checking if
2240 the data to be written is different from the default or unspecified values.
2241 @item 0
2242 @itemx never
2243 Never write it.
2244 @item 1
2245 @itemx always
2246 Always write it.
2247 @end table
2248 @end table
2249
2250 @section png
2251
2252 PNG image encoder.
2253
2254 @subsection Private options
2255
2256 @table @option
2257 @item dpi @var{integer}
2258 Set physical density of pixels, in dots per inch, unset by default
2259 @item dpm @var{integer}
2260 Set physical density of pixels, in dots per meter, unset by default
2261 @end table
2262
2263 @section ProRes
2264
2265 Apple ProRes encoder.
2266
2267 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
2268 The used encoder can be chosen with the @code{-vcodec} option.
2269
2270 @subsection Private Options for prores-ks
2271
2272 @table @option
2273 @item profile @var{integer}
2274 Select the ProRes profile to encode
2275 @table @samp
2276 @item proxy
2277 @item lt
2278 @item standard
2279 @item hq
2280 @item 4444
2281 @end table
2282
2283 @item quant_mat @var{integer}
2284 Select quantization matrix.
2285 @table @samp
2286 @item auto
2287 @item default
2288 @item proxy
2289 @item lt
2290 @item standard
2291 @item hq
2292 @end table
2293 If set to @var{auto}, the matrix matching the profile will be picked.
2294 If not set, the matrix providing the highest quality, @var{default}, will be
2295 picked.
2296
2297 @item bits_per_mb @var{integer}
2298 How many bits to allot for coding one macroblock. Different profiles use
2299 between 200 and 2400 bits per macroblock, the maximum is 8000.
2300
2301 @item mbs_per_slice @var{integer}
2302 Number of macroblocks in each slice (1-8); the default value (8)
2303 should be good in almost all situations.
2304
2305 @item vendor @var{string}
2306 Override the 4-byte vendor ID.
2307 A custom vendor ID like @var{apl0} would claim the stream was produced by
2308 the Apple encoder.
2309
2310 @item alpha_bits @var{integer}
2311 Specify number of bits for alpha component.
2312 Possible values are @var{0}, @var{8} and @var{16}.
2313 Use @var{0} to disable alpha plane coding.
2314
2315 @end table
2316
2317 @subsection Speed considerations
2318
2319 In the default mode of operation the encoder has to honor frame constraints
2320 (i.e. not produce frames with size bigger than requested) while still making
2321 output picture as good as possible.
2322 A frame containing a lot of small details is harder to compress and the encoder
2323 would spend more time searching for appropriate quantizers for each slice.
2324
2325 Setting a higher @option{bits_per_mb} limit will improve the speed.
2326
2327 For the fastest encoding speed set the @option{qscale} parameter (4 is the
2328 recommended value) and do not set a size constraint.
2329
2330 @section libkvazaar
2331
2332 Kvazaar H.265/HEVC encoder.
2333
2334 Requires the presence of the libkvazaar headers and library during
2335 configuration. You need to explicitly configure the build with
2336 @option{--enable-libkvazaar}.
2337
2338 @subsection Options
2339
2340 @table @option
2341
2342 @item b
2343 Set target video bitrate in bit/s and enable rate control.
2344
2345 @item kvazaar-params
2346 Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
2347 by commas (,). See kvazaar documentation for a list of options.
2348
2349 @end table
2350
2351 @section QSV encoders
2352
2353 The family of Intel QuickSync Video encoders (MPEG-2, H.264 and HEVC)
2354
2355 The ratecontrol method is selected as follows:
2356
2357 @itemize @bullet
2358 @item
2359 When @option{global_quality} is specified, a quality-based mode is used.
2360 Specifically this means either
2361 @itemize @minus
2362 @item
2363 @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
2364 also set (the @option{-qscale} ffmpeg option).
2365
2366 @item
2367 @var{LA_ICQ} - intelligent constant quality with lookahead, when the
2368 @option{look_ahead} option is also set.
2369
2370 @item
2371 @var{ICQ} -- intelligent constant quality otherwise.
2372 @end itemize
2373
2374 @item
2375 Otherwise, a bitrate-based mode is used. For all of those, you should specify at
2376 least the desired average bitrate with the @option{b} option.
2377 @itemize @minus
2378 @item
2379 @var{LA} - VBR with lookahead, when the @option{look_ahead} option is specified.
2380
2381 @item
2382 @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
2383
2384 @item
2385 @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
2386 the average bitrate.
2387
2388 @item
2389 @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
2390 than the average bitrate.
2391
2392 @item
2393 @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
2394 is further configured by the @option{avbr_accuracy} and
2395 @option{avbr_convergence} options.
2396 @end itemize
2397 @end itemize
2398
2399 Note that depending on your system, a different mode than the one you specified
2400 may be selected by the encoder. Set the verbosity level to @var{verbose} or
2401 higher to see the actual settings used by the QSV runtime.
2402
2403 Additional libavcodec global options are mapped to MSDK options as follows:
2404
2405 @itemize
2406 @item
2407 @option{g/gop_size} -> @option{GopPicSize}
2408
2409 @item
2410 @option{bf/max_b_frames}+1 -> @option{GopRefDist}
2411
2412 @item
2413 @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
2414 @option{InitialDelayInKB}
2415
2416 @item
2417 @option{slices} -> @option{NumSlice}
2418
2419 @item
2420 @option{refs} -> @option{NumRefFrame}
2421
2422 @item
2423 @option{b_strategy/b_frame_strategy} -> @option{BRefType}
2424
2425 @item
2426 @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
2427
2428 @item
2429 For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
2430 @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
2431 and @var{QPP} and @var{QPB} respectively.
2432
2433 @item
2434 Setting the @option{coder} option to the value @var{vlc} will make the H.264
2435 encoder use CAVLC instead of CABAC.
2436
2437 @end itemize
2438
2439 @section vc2
2440
2441 SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
2442 professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
2443 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
2444 other tasks which require low overhead and low compression (like screen
2445 recording).
2446
2447 @subsection Options
2448
2449 @table @option
2450
2451 @item b
2452 Sets target video bitrate. Usually that's around 1:6 of the uncompressed
2453 video bitrate (e.g. for 1920x1080 50fps yuv422p10 that's around 400Mbps). Higher
2454 values (close to the uncompressed bitrate) turn on lossless compression mode.
2455
2456 @item field_order
2457 Enables field coding when set (e.g. to tt - top field first) for interlaced
2458 inputs. Should increase compression with interlaced content as it splits the
2459 fields and encodes each separately.
2460
2461 @item wavelet_depth
2462 Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
2463 Lower values reduce compression and quality. Less capable decoders may not be
2464 able to handle values of @option{wavelet_depth} over 3.
2465
2466 @item wavelet_type
2467 Sets the transform type. Currently only @var{5_3} (LeGall) and @var{9_7}
2468 (Deslauriers-Dubuc)
2469 are implemented, with 9_7 being the one with better compression and thus
2470 is the default.
2471
2472 @item slice_width
2473 @item slice_height
2474 Sets the slice size for each slice. Larger values result in better compression.
2475 For compatibility with other more limited decoders use @option{slice_width} of
2476 32 and @option{slice_height} of 8.
2477
2478 @item tolerance
2479 Sets the undershoot tolerance of the rate control system in percent. This is
2480 to prevent an expensive search from being run.
2481
2482 @item qm
2483 Sets the quantization matrix preset to use by default or when @option{wavelet_depth}
2484 is set to 5
2485 @itemize @minus
2486 @item
2487 @var{default}
2488 Uses the default quantization matrix from the specifications, extended with
2489 values for the fifth level. This provides a good balance between keeping detail
2490 and omitting artifacts.
2491
2492 @item
2493 @var{flat}
2494 Use a completely zeroed out quantization matrix. This increases PSNR but might
2495 reduce perception. Use in bogus benchmarks.
2496
2497 @item
2498 @var{color}
2499 Reduces detail but attempts to preserve color at extremely low bitrates.
2500 @end itemize
2501
2502 @end table
2503
2504 @section Hap
2505
2506 Vidvox Hap video encoder.
2507
2508 @subsection Options
2509
2510 @table @option
2511 @item format @var{integer}
2512 Specifies the Hap format to encode.
2513
2514 @table @option
2515 @item hap
2516 @item hap_alpha
2517 @item hap_q
2518 @end table
2519
2520 Default value is @option{hap}.
2521
2522 @item chunks @var{integer}
2523 Specifies the number of chunks to split frames into, between 1 and 64. This
2524 permits multithreaded decoding of large frames, potentially at the cost of
2525 data-rate. The encoder may modify this value to divide frames evenly.
2526
2527 Default value is @var{1}.
2528
2529 @item compressor @var{integer}
2530 Specifies the second-stage compressor to use. If set to @option{none},
2531 @option{chunks} will be limited to 1, as chunked uncompressed frames offer no
2532 benefit.
2533
2534 @table @option
2535 @item none
2536 @item snappy
2537 @end table
2538
2539 Default value is @option{snappy}.
2540
2541 @end table
2542
2543 @c man end VIDEO ENCODERS
2544
2545 @chapter Subtitles Encoders
2546 @c man begin SUBTITLES ENCODERS
2547
2548 @section dvdsub
2549
2550 This codec encodes the bitmap subtitle format that is used in DVDs.
2551 Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
2552 and they can also be used in Matroska files.
2553
2554 @subsection Options
2555
2556 @table @option
2557 @item even_rows_fix
2558 When set to 1, enable a work-around that makes the number of pixel rows
2559 even in all subtitles.  This fixes a problem with some players that
2560 cut off the bottom row if the number is odd.  The work-around just adds
2561 a fully transparent row if needed.  The overhead is low, typically
2562 one byte per subtitle on average.
2563
2564 By default, this work-around is disabled.
2565 @end table
2566
2567 @c man end SUBTITLES ENCODERS