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