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