doc/encoders: add libx264rgb doc and supported pixfmts for libx264(rgb)
[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{-codecs} 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 an experimental FFmpeg-native AAC encoder. Currently only the
34 low complexity (AAC-LC) profile is supported. To use this encoder, you must set
35 @option{strict} option to @samp{experimental} or lower.
36
37 As this encoder is experimental, unexpected behavior may exist from time to
38 time. For a more stable AAC encoder, see @ref{libvo-aacenc}. However, be warned
39 that it has a worse quality reported by some users.
40
41 @c todo @ref{libaacplus}
42 See also @ref{libfdk-aac-enc,,libfdk_aac} and @ref{libfaac}.
43
44 @subsection Options
45
46 @table @option
47 @item b
48 Set bit rate in bits/s. Setting this automatically activates constant bit rate
49 (CBR) mode.
50
51 @item q
52 Set quality for variable bit rate (VBR) mode. This option is valid only using
53 the @command{ffmpeg} command-line tool. For library interface users, use
54 @option{global_quality}.
55
56 @item stereo_mode
57 Set stereo encoding mode. Possible values:
58
59 @table @samp
60 @item auto
61 Automatically selected by the encoder.
62
63 @item ms_off
64 Disable middle/side encoding. This is the default.
65
66 @item ms_force
67 Force middle/side encoding.
68 @end table
69
70 @item aac_coder
71 Set AAC encoder coding method. Possible values:
72
73 @table @samp
74 @item faac
75 FAAC-inspired method.
76
77 This method is a simplified reimplementation of the method used in FAAC, which
78 sets thresholds proportional to the band energies, and then decreases all the
79 thresholds with quantizer steps to find the appropriate quantization with
80 distortion below threshold band by band.
81
82 The quality of this method is comparable to the two loop searching method
83 descibed below, but somewhat a little better and slower.
84
85 @item anmr
86 Average noise to mask ratio (ANMR) trellis-based solution.
87
88 This has a theoretic best quality out of all the coding methods, but at the
89 cost of the slowest speed.
90
91 @item twoloop
92 Two loop searching (TLS) method.
93
94 This method first sets quantizers depending on band thresholds and then tries
95 to find an optimal combination by adding or subtracting a specific value from
96 all quantizers and adjusting some individual quantizer a little.
97
98 This method produces similar quality with the FAAC method and is the default.
99
100 @item fast
101 Constant quantizer method.
102
103 This method sets a constant quantizer for all bands. This is the fastest of all
104 the methods, yet produces the worst quality.
105
106 @end table
107
108 @end table
109
110 @section ac3 and ac3_fixed
111
112 AC-3 audio encoders.
113
114 These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
115 the undocumented RealAudio 3 (a.k.a. dnet).
116
117 The @var{ac3} encoder uses floating-point math, while the @var{ac3_fixed}
118 encoder only uses fixed-point integer math. This does not mean that one is
119 always faster, just that one or the other may be better suited to a
120 particular system. The floating-point encoder will generally produce better
121 quality audio for a given bitrate. The @var{ac3_fixed} encoder is not the
122 default codec for any of the output formats, so it must be specified explicitly
123 using the option @code{-acodec ac3_fixed} in order to use it.
124
125 @subsection AC-3 Metadata
126
127 The AC-3 metadata options are used to set parameters that describe the audio,
128 but in most cases do not affect the audio encoding itself. Some of the options
129 do directly affect or influence the decoding and playback of the resulting
130 bitstream, while others are just for informational purposes. A few of the
131 options will add bits to the output stream that could otherwise be used for
132 audio data, and will thus affect the quality of the output. Those will be
133 indicated accordingly with a note in the option list below.
134
135 These parameters are described in detail in several publicly-available
136 documents.
137 @itemize
138 @item @uref{http://www.atsc.org/cms/standards/a_52-2010.pdf,A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard}
139 @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}
140 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf,Dolby Metadata Guide}
141 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf,Dolby Digital Professional Encoding Guidelines}
142 @end itemize
143
144 @subsubsection Metadata Control Options
145
146 @table @option
147
148 @item -per_frame_metadata @var{boolean}
149 Allow Per-Frame Metadata. Specifies if the encoder should check for changing
150 metadata for each frame.
151 @table @option
152 @item 0
153 The metadata values set at initialization will be used for every frame in the
154 stream. (default)
155 @item 1
156 Metadata values can be changed before encoding each frame.
157 @end table
158
159 @end table
160
161 @subsubsection Downmix Levels
162
163 @table @option
164
165 @item -center_mixlev @var{level}
166 Center Mix Level. The amount of gain the decoder should apply to the center
167 channel when downmixing to stereo. This field will only be written to the
168 bitstream if a center channel is present. The value is specified as a scale
169 factor. There are 3 valid values:
170 @table @option
171 @item 0.707
172 Apply -3dB gain
173 @item 0.595
174 Apply -4.5dB gain (default)
175 @item 0.500
176 Apply -6dB gain
177 @end table
178
179 @item -surround_mixlev @var{level}
180 Surround Mix Level. The amount of gain the decoder should apply to the surround
181 channel(s) when downmixing to stereo. This field will only be written to the
182 bitstream if one or more surround channels are present. The value is specified
183 as a scale factor.  There are 3 valid values:
184 @table @option
185 @item 0.707
186 Apply -3dB gain
187 @item 0.500
188 Apply -6dB gain (default)
189 @item 0.000
190 Silence Surround Channel(s)
191 @end table
192
193 @end table
194
195 @subsubsection Audio Production Information
196 Audio Production Information is optional information describing the mixing
197 environment.  Either none or both of the fields are written to the bitstream.
198
199 @table @option
200
201 @item -mixing_level @var{number}
202 Mixing Level. Specifies peak sound pressure level (SPL) in the production
203 environment when the mix was mastered. Valid values are 80 to 111, or -1 for
204 unknown or not indicated. The default value is -1, but that value cannot be
205 used if the Audio Production Information is written to the bitstream. Therefore,
206 if the @code{room_type} option is not the default value, the @code{mixing_level}
207 option must not be -1.
208
209 @item -room_type @var{type}
210 Room Type. Describes the equalization used during the final mixing session at
211 the studio or on the dubbing stage. A large room is a dubbing stage with the
212 industry standard X-curve equalization; a small room has flat equalization.
213 This field will not be written to the bitstream if both the @code{mixing_level}
214 option and the @code{room_type} option have the default values.
215 @table @option
216 @item 0
217 @itemx notindicated
218 Not Indicated (default)
219 @item 1
220 @itemx large
221 Large Room
222 @item 2
223 @itemx small
224 Small Room
225 @end table
226
227 @end table
228
229 @subsubsection Other Metadata Options
230
231 @table @option
232
233 @item -copyright @var{boolean}
234 Copyright Indicator. Specifies whether a copyright exists for this audio.
235 @table @option
236 @item 0
237 @itemx off
238 No Copyright Exists (default)
239 @item 1
240 @itemx on
241 Copyright Exists
242 @end table
243
244 @item -dialnorm @var{value}
245 Dialogue Normalization. Indicates how far the average dialogue level of the
246 program is below digital 100% full scale (0 dBFS). This parameter determines a
247 level shift during audio reproduction that sets the average volume of the
248 dialogue to a preset level. The goal is to match volume level between program
249 sources. A value of -31dB will result in no volume level change, relative to
250 the source volume, during audio reproduction. Valid values are whole numbers in
251 the range -31 to -1, with -31 being the default.
252
253 @item -dsur_mode @var{mode}
254 Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
255 (Pro Logic). This field will only be written to the bitstream if the audio
256 stream is stereo. Using this option does @b{NOT} mean the encoder will actually
257 apply Dolby Surround processing.
258 @table @option
259 @item 0
260 @itemx notindicated
261 Not Indicated (default)
262 @item 1
263 @itemx off
264 Not Dolby Surround Encoded
265 @item 2
266 @itemx on
267 Dolby Surround Encoded
268 @end table
269
270 @item -original @var{boolean}
271 Original Bit Stream Indicator. Specifies whether this audio is from the
272 original source and not a copy.
273 @table @option
274 @item 0
275 @itemx off
276 Not Original Source
277 @item 1
278 @itemx on
279 Original Source (default)
280 @end table
281
282 @end table
283
284 @subsection Extended Bitstream Information
285 The extended bitstream options are part of the Alternate Bit Stream Syntax as
286 specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
287 If any one parameter in a group is specified, all values in that group will be
288 written to the bitstream.  Default values are used for those that are written
289 but have not been specified.  If the mixing levels are written, the decoder
290 will use these values instead of the ones specified in the @code{center_mixlev}
291 and @code{surround_mixlev} options if it supports the Alternate Bit Stream
292 Syntax.
293
294 @subsubsection Extended Bitstream Information - Part 1
295
296 @table @option
297
298 @item -dmix_mode @var{mode}
299 Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
300 (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
301 @table @option
302 @item 0
303 @itemx notindicated
304 Not Indicated (default)
305 @item 1
306 @itemx ltrt
307 Lt/Rt Downmix Preferred
308 @item 2
309 @itemx loro
310 Lo/Ro Downmix Preferred
311 @end table
312
313 @item -ltrt_cmixlev @var{level}
314 Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
315 center channel when downmixing to stereo in Lt/Rt mode.
316 @table @option
317 @item 1.414
318 Apply +3dB gain
319 @item 1.189
320 Apply +1.5dB gain
321 @item 1.000
322 Apply 0dB gain
323 @item 0.841
324 Apply -1.5dB gain
325 @item 0.707
326 Apply -3.0dB gain
327 @item 0.595
328 Apply -4.5dB gain (default)
329 @item 0.500
330 Apply -6.0dB gain
331 @item 0.000
332 Silence Center Channel
333 @end table
334
335 @item -ltrt_surmixlev @var{level}
336 Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
337 surround channel(s) when downmixing to stereo in Lt/Rt mode.
338 @table @option
339 @item 0.841
340 Apply -1.5dB gain
341 @item 0.707
342 Apply -3.0dB gain
343 @item 0.595
344 Apply -4.5dB gain
345 @item 0.500
346 Apply -6.0dB gain (default)
347 @item 0.000
348 Silence Surround Channel(s)
349 @end table
350
351 @item -loro_cmixlev @var{level}
352 Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
353 center channel when downmixing to stereo in Lo/Ro 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 -loro_surmixlev @var{level}
374 Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
375 surround channel(s) when downmixing to stereo in Lo/Ro 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 @end table
390
391 @subsubsection Extended Bitstream Information - Part 2
392
393 @table @option
394
395 @item -dsurex_mode @var{mode}
396 Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
397 (7.1 matrixed to 5.1). Using this option does @b{NOT} mean the encoder will actually
398 apply Dolby Surround EX processing.
399 @table @option
400 @item 0
401 @itemx notindicated
402 Not Indicated (default)
403 @item 1
404 @itemx on
405 Dolby Surround EX Off
406 @item 2
407 @itemx off
408 Dolby Surround EX On
409 @end table
410
411 @item -dheadphone_mode @var{mode}
412 Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
413 encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
414 option does @b{NOT} mean the encoder will actually apply Dolby Headphone
415 processing.
416 @table @option
417 @item 0
418 @itemx notindicated
419 Not Indicated (default)
420 @item 1
421 @itemx on
422 Dolby Headphone Off
423 @item 2
424 @itemx off
425 Dolby Headphone On
426 @end table
427
428 @item -ad_conv_type @var{type}
429 A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
430 conversion.
431 @table @option
432 @item 0
433 @itemx standard
434 Standard A/D Converter (default)
435 @item 1
436 @itemx hdcd
437 HDCD A/D Converter
438 @end table
439
440 @end table
441
442 @subsection Other AC-3 Encoding Options
443
444 @table @option
445
446 @item -stereo_rematrixing @var{boolean}
447 Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
448 is an optional AC-3 feature that increases quality by selectively encoding
449 the left/right channels as mid/side. This option is enabled by default, and it
450 is highly recommended that it be left as enabled except for testing purposes.
451
452 @end table
453
454 @subsection Floating-Point-Only AC-3 Encoding Options
455
456 These options are only valid for the floating-point encoder and do not exist
457 for the fixed-point encoder due to the corresponding features not being
458 implemented in fixed-point.
459
460 @table @option
461
462 @item -channel_coupling @var{boolean}
463 Enables/Disables use of channel coupling, which is an optional AC-3 feature
464 that increases quality by combining high frequency information from multiple
465 channels into a single channel. The per-channel high frequency information is
466 sent with less accuracy in both the frequency and time domains. This allows
467 more bits to be used for lower frequencies while preserving enough information
468 to reconstruct the high frequencies. This option is enabled by default for the
469 floating-point encoder and should generally be left as enabled except for
470 testing purposes or to increase encoding speed.
471 @table @option
472 @item -1
473 @itemx auto
474 Selected by Encoder (default)
475 @item 0
476 @itemx off
477 Disable Channel Coupling
478 @item 1
479 @itemx on
480 Enable Channel Coupling
481 @end table
482
483 @item -cpl_start_band @var{number}
484 Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
485 value higher than the bandwidth is used, it will be reduced to 1 less than the
486 coupling end band. If @var{auto} is used, the start band will be determined by
487 the encoder based on the bit rate, sample rate, and channel layout. This option
488 has no effect if channel coupling is disabled.
489 @table @option
490 @item -1
491 @itemx auto
492 Selected by Encoder (default)
493 @end table
494
495 @end table
496
497 @anchor{libfaac}
498 @section libfaac
499
500 libfaac AAC (Advanced Audio Coding) encoder wrapper.
501
502 Requires the presence of the libfaac headers and library during
503 configuration. You need to explicitly configure the build with
504 @code{--enable-libfaac --enable-nonfree}.
505
506 This encoder is considered to be of higher quality with respect to the
507 @ref{aacenc,,the native experimental FFmpeg AAC encoder}.
508
509 For more information see the libfaac project at
510 @url{http://www.audiocoding.com/faac.html/}.
511
512 @subsection Options
513
514 The following shared FFmpeg codec options are recognized.
515
516 The following options are supported by the libfaac wrapper. The
517 @command{faac}-equivalent of the options are listed in parentheses.
518
519 @table @option
520 @item b (@emph{-b})
521 Set bit rate in bits/s for ABR (Average Bit Rate) mode. If the bit rate
522 is not explicitly specified, it is automatically set to a suitable
523 value depending on the selected profile. @command{faac} bitrate is
524 expressed in kilobits/s.
525
526 Note that libfaac does not support CBR (Constant Bit Rate) but only
527 ABR (Average Bit Rate).
528
529 If VBR mode is enabled this option is ignored.
530
531 @item ar (@emph{-R})
532 Set audio sampling rate (in Hz).
533
534 @item ac (@emph{-c})
535 Set the number of audio channels.
536
537 @item cutoff (@emph{-C})
538 Set cutoff frequency. If not specified (or explicitly set to 0) it
539 will use a value automatically computed by the library. Default value
540 is 0.
541
542 @item profile
543 Set audio profile.
544
545 The following profiles are recognized:
546 @table @samp
547 @item aac_main
548 Main AAC (Main)
549
550 @item aac_low
551 Low Complexity AAC (LC)
552
553 @item aac_ssr
554 Scalable Sample Rate (SSR)
555
556 @item aac_ltp
557 Long Term Prediction (LTP)
558 @end table
559
560 If not specified it is set to @samp{aac_low}.
561
562 @item flags +qscale
563 Set constant quality VBR (Variable Bit Rate) mode.
564
565 @item global_quality
566 Set quality in VBR mode as an integer number of lambda units.
567
568 Only relevant when VBR mode is enabled with @code{flags +qscale}.  The
569 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
570 and used to set the quality value used by libfaac. A reasonable range
571 for the option value in QP units is [10-500], the higher the value the
572 higher the quality.
573
574 @item q (@emph{-q})
575 Enable VBR mode when set to a non-negative value, and set constant
576 quality value as a double floating point value in QP units.
577
578 The value sets the quality value used by libfaac. A reasonable range
579 for the option value is [10-500], the higher the value the higher the
580 quality.
581
582 This option is valid only using the @command{ffmpeg} command-line
583 tool. For library interface users, use @option{global_quality}.
584 @end table
585
586 @subsection Examples
587
588 @itemize
589 @item
590 Use @command{ffmpeg} to convert an audio file to ABR 128 kbps AAC in an M4A (MP4)
591 container:
592 @example
593 ffmpeg -i input.wav -codec:a libfaac -b:a 128k -output.m4a
594 @end example
595
596 @item
597 Use @command{ffmpeg} to convert an audio file to VBR AAC, using the
598 LTP AAC profile:
599 @example
600 ffmpeg -i input.wav -c:a libfaac -profile:a aac_ltp -q:a 100 output.m4a
601 @end example
602 @end itemize
603
604 @anchor{libfdk-aac-enc}
605 @section libfdk_aac
606
607 libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
608
609 The libfdk-aac library is based on the Fraunhofer FDK AAC code from
610 the Android project.
611
612 Requires the presence of the libfdk-aac headers and library during
613 configuration. You need to explicitly configure the build with
614 @code{--enable-libfdk-aac}. The library is also incompatible with GPL,
615 so if you allow the use of GPL, you should configure with
616 @code{--enable-gpl --enable-nonfree --enable-libfdk-aac}.
617
618 This encoder is considered to be of higher quality with respect to
619 both @ref{aacenc,,the native experimental FFmpeg AAC encoder} and
620 @ref{libfaac}.
621
622 VBR encoding, enabled through the @option{vbr} or @option{flags
623 +qscale} options, is experimental and only works with some
624 combinations of parameters.
625
626 For more information see the fdk-aac project at
627 @url{http://sourceforge.net/p/opencore-amr/fdk-aac/}.
628
629 @subsection Options
630
631 The following options are mapped on the shared FFmpeg codec options.
632
633 @table @option
634 @item b
635 Set bit rate in bits/s. If the bitrate is not explicitly specified, it
636 is automatically set to a suitable value depending on the selected
637 profile.
638
639 In case VBR mode is enabled the option is ignored.
640
641 @item ar
642 Set audio sampling rate (in Hz).
643
644 @item channels
645 Set the number of audio channels.
646
647 @item flags +qscale
648 Enable fixed quality, VBR (Variable Bit Rate) mode.
649 Note that VBR is implicitly enabled when the @option{vbr} value is
650 positive.
651
652 @item cutoff
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_low
663 Low Complexity AAC (LC)
664
665 @item aac_he
666 High Efficiency AAC (HE-AAC)
667
668 @item aac_he_v2
669 High Efficiency AAC version 2 (HE-AACv2)
670
671 @item aac_ld
672 Low Delay AAC (LD)
673
674 @item aac_eld
675 Enhanced Low Delay AAC (ELD)
676 @end table
677
678 If not specified it is set to @samp{aac_low}.
679 @end table
680
681 The following are private options of the libfdk_aac encoder.
682
683 @table @option
684 @item afterburner
685 Enable afterburner feature if set to 1, disabled if set to 0. This
686 improves the quality but also the required processing power.
687
688 Default value is 1.
689
690 @item eld_sbr
691 Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
692 if set to 0.
693
694 Default value is 0.
695
696 @item signaling
697 Set SBR/PS signaling style.
698
699 It can assume one of the following values:
700 @table @samp
701 @item default
702 choose signaling implicitly (explicit hierarchical by default,
703 implicit if global header is disabled)
704
705 @item implicit
706 implicit backwards compatible signaling
707
708 @item explicit_sbr
709 explicit SBR, implicit PS signaling
710
711 @item explicit_hierarchical
712 explicit hierarchical signaling
713 @end table
714
715 Default value is @samp{default}.
716
717 @item latm
718 Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
719
720 Default value is 0.
721
722 @item header_period
723 Set StreamMuxConfig and PCE repetition period (in frames) for sending
724 in-band configuration buffers within LATM/LOAS transport layer.
725
726 Must be a 16-bits non-negative integer.
727
728 Default value is 0.
729
730 @item vbr
731 Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
732 good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
733 (Constant Bit Rate) is enabled.
734
735 Currently only the @samp{aac_low} profile supports VBR encoding.
736
737 VBR modes 1-5 correspond to roughly the following average bit rates:
738
739 @table @samp
740 @item 1
741 32 kbps/channel
742 @item 2
743 40 kbps/channel
744 @item 3
745 48-56 kbps/channel
746 @item 4
747 64 kbps/channel
748 @item 5
749 about 80-96 kbps/channel
750 @end table
751
752 Default value is 0.
753 @end table
754
755 @subsection Examples
756
757 @itemize
758 @item
759 Use @command{ffmpeg} to convert an audio file to VBR AAC in an M4A (MP4)
760 container:
761 @example
762 ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
763 @end example
764
765 @item
766 Use @command{ffmpeg} to convert an audio file to CBR 64k kbps AAC, using the
767 High-Efficiency AAC profile:
768 @example
769 ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
770 @end example
771 @end itemize
772
773 @anchor{libmp3lame}
774 @section libmp3lame
775
776 LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper.
777
778 Requires the presence of the libmp3lame headers and library during
779 configuration. You need to explicitly configure the build with
780 @code{--enable-libmp3lame}.
781
782 See @ref{libshine} for a fixed-point MP3 encoder, although with a
783 lower quality.
784
785 @subsection Options
786
787 The following options are supported by the libmp3lame wrapper. The
788 @command{lame}-equivalent of the options are listed in parentheses.
789
790 @table @option
791 @item b (@emph{-b})
792 Set bitrate expressed in bits/s for CBR or ABR. LAME @code{bitrate} is
793 expressed in kilobits/s.
794
795 @item q (@emph{-V})
796 Set constant quality setting for VBR. This option is valid only
797 using the @command{ffmpeg} command-line tool. For library interface
798 users, use @option{global_quality}.
799
800 @item compression_level (@emph{-q})
801 Set algorithm quality. Valid arguments are integers in the 0-9 range,
802 with 0 meaning highest quality but slowest, and 9 meaning fastest
803 while producing the worst quality.
804
805 @item reservoir
806 Enable use of bit reservoir when set to 1. Default value is 1. LAME
807 has this enabled by default, but can be overriden by use
808 @option{--nores} option.
809
810 @item joint_stereo (@emph{-m j})
811 Enable the encoder to use (on a frame by frame basis) either L/R
812 stereo or mid/side stereo. Default value is 1.
813
814 @item abr (@emph{--abr})
815 Enable the encoder to use ABR when set to 1. The @command{lame}
816 @option{--abr} sets the target bitrate, while this options only
817 tells FFmpeg to use ABR still relies on @option{b} to set bitrate.
818
819 @end table
820
821 @section libopencore-amrnb
822
823 OpenCORE Adaptive Multi-Rate Narrowband encoder.
824
825 Requires the presence of the libopencore-amrnb headers and library during
826 configuration. You need to explicitly configure the build with
827 @code{--enable-libopencore-amrnb --enable-version3}.
828
829 This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
830 but you can override it by setting @option{strict} to @samp{unofficial} or
831 lower.
832
833 @subsection Options
834
835 @table @option
836
837 @item b
838 Set bitrate in bits per second. Only the following bitrates are supported,
839 otherwise libavcodec will round to the nearest valid bitrate.
840
841 @table @option
842 @item 4750
843 @item 5150
844 @item 5900
845 @item 6700
846 @item 7400
847 @item 7950
848 @item 10200
849 @item 12200
850 @end table
851
852 @item dtx
853 Allow discontinuous transmission (generate comfort noise) when set to 1. The
854 default value is 0 (disabled).
855
856 @end table
857
858 @anchor{libshine}
859 @section libshine
860
861 Shine Fixed-Point MP3 encoder wrapper.
862
863 Shine is a fixed-point MP3 encoder. It has a far better performance on
864 platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
865 However, as it is more targeted on performance than quality, it is not on par
866 with LAME and other production-grade encoders quality-wise. Also, according to
867 the project's homepage, this encoder may not be free of bugs as the code was
868 written a long time ago and the project was dead for at least 5 years.
869
870 This encoder only supports stereo and mono input. This is also CBR-only.
871
872 The original project (last updated in early 2007) is at
873 @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
874 updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
875
876 Requires the presence of the libshine headers and library during
877 configuration. You need to explicitly configure the build with
878 @code{--enable-libshine}.
879
880 See also @ref{libmp3lame}.
881
882 @subsection Options
883
884 The following options are supported by the libshine wrapper. The
885 @command{shineenc}-equivalent of the options are listed in parentheses.
886
887 @table @option
888 @item b (@emph{-b})
889 Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
890 is expressed in kilobits/s.
891
892 @end table
893
894 @section libtwolame
895
896 TwoLAME MP2 encoder wrapper.
897
898 Requires the presence of the libtwolame headers and library during
899 configuration. You need to explicitly configure the build with
900 @code{--enable-libtwolame}.
901
902 @subsection Options
903
904 The following options are supported by the libtwolame wrapper. The
905 @command{twolame}-equivalent options follow the FFmpeg ones and are in
906 parentheses.
907
908 @table @option
909 @item b (@emph{-b})
910 Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
911 option is expressed in kilobits/s. Default value is 128k.
912
913 @item q (@emph{-V})
914 Set quality for experimental VBR support. Maximum value range is
915 from -50 to 50, useful range is from -10 to 10. The higher the
916 value, the better the quality. This option is valid only using the
917 @command{ffmpeg} command-line tool. For library interface users,
918 use @option{global_quality}.
919
920 @item mode (@emph{--mode})
921 Set the mode of the resulting audio. Possible values:
922
923 @table @samp
924 @item auto
925 Choose mode automatically based on the input. This is the default.
926 @item stereo
927 Stereo
928 @item joint_stereo
929 Joint stereo
930 @item dual_channel
931 Dual channel
932 @item mono
933 Mono
934 @end table
935
936 @item psymodel (@emph{--psyc-mode})
937 Set psychoacoustic model to use in encoding. The argument must be
938 an integer between -1 and 4, inclusive. The higher the value, the
939 better the quality. The default value is 3.
940
941 @item energy_levels (@emph{--energy})
942 Enable energy levels extensions when set to 1. The default value is
943 0 (disabled).
944
945 @item error_protection (@emph{--protect})
946 Enable CRC error protection when set to 1. The default value is 0
947 (disabled).
948
949 @item copyright (@emph{--copyright})
950 Set MPEG audio copyright flag when set to 1. The default value is 0
951 (disabled).
952
953 @item original (@emph{--original})
954 Set MPEG audio original flag when set to 1. The default value is 0
955 (disabled).
956
957 @end table
958
959 @anchor{libvo-aacenc}
960 @section libvo-aacenc
961
962 VisualOn AAC encoder.
963
964 Requires the presence of the libvo-aacenc headers and library during
965 configuration. You need to explicitly configure the build with
966 @code{--enable-libvo-aacenc --enable-version3}.
967
968 This encoder is considered to be worse than the
969 @ref{aacenc,,native experimental FFmpeg AAC encoder}, according to
970 multiple sources.
971
972 @subsection Options
973
974 The VisualOn AAC encoder only support encoding AAC-LC and up to 2
975 channels. It is also CBR-only.
976
977 @table @option
978
979 @item b
980 Set bit rate in bits/s.
981
982 @end table
983
984 @section libvo-amrwbenc
985
986 VisualOn Adaptive Multi-Rate Wideband encoder.
987
988 Requires the presence of the libvo-amrwbenc headers and library during
989 configuration. You need to explicitly configure the build with
990 @code{--enable-libvo-amrwbenc --enable-version3}.
991
992 This is a mono-only encoder. Officially it only supports 16000Hz sample
993 rate, but you can override it by setting @option{strict} to
994 @samp{unofficial} or lower.
995
996 @subsection Options
997
998 @table @option
999
1000 @item b
1001 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
1002 libavcodec will round to the nearest valid bitrate.
1003
1004 @table @samp
1005 @item 6600
1006 @item 8850
1007 @item 12650
1008 @item 14250
1009 @item 15850
1010 @item 18250
1011 @item 19850
1012 @item 23050
1013 @item 23850
1014 @end table
1015
1016 @item dtx
1017 Allow discontinuous transmission (generate comfort noise) when set to 1. The
1018 default value is 0 (disabled).
1019
1020 @end table
1021
1022 @section libopus
1023
1024 libopus Opus Interactive Audio Codec encoder wrapper.
1025
1026 Requires the presence of the libopus headers and library during
1027 configuration. You need to explicitly configure the build with
1028 @code{--enable-libopus}.
1029
1030 @subsection Option Mapping
1031
1032 Most libopus options are modeled after the @command{opusenc} utility from
1033 opus-tools. The following is an option mapping chart describing options
1034 supported by the libopus wrapper, and their @command{opusenc}-equivalent
1035 in parentheses.
1036
1037 @table @option
1038
1039 @item b (@emph{bitrate})
1040 Set the bit rate in bits/s.  FFmpeg's @option{b} option is
1041 expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
1042 kilobits/s.
1043
1044 @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
1045 Set VBR mode. The FFmpeg @option{vbr} option has the following
1046 valid arguments, with the their @command{opusenc} equivalent options
1047 in parentheses:
1048
1049 @table @samp
1050 @item off (@emph{hard-cbr})
1051 Use constant bit rate encoding.
1052
1053 @item on (@emph{vbr})
1054 Use variable bit rate encoding (the default).
1055
1056 @item constrained (@emph{cvbr})
1057 Use constrained variable bit rate encoding.
1058 @end table
1059
1060 @item compression_level (@emph{comp})
1061 Set encoding algorithm complexity. Valid options are integers in
1062 the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
1063 gives the highest quality but slowest encoding. The default is 10.
1064
1065 @item frame_duration (@emph{framesize})
1066 Set maximum frame size, or duration of a frame in milliseconds. The
1067 argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
1068 frame sizes achieve lower latency but less quality at a given bitrate.
1069 Sizes greater than 20ms are only interesting at fairly low bitrates.
1070 The default is 20ms.
1071
1072 @item packet_loss (@emph{expect-loss})
1073 Set expected packet loss percentage. The default is 0.
1074
1075 @item application (N.A.)
1076 Set intended application type. Valid options are listed below:
1077
1078 @table @samp
1079 @item voip
1080 Favor improved speech intelligibility.
1081 @item audio
1082 Favor faithfulness to the input (the default).
1083 @item lowdelay
1084 Restrict to only the lowest delay modes.
1085 @end table
1086
1087 @item cutoff (N.A.)
1088 Set cutoff bandwidth in Hz. The argument must be exactly one of the
1089 following: 4000, 6000, 8000, 12000, or 20000, corresponding to
1090 narrowband, mediumband, wideband, super wideband, and fullband
1091 respectively. The default is 0 (cutoff disabled).
1092
1093 @end table
1094
1095 @section libvorbis
1096
1097 libvorbis encoder wrapper.
1098
1099 Requires the presence of the libvorbisenc headers and library during
1100 configuration. You need to explicitly configure the build with
1101 @code{--enable-libvorbis}.
1102
1103 @subsection Options
1104
1105 The following options are supported by the libvorbis wrapper. The
1106 @command{oggenc}-equivalent of the options are listed in parentheses.
1107
1108 To get a more accurate and extensive documentation of the libvorbis
1109 options, consult the libvorbisenc's and @command{oggenc}'s documentations.
1110 See @url{http://xiph.org/vorbis/},
1111 @url{http://wiki.xiph.org/Vorbis-tools}, and oggenc(1).
1112
1113 @table @option
1114 @item b (@emph{-b})
1115 Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
1116 expressed in kilobits/s.
1117
1118 @item q (@emph{-q})
1119 Set constant quality setting for VBR. The value should be a float
1120 number in the range of -1.0 to 10.0. The higher the value, the better
1121 the quality. The default value is @samp{3.0}.
1122
1123 This option is valid only using the @command{ffmpeg} command-line tool.
1124 For library interface users, use @option{global_quality}.
1125
1126 @item cutoff (@emph{--advanced-encode-option lowpass_frequency=N})
1127 Set cutoff bandwidth in Hz, a value of 0 disables cutoff. @command{oggenc}'s
1128 related option is expressed in kHz. The default value is @samp{0} (cutoff
1129 disabled).
1130
1131 @item minrate (@emph{-m})
1132 Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
1133 expressed in kilobits/s.
1134
1135 @item maxrate (@emph{-M})
1136 Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
1137 expressed in kilobits/s. This only has effect on ABR mode.
1138
1139 @item iblock (@emph{--advanced-encode-option impulse_noisetune=N})
1140 Set noise floor bias for impulse blocks. The value is a float number from
1141 -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
1142 to the crispness of transients in the encoded audio. The tradeoff for better
1143 transient response is a higher bitrate.
1144
1145 @end table
1146
1147 @anchor{libwavpack}
1148 @section libwavpack
1149
1150 A wrapper providing WavPack encoding through libwavpack.
1151
1152 Only lossless mode using 32-bit integer samples is supported currently.
1153
1154 Requires the presence of the libwavpack headers and library during
1155 configuration. You need to explicitly configure the build with
1156 @code{--enable-libwavpack}.
1157
1158 Note that a libavcodec-native encoder for the WavPack codec exists so users can
1159 encode audios with this codec without using this encoder. See @ref{wavpackenc}.
1160
1161 @subsection Options
1162
1163 @command{wavpack} command line utility's corresponding options are listed in
1164 parentheses, if any.
1165
1166 @table @option
1167 @item frame_size (@emph{--blocksize})
1168 Default is 32768.
1169
1170 @item compression_level
1171 Set speed vs. compression tradeoff. Acceptable arguments are listed below:
1172
1173 @table @samp
1174 @item 0 (@emph{-f})
1175 Fast mode.
1176
1177 @item 1
1178 Normal (default) settings.
1179
1180 @item 2 (@emph{-h})
1181 High quality.
1182
1183 @item 3 (@emph{-hh})
1184 Very high quality.
1185
1186 @item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
1187 Same as @samp{3}, but with extra processing enabled.
1188
1189 @samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
1190
1191 @end table
1192 @end table
1193
1194 @anchor{wavpackenc}
1195 @section wavpack
1196
1197 WavPack lossless audio encoder.
1198
1199 This is a libavcodec-native WavPack encoder. There is also an encoder based on
1200 libwavpack, but there is virtually no reason to use that encoder.
1201
1202 See also @ref{libwavpack}.
1203
1204 @subsection Options
1205
1206 The equivalent options for @command{wavpack} command line utility are listed in
1207 parentheses.
1208
1209 @subsubsection Shared options
1210
1211 The following shared options are effective for this encoder. Only special notes
1212 about this particular encoder will be documented here. For the general meaning
1213 of the options, see @ref{codec-options,,the Codec Options chapter}.
1214
1215 @table @option
1216 @item frame_size (@emph{--blocksize})
1217 For this encoder, the range for this option is between 128 and 131072. Default
1218 is automatically decided based on sample rate and number of channel.
1219
1220 For the complete formula of calculating default, see
1221 @file{libavcodec/wavpackenc.c}.
1222
1223 @item compression_level (@emph{-f}, @emph{-h}, @emph{-hh}, and @emph{-x})
1224 This option's syntax is consistent with @ref{libwavpack}'s.
1225 @end table
1226
1227 @subsubsection Private options
1228
1229 @table @option
1230 @item joint_stereo (@emph{-j})
1231 Set whether to enable joint stereo. Valid values are:
1232
1233 @table @samp
1234 @item on (@emph{1})
1235 Force mid/side audio encoding.
1236 @item off (@emph{0})
1237 Force left/right audio encoding.
1238 @item auto
1239 Let the encoder decide automatically.
1240 @end table
1241
1242 @item optimize_mono
1243 Set whether to enable optimization for mono. This option is only effective for
1244 non-mono streams. Available values:
1245
1246 @table @samp
1247 @item on
1248 enabled
1249 @item off
1250 disabled
1251 @end table
1252
1253 @end table
1254
1255 @c man end AUDIO ENCODERS
1256
1257 @chapter Video Encoders
1258 @c man begin VIDEO ENCODERS
1259
1260 A description of some of the currently available video encoders
1261 follows.
1262
1263 @section libtheora
1264
1265 libtheora Theora encoder wrapper.
1266
1267 Requires the presence of the libtheora headers and library during
1268 configuration. You need to explicitly configure the build with
1269 @code{--enable-libtheora}.
1270
1271 For more informations about the libtheora project see
1272 @url{http://www.theora.org/}.
1273
1274 @subsection Options
1275
1276 The following global options are mapped to internal libtheora options
1277 which affect the quality and the bitrate of the encoded stream.
1278
1279 @table @option
1280 @item b
1281 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1282 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1283
1284 @item flags
1285 Used to enable constant quality mode (VBR) encoding through the
1286 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1287 modes.
1288
1289 @item g
1290 Set the GOP size.
1291
1292 @item global_quality
1293 Set the global quality as an integer in lambda units.
1294
1295 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1296 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1297 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1298 value in the native libtheora range [0-63]. A higher value corresponds
1299 to a higher quality.
1300
1301 @item q
1302 Enable VBR mode when set to a non-negative value, and set constant
1303 quality value as a double floating point value in QP units.
1304
1305 The value is clipped in the [0-10] range, and then multiplied by 6.3
1306 to get a value in the native libtheora range [0-63].
1307
1308 This option is valid only using the @command{ffmpeg} command-line
1309 tool. For library interface users, use @option{global_quality}.
1310 @end table
1311
1312 @subsection Examples
1313
1314 @itemize
1315 @item
1316 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1317 @example
1318 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1319 @end example
1320
1321 @item
1322 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1323 @example
1324 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1325 @end example
1326 @end itemize
1327
1328 @section libvpx
1329
1330 VP8 format supported through libvpx.
1331
1332 Requires the presence of the libvpx headers and library during configuration.
1333 You need to explicitly configure the build with @code{--enable-libvpx}.
1334
1335 @subsection Options
1336
1337 Mapping from FFmpeg to libvpx options with conversion notes in parentheses.
1338
1339 @table @option
1340
1341 @item threads
1342 g_threads
1343
1344 @item profile
1345 g_profile
1346
1347 @item vb
1348 rc_target_bitrate
1349
1350 @item g
1351 kf_max_dist
1352
1353 @item keyint_min
1354 kf_min_dist
1355
1356 @item qmin
1357 rc_min_quantizer
1358
1359 @item qmax
1360 rc_max_quantizer
1361
1362 @item bufsize, vb
1363 rc_buf_sz
1364 @code{(bufsize * 1000 / vb)}
1365
1366 rc_buf_optimal_sz
1367 @code{(bufsize * 1000 / vb * 5 / 6)}
1368
1369 @item rc_init_occupancy, vb
1370 rc_buf_initial_sz
1371 @code{(rc_init_occupancy * 1000 / vb)}
1372
1373 @item rc_buffer_aggressivity
1374 rc_undershoot_pct
1375
1376 @item skip_threshold
1377 rc_dropframe_thresh
1378
1379 @item qcomp
1380 rc_2pass_vbr_bias_pct
1381
1382 @item maxrate, vb
1383 rc_2pass_vbr_maxsection_pct
1384 @code{(maxrate * 100 / vb)}
1385
1386 @item minrate, vb
1387 rc_2pass_vbr_minsection_pct
1388 @code{(minrate * 100 / vb)}
1389
1390 @item minrate, maxrate, vb
1391 @code{VPX_CBR}
1392 @code{(minrate == maxrate == vb)}
1393
1394 @item crf
1395 @code{VPX_CQ}, @code{VP8E_SET_CQ_LEVEL}
1396
1397 @item quality
1398 @table @option
1399 @item @var{best}
1400 @code{VPX_DL_BEST_QUALITY}
1401 @item @var{good}
1402 @code{VPX_DL_GOOD_QUALITY}
1403 @item @var{realtime}
1404 @code{VPX_DL_REALTIME}
1405 @end table
1406
1407 @item speed
1408 @code{VP8E_SET_CPUUSED}
1409
1410 @item nr
1411 @code{VP8E_SET_NOISE_SENSITIVITY}
1412
1413 @item mb_threshold
1414 @code{VP8E_SET_STATIC_THRESHOLD}
1415
1416 @item slices
1417 @code{VP8E_SET_TOKEN_PARTITIONS}
1418
1419 @item max-intra-rate
1420 @code{VP8E_SET_MAX_INTRA_BITRATE_PCT}
1421
1422 @item force_key_frames
1423 @code{VPX_EFLAG_FORCE_KF}
1424
1425 @item Alternate reference frame related
1426 @table @option
1427 @item vp8flags altref
1428 @code{VP8E_SET_ENABLEAUTOALTREF}
1429 @item @var{arnr_max_frames}
1430 @code{VP8E_SET_ARNR_MAXFRAMES}
1431 @item @var{arnr_type}
1432 @code{VP8E_SET_ARNR_TYPE}
1433 @item @var{arnr_strength}
1434 @code{VP8E_SET_ARNR_STRENGTH}
1435 @item @var{rc_lookahead}
1436 g_lag_in_frames
1437 @end table
1438
1439 @item vp8flags error_resilient
1440 g_error_resilient
1441
1442 @end table
1443
1444 For more information about libvpx see:
1445 @url{http://www.webmproject.org/}
1446
1447
1448 @section libwebp
1449
1450 libwebp WebP Image encoder wrapper
1451
1452 libwebp is Google's official encoder for WebP images. It can encode in either
1453 lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
1454 frame. Lossless images are a separate codec developed by Google.
1455
1456 @subsection Pixel Format
1457
1458 Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
1459 to limitations of the format and libwebp. Alpha is supported for either mode.
1460 Because of API limitations, if RGB is passed in when encoding lossy or YUV is
1461 passed in for encoding lossless, the pixel format will automatically be
1462 converted using functions from libwebp. This is not ideal and is done only for
1463 convenience.
1464
1465 @subsection Options
1466
1467 @table @option
1468
1469 @item -lossless @var{boolean}
1470 Enables/Disables use of lossless mode. Default is 0.
1471
1472 @item -compression_level @var{integer}
1473 For lossy, this is a quality/speed tradeoff. Higher values give better quality
1474 for a given size at the cost of increased encoding time. For lossless, this is
1475 a size/speed tradeoff. Higher values give smaller size at the cost of increased
1476 encoding time. More specifically, it controls the number of extra algorithms
1477 and compression tools used, and varies the combination of these tools. This
1478 maps to the @var{method} option in libwebp. The valid range is 0 to 6.
1479 Default is 4.
1480
1481 @item -qscale @var{float}
1482 For lossy encoding, this controls image quality, 0 to 100. For lossless
1483 encoding, this controls the effort and time spent at compressing more. The
1484 default value is 75. Note that for usage via libavcodec, this option is called
1485 @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
1486
1487 @item -preset @var{type}
1488 Configuration preset. This does some automatic settings based on the general
1489 type of the image.
1490 @table @option
1491 @item none
1492 Do not use a preset.
1493 @item default
1494 Use the encoder default.
1495 @item picture
1496 Digital picture, like portrait, inner shot
1497 @item photo
1498 Outdoor photograph, with natural lighting
1499 @item drawing
1500 Hand or line drawing, with high-contrast details
1501 @item icon
1502 Small-sized colorful images
1503 @item text
1504 Text-like
1505 @end table
1506
1507 @end table
1508
1509 @section libx264, libx264rgb
1510
1511 x264 H.264/MPEG-4 AVC encoder wrapper.
1512
1513 This encoder requires the presence of the libx264 headers and library
1514 during configuration. You need to explicitly configure the build with
1515 @code{--enable-libx264}.
1516
1517 libx264 supports an impressive number of features, including 8x8 and
1518 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
1519 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
1520 for detail retention (adaptive quantization, psy-RD, psy-trellis).
1521
1522 Many libx264 encoder options are mapped to FFmpeg global codec
1523 options, while unique encoder options are provided through private
1524 options. Additionally the @option{x264opts} and @option{x264-params}
1525 private options allows to pass a list of key=value tuples as accepted
1526 by the libx264 @code{x264_param_parse} function.
1527
1528 The x264 project website is at
1529 @url{http://www.videolan.org/developers/x264.html}.
1530
1531 The libx264rgb encoder is the same as libx264, except it accepts packed RGB
1532 pixel formats as input instead of YUV.
1533
1534 @subsection Supported Pixel Formats
1535
1536 x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
1537 x264's configure time. FFmpeg only supports one bit depth in one particular
1538 build. In other words, it is not possible to build one FFmpeg with multiple
1539 versions of x264 with different bit depths.
1540
1541 @subsection Options
1542
1543 The following options are supported by the libx264 wrapper. The
1544 @command{x264}-equivalent options or values are listed in parentheses
1545 for easy migration.
1546
1547 To reduce the duplication of documentation, only the private options
1548 and some others requiring special attention are documented here. For
1549 the documentation of the undocumented generic options, see
1550 @ref{codec-options,,the Codec Options chapter}.
1551
1552 To get a more accurate and extensive documentation of the libx264
1553 options, invoke the command @command{x264 --full-help} or consult
1554 the libx264 documentation.
1555
1556 @table @option
1557 @item b (@emph{bitrate})
1558 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1559 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
1560 kilobits/s.
1561
1562 @item bf (@emph{bframes})
1563
1564 @item g (@emph{keyint})
1565
1566 @item qmax (@emph{qpmax})
1567
1568 @item qmin (@emph{qpmin})
1569
1570 @item qdiff (@emph{qpstep})
1571
1572 @item qblur (@emph{qblur})
1573
1574 @item qcomp (@emph{qcomp})
1575
1576 @item refs (@emph{ref})
1577
1578 @item sc_threshold (@emph{scenecut})
1579
1580 @item trellis (@emph{trellis})
1581
1582 @item nr  (@emph{nr})
1583
1584 @item me_range (@emph{merange})
1585
1586 @item me_method (@emph{me})
1587 Set motion estimation method. Possible values in the decreasing order
1588 of speed:
1589
1590 @table @samp
1591 @item dia (@emph{dia})
1592 @item epzs (@emph{dia})
1593 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
1594 @samp{dia}.
1595 @item hex (@emph{hex})
1596 Hexagonal search with radius 2.
1597 @item umh (@emph{umh})
1598 Uneven multi-hexagon search.
1599 @item esa (@emph{esa})
1600 Exhaustive search.
1601 @item tesa (@emph{tesa})
1602 Hadamard exhaustive search (slowest).
1603 @end table
1604
1605 @item subq (@emph{subme})
1606
1607 @item b_strategy (@emph{b-adapt})
1608
1609 @item keyint_min (@emph{min-keyint})
1610
1611 @item coder
1612 Set entropy encoder. Possible values:
1613
1614 @table @samp
1615 @item ac
1616 Enable CABAC.
1617
1618 @item vlc
1619 Enable CAVLC and disable CABAC. It generates the same effect as
1620 @command{x264}'s @option{--no-cabac} option.
1621 @end table
1622
1623 @item cmp
1624 Set full pixel motion estimation comparation algorithm. Possible values:
1625
1626 @table @samp
1627 @item chroma
1628 Enable chroma in motion estimation.
1629
1630 @item sad
1631 Ignore chroma in motion estimation. It generates the same effect as
1632 @command{x264}'s @option{--no-chroma-me} option.
1633 @end table
1634
1635 @item threads (@emph{threads})
1636
1637 @item thread_type
1638 Set multithreading technique. Possible values:
1639
1640 @table @samp
1641 @item slice
1642 Slice-based multithreading. It generates the same effect as
1643 @command{x264}'s @option{--sliced-threads} option.
1644 @item frame
1645 Frame-based multithreading.
1646 @end table
1647
1648 @item flags
1649 Set encoding flags. It can be used to disable closed GOP and enable
1650 open GOP by setting it to @code{-cgop}. The result is similar to
1651 the behavior of @command{x264}'s @option{--open-gop} option.
1652
1653 @item rc_init_occupancy (@emph{vbv-init})
1654
1655 @item preset (@emph{preset})
1656 Set the encoding preset.
1657
1658 @item tune (@emph{tune})
1659 Set tuning of the encoding params.
1660
1661 @item profile (@emph{profile})
1662 Set profile restrictions.
1663
1664 @item fastfirstpass
1665 Enable fast settings when encoding first pass, when set to 1. When set
1666 to 0, it has the same effect of @command{x264}'s
1667 @option{--slow-firstpass} option.
1668
1669 @item crf (@emph{crf})
1670 Set the quality for constant quality mode.
1671
1672 @item crf_max (@emph{crf-max})
1673 In CRF mode, prevents VBV from lowering quality beyond this point.
1674
1675 @item qp (@emph{qp})
1676 Set constant quantization rate control method parameter.
1677
1678 @item aq-mode (@emph{aq-mode})
1679 Set AQ method. Possible values:
1680
1681 @table @samp
1682 @item none (@emph{0})
1683 Disabled.
1684
1685 @item variance (@emph{1})
1686 Variance AQ (complexity mask).
1687
1688 @item autovariance (@emph{2})
1689 Auto-variance AQ (experimental).
1690 @end table
1691
1692 @item aq-strength (@emph{aq-strength})
1693 Set AQ strength, reduce blocking and blurring in flat and textured areas.
1694
1695 @item psy
1696 Use psychovisual optimizations when set to 1. When set to 0, it has the
1697 same effect as @command{x264}'s @option{--no-psy} option.
1698
1699 @item psy-rd  (@emph{psy-rd})
1700 Set strength of psychovisual optimization, in
1701 @var{psy-rd}:@var{psy-trellis} format.
1702
1703 @item rc-lookahead (@emph{rc-lookahead})
1704 Set number of frames to look ahead for frametype and ratecontrol.
1705
1706 @item weightb
1707 Enable weighted prediction for B-frames when set to 1. When set to 0,
1708 it has the same effect as @command{x264}'s @option{--no-weightb} option.
1709
1710 @item weightp (@emph{weightp})
1711 Set weighted prediction method for P-frames. Possible values:
1712
1713 @table @samp
1714 @item none (@emph{0})
1715 Disabled
1716 @item simple (@emph{1})
1717 Enable only weighted refs
1718 @item smart (@emph{2})
1719 Enable both weighted refs and duplicates
1720 @end table
1721
1722 @item ssim (@emph{ssim})
1723 Enable calculation and printing SSIM stats after the encoding.
1724
1725 @item intra-refresh (@emph{intra-refresh})
1726 Enable the use of Periodic Intra Refresh instead of IDR frames when set
1727 to 1.
1728
1729 @item bluray-compat (@emph{bluray-compat})
1730 Configure the encoder to be compatible with the bluray standard.
1731 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
1732
1733 @item b-bias (@emph{b-bias})
1734 Set the influence on how often B-frames are used.
1735
1736 @item b-pyramid (@emph{b-pyramid})
1737 Set method for keeping of some B-frames as references. Possible values:
1738
1739 @table @samp
1740 @item none (@emph{none})
1741 Disabled.
1742 @item strict (@emph{strict})
1743 Strictly hierarchical pyramid.
1744 @item normal (@emph{normal})
1745 Non-strict (not Blu-ray compatible).
1746 @end table
1747
1748 @item mixed-refs
1749 Enable the use of one reference per partition, as opposed to one
1750 reference per macroblock when set to 1. When set to 0, it has the
1751 same effect as @command{x264}'s @option{--no-mixed-refs} option.
1752
1753 @item 8x8dct
1754 Enable adaptive spatial transform (high profile 8x8 transform)
1755 when set to 1. When set to 0, it has the same effect as
1756 @command{x264}'s @option{--no-8x8dct} option.
1757
1758 @item fast-pskip
1759 Enable early SKIP detection on P-frames when set to 1. When set
1760 to 0, it has the same effect as @command{x264}'s
1761 @option{--no-fast-pskip} option.
1762
1763 @item aud (@emph{aud})
1764 Enable use of access unit delimiters when set to 1.
1765
1766 @item mbtree
1767 Enable use macroblock tree ratecontrol when set to 1. When set
1768 to 0, it has the same effect as @command{x264}'s
1769 @option{--no-mbtree} option.
1770
1771 @item deblock (@emph{deblock})
1772 Set loop filter parameters, in @var{alpha}:@var{beta} form.
1773
1774 @item cplxblur (@emph{cplxblur})
1775 Set fluctuations reduction in QP (before curve compression).
1776
1777 @item partitions (@emph{partitions})
1778 Set partitions to consider as a comma-separated list of. Possible
1779 values in the list:
1780
1781 @table @samp
1782 @item p8x8
1783 8x8 P-frame partition.
1784 @item p4x4
1785 4x4 P-frame partition.
1786 @item b8x8
1787 4x4 B-frame partition.
1788 @item i8x8
1789 8x8 I-frame partition.
1790 @item i4x4
1791 4x4 I-frame partition.
1792 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
1793 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
1794 option) to be enabled.)
1795 @item none (@emph{none})
1796 Do not consider any partitions.
1797 @item all (@emph{all})
1798 Consider every partition.
1799 @end table
1800
1801 @item direct-pred (@emph{direct})
1802 Set direct MV prediction mode. Possible values:
1803
1804 @table @samp
1805 @item none (@emph{none})
1806 Disable MV prediction.
1807 @item spatial (@emph{spatial})
1808 Enable spatial predicting.
1809 @item temporal (@emph{temporal})
1810 Enable temporal predicting.
1811 @item auto (@emph{auto})
1812 Automatically decided.
1813 @end table
1814
1815 @item slice-max-size (@emph{slice-max-size})
1816 Set the limit of the size of each slice in bytes. If not specified
1817 but RTP payload size (@option{ps}) is specified, that is used.
1818
1819 @item stats (@emph{stats})
1820 Set the file name for multi-pass stats.
1821
1822 @item nal-hrd (@emph{nal-hrd})
1823 Set signal HRD information (requires @option{vbv-bufsize} to be set).
1824 Possible values:
1825
1826 @table @samp
1827 @item none (@emph{none})
1828 Disable HRD information signaling.
1829 @item vbr (@emph{vbr})
1830 Variable bit rate.
1831 @item cbr (@emph{cbr})
1832 Constant bit rate (not allowed in MP4 container).
1833 @end table
1834
1835 @item x264opts (N.A.)
1836 Set any x264 option, see @command{x264 --fullhelp} for a list.
1837
1838 Argument is a list of @var{key}=@var{value} couples separated by
1839 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
1840 themselves, use "," instead. They accept it as well since long ago but this
1841 is kept undocumented for some reason.
1842
1843 For example to specify libx264 encoding options with @command{ffmpeg}:
1844 @example
1845 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
1846 @end example
1847
1848 @item x264-params (N.A.)
1849 Override the x264 configuration using a :-separated list of key=value
1850 parameters.
1851
1852 This option is functionally the same as the @option{x264opts}, but is
1853 duplicated for compability with the Libav fork.
1854
1855 For example to specify libx264 encoding options with @command{ffmpeg}:
1856 @example
1857 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
1858 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
1859 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
1860 @end example
1861 @end table
1862
1863 Encoding ffpresets for common usages are provided so they can be used with the
1864 general presets system (e.g. passing the @option{pre} option).
1865
1866 @section libxvid
1867
1868 Xvid MPEG-4 Part 2 encoder wrapper.
1869
1870 This encoder requires the presence of the libxvidcore headers and library
1871 during configuration. You need to explicitly configure the build with
1872 @code{--enable-libxvid --enable-gpl}.
1873
1874 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
1875 users can encode to this format without this library.
1876
1877 @subsection Options
1878
1879 The following options are supported by the libxvid wrapper. Some of
1880 the following options are listed but are not documented, and
1881 correspond to shared codec options. See @ref{codec-options,,the Codec
1882 Options chapter} for their documentation. The other shared options
1883 which are not listed have no effect for the libxvid encoder.
1884
1885 @table @option
1886 @item b
1887
1888 @item g
1889
1890 @item qmin
1891
1892 @item qmax
1893
1894 @item mpeg_quant
1895
1896 @item threads
1897
1898 @item bf
1899
1900 @item b_qfactor
1901
1902 @item b_qoffset
1903
1904 @item flags
1905 Set specific encoding flags. Possible values:
1906
1907 @table @samp
1908
1909 @item mv4
1910 Use four motion vector by macroblock.
1911
1912 @item aic
1913 Enable high quality AC prediction.
1914
1915 @item gray
1916 Only encode grayscale.
1917
1918 @item gmc
1919 Enable the use of global motion compensation (GMC).
1920
1921 @item qpel
1922 Enable quarter-pixel motion compensation.
1923
1924 @item cgop
1925 Enable closed GOP.
1926
1927 @item global_header
1928 Place global headers in extradata instead of every keyframe.
1929
1930 @end table
1931
1932 @item trellis
1933
1934 @item me_method
1935 Set motion estimation method. Possible values in decreasing order of
1936 speed and increasing order of quality:
1937
1938 @table @samp
1939 @item zero
1940 Use no motion estimation (default).
1941
1942 @item phods
1943 @item x1
1944 @item log
1945 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
1946 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
1947 @samp{phods}.
1948
1949 @item epzs
1950 Enable all of the things described above, plus advanced diamond zonal
1951 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
1952 estimation on chroma planes.
1953
1954 @item full
1955 Enable all of the things described above, plus extended 16x16 and 8x8
1956 blocks search.
1957 @end table
1958
1959 @item mbd
1960 Set macroblock decision algorithm. Possible values in the increasing
1961 order of quality:
1962
1963 @table @samp
1964 @item simple
1965 Use macroblock comparing function algorithm (default).
1966
1967 @item bits
1968 Enable rate distortion-based half pixel and quarter pixel refinement for
1969 16x16 blocks.
1970
1971 @item rd
1972 Enable all of the things described above, plus rate distortion-based
1973 half pixel and quarter pixel refinement for 8x8 blocks, and rate
1974 distortion-based search using square pattern.
1975 @end table
1976
1977 @item lumi_aq
1978 Enable lumi masking adaptive quantization when set to 1. Default is 0
1979 (disabled).
1980
1981 @item variance_aq
1982 Enable variance adaptive quantization when set to 1. Default is 0
1983 (disabled).
1984
1985 When combined with @option{lumi_aq}, the resulting quality will not
1986 be better than any of the two specified individually. In other
1987 words, the resulting quality will be the worse one of the two
1988 effects.
1989
1990 @item ssim
1991 Set structural similarity (SSIM) displaying method. Possible values:
1992
1993 @table @samp
1994 @item off
1995 Disable displaying of SSIM information.
1996
1997 @item avg
1998 Output average SSIM at the end of encoding to stdout. The format of
1999 showing the average SSIM is:
2000
2001 @example
2002 Average SSIM: %f
2003 @end example
2004
2005 For users who are not familiar with C, %f means a float number, or
2006 a decimal (e.g. 0.939232).
2007
2008 @item frame
2009 Output both per-frame SSIM data during encoding and average SSIM at
2010 the end of encoding to stdout. The format of per-frame information
2011 is:
2012
2013 @example
2014        SSIM: avg: %1.3f min: %1.3f max: %1.3f
2015 @end example
2016
2017 For users who are not familiar with C, %1.3f means a float number
2018 rounded to 3 digits after the dot (e.g. 0.932).
2019
2020 @end table
2021
2022 @item ssim_acc
2023 Set SSIM accuracy. Valid options are integers within the range of
2024 0-4, while 0 gives the most accurate result and 4 computes the
2025 fastest.
2026
2027 @end table
2028
2029 @section png
2030
2031 PNG image encoder.
2032
2033 @subsection Private options
2034
2035 @table @option
2036 @item dpi @var{integer}
2037 Set physical density of pixels, in dots per inch, unset by default
2038 @item dpm @var{integer}
2039 Set physical density of pixels, in dots per meter, unset by default
2040 @end table
2041
2042 @section ProRes
2043
2044 Apple ProRes encoder.
2045
2046 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
2047 The used encoder can be choosen with the @code{-vcodec} option.
2048
2049 @subsection Private Options for prores-ks
2050
2051 @table @option
2052 @item profile @var{integer}
2053 Select the ProRes profile to encode
2054 @table @samp
2055 @item proxy
2056 @item lt
2057 @item standard
2058 @item hq
2059 @item 4444
2060 @end table
2061
2062 @item quant_mat @var{integer}
2063 Select quantization matrix.
2064 @table @samp
2065 @item auto
2066 @item default
2067 @item proxy
2068 @item lt
2069 @item standard
2070 @item hq
2071 @end table
2072 If set to @var{auto}, the matrix matching the profile will be picked.
2073 If not set, the matrix providing the highest quality, @var{default}, will be
2074 picked.
2075
2076 @item bits_per_mb @var{integer}
2077 How many bits to allot for coding one macroblock. Different profiles use
2078 between 200 and 2400 bits per macroblock, the maximum is 8000.
2079
2080 @item mbs_per_slice @var{integer}
2081 Number of macroblocks in each slice (1-8); the default value (8)
2082 should be good in almost all situations.
2083
2084 @item vendor @var{string}
2085 Override the 4-byte vendor ID.
2086 A custom vendor ID like @var{apl0} would claim the stream was produced by
2087 the Apple encoder.
2088
2089 @item alpha_bits @var{integer}
2090 Specify number of bits for alpha component.
2091 Possible values are @var{0}, @var{8} and @var{16}.
2092 Use @var{0} to disable alpha plane coding.
2093
2094 @end table
2095
2096 @subsection Speed considerations
2097
2098 In the default mode of operation the encoder has to honor frame constraints
2099 (i.e. not produc frames with size bigger than requested) while still making
2100 output picture as good as possible.
2101 A frame containing a lot of small details is harder to compress and the encoder
2102 would spend more time searching for appropriate quantizers for each slice.
2103
2104 Setting a higher @option{bits_per_mb} limit will improve the speed.
2105
2106 For the fastest encoding speed set the @option{qscale} parameter (4 is the
2107 recommended value) and do not set a size constraint.
2108
2109 @c man end VIDEO ENCODERS