doc/encoders: document the libfdk-aac wrapper
[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{libfaac}, @ref{libaacplus}
42 See also @ref{libfdk-aac-enc,,the libfdk_aac section}.
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{libfdk-aac-enc}
498 @section libfdk_aac
499
500 libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
501
502 The libfdk-aac library is based on the Fraunhofer FDK AAC code from
503 the Android project.
504
505 Requires the presence of the libfdk-aac headers and library during
506 configuration. You need to explicitly configure the build with
507 @code{--enable-libfdk-aac}. The library is also incompatible with GPL,
508 so if you allow the use of GPL, you should configure with
509 @code{--enable-gpl --enable-nonfree --enable-libfdk-aac}.
510
511 This encoder is considered to be of higher quality with respect to
512 both @ref{aacenc,,the native experimental FFmpeg AAC encoder} and
513 libfaac.
514
515 For more information see the fdk-aac project at
516 @url{http://sourceforge.net/p/opencore-amr/fdk-aac/}.
517
518 @subsection Options
519
520 The following options are mapped on the shared FFmpeg codec options.
521
522 @table @option
523 @item b
524 Set bit rate in bits/s. If the bitrate is not explicitly specified, it
525 is automatically set to a suitable value depending on the selected
526 profile.
527
528 In case VBR mode is enabled the option is ignored.
529
530 @item ar
531 Set audio sampling rate (in Hz).
532
533 @item channels
534 Set the number of audio channels.
535
536 @item flags +qscale
537 Enable fixed quality, VBR (Variable Bit Rate) mode.
538 Note that VBR is implicitely enabled when the @option{vbr} value is
539 positive.
540
541 @item cutoff
542 Set cutoff frequency. If not specified (or explicitly set to 0) it
543 will use a value automatically computed by the library. Default value
544 is 0.
545
546 @item profile
547 Set audio profile.
548
549 The following profiles are recognized:
550 @table @samp
551 @item aac_low
552 Low Complexity AAC (LC)
553
554 @item aac_he
555 High Efficiency AAC (HE-AAC)
556
557 @item aac_he_v2
558 High Efficiency AAC version 2 (HE-AACv2)
559
560 @item aac_ld
561 Low Delay AAC (LD)
562
563 @item aac_eld
564 Enhanced Low Delay AAC (ELD)
565 @end table
566
567 If not specified it is set to @samp{aac_low}.
568 @end table
569
570 The following are private options of the libfdk_aac encoder.
571
572 @table @option
573 @item afterburner
574 Enable afterburner feature if set to 1, disabled if set to 0. This
575 improves the quality but also the required processing power.
576
577 Default value is 1.
578
579 @item eld_sbr
580 Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
581 if set to 0.
582
583 Default value is 0.
584
585 @item signaling
586 Set SBR/PS signaling style.
587
588 It can assume one of the following values:
589 @table @samp
590 @item default
591 choose signaling implicitly (explicit hierarchical by default,
592 implicit if global header is disabled)
593
594 @item implicit
595 implicit backwards compatible signaling
596
597 @item explicit_sbr
598 explicit SBR, implicit PS signaling
599
600 @item explicit_hierarchical
601 explicit hierarchical signaling
602 @end table
603
604 Default value is @samp{default}.
605
606 @item latm
607 Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
608
609 Default value is 0.
610
611 @item header_period
612 Set StreamMuxConfig and PCE repetition period (in frames) for sending
613 in-band configuration buffers within LATM/LOAS transport layer.
614
615 Must be a 16-bits non-negative integer.
616
617 Default value is 0.
618
619 @item vbr
620 Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
621 good) and 5 is highest quality. A value of 0 will disable VBR mode,
622 and CBR (Constant Bit Rate) mode is enabled.
623
624 Currently only the @samp{aac_low} profile supports VBR mode.
625
626 VBR modes 1-5 correspond to roughly the following average bit rate:
627
628 @table @samp
629 @item 1
630 32 kbps/channel
631 @item 2
632 40 kbps/channel
633 @item 3
634 48-56 kbps/channel
635 @item 4
636 64 kbps/channel
637 @item 5
638 about 80-96 kbps/channel
639 @end table
640
641 Default value is 0.
642 @end table
643
644 @section Examples
645
646 @itemize
647 @item
648 Use @command{ffmpeg} to convert an audio file to VBR AAC in an M4A (MP4)
649 container:
650 @example
651 ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
652 @end example
653
654 @item
655 Use @command{ffmpeg} to convert an audio file to CBR 64k kbps AAC, using the
656 High-Efficiency AAC profile:
657 @example
658 ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
659 @end example
660 @end itemize
661
662 @anchor{libmp3lame}
663 @section libmp3lame
664
665 LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper.
666
667 Requires the presence of the libmp3lame headers and library during
668 configuration. You need to explicitly configure the build with
669 @code{--enable-libmp3lame}.
670
671 See @ref{libshine} for a fixed-point MP3 encoder, although with a
672 lower quality.
673
674 @subsection Options
675
676 The following options are supported by the libmp3lame wrapper. The
677 @command{lame}-equivalent of the options are listed in parentheses.
678
679 @table @option
680 @item b (@emph{-b})
681 Set bitrate expressed in bits/s for CBR. LAME @code{bitrate} is
682 expressed in kilobits/s.
683
684 @item q (@emph{-V})
685 Set constant quality setting for VBR. This option is valid only
686 using the @command{ffmpeg} command-line tool. For library interface
687 users, use @option{global_quality}.
688
689 @item compression_level (@emph{-q})
690 Set algorithm quality. Valid arguments are integers in the 0-9 range,
691 with 0 meaning highest quality but slowest, and 9 meaning fastest
692 while producing the worst quality.
693
694 @item reservoir
695 Enable use of bit reservoir when set to 1. Default value is 1. LAME
696 has this enabled by default, but can be overriden by use
697 @option{--nores} option.
698
699 @item joint_stereo (@emph{-m j})
700 Enable the encoder to use (on a frame by frame basis) either L/R
701 stereo or mid/side stereo. Default value is 1.
702
703 @end table
704
705 @section libopencore-amrnb
706
707 OpenCORE Adaptive Multi-Rate Narrowband encoder.
708
709 Requires the presence of the libopencore-amrnb headers and library during
710 configuration. You need to explicitly configure the build with
711 @code{--enable-libopencore-amrnb --enable-version3}.
712
713 This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
714 but you can override it by setting @option{strict} to @samp{unofficial} or
715 lower.
716
717 @subsection Options
718
719 @table @option
720
721 @item b
722 Set bitrate in bits per second. Only the following bitrates are supported,
723 otherwise libavcodec will round to the nearest valid bitrate.
724
725 @table @option
726 @item 4750
727 @item 5150
728 @item 5900
729 @item 6700
730 @item 7400
731 @item 7950
732 @item 10200
733 @item 12200
734 @end table
735
736 @item dtx
737 Allow discontinuous transmission (generate comfort noise) when set to 1. The
738 default value is 0 (disabled).
739
740 @end table
741
742 @anchor{libshine}
743 @section libshine
744
745 Shine Fixed-Point MP3 encoder wrapper.
746
747 Shine is a fixed-point MP3 encoder. It has a far better performance on
748 platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
749 However, as it is more targeted on performance than quality, it is not on par
750 with LAME and other production-grade encoders quality-wise. Also, according to
751 the project's homepage, this encoder may not be free of bugs as the code was
752 written a long time ago and the project was dead for at least 5 years.
753
754 This encoder only supports stereo and mono input. This is also CBR-only.
755
756 The original project (last updated in early 2007) is at
757 @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
758 updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
759
760 Requires the presence of the libshine headers and library during
761 configuration. You need to explicitly configure the build with
762 @code{--enable-libshine}.
763
764 See also @ref{libmp3lame}.
765
766 @subsection Options
767
768 The following options are supported by the libshine wrapper. The
769 @command{shineenc}-equivalent of the options are listed in parentheses.
770
771 @table @option
772 @item b (@emph{-b})
773 Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
774 is expressed in kilobits/s.
775
776 @end table
777
778 @section libtwolame
779
780 TwoLAME MP2 encoder wrapper.
781
782 Requires the presence of the libtwolame headers and library during
783 configuration. You need to explicitly configure the build with
784 @code{--enable-libtwolame}.
785
786 @subsection Options
787
788 The following options are supported by the libtwolame wrapper. The
789 @command{twolame}-equivalent options follow the FFmpeg ones and are in
790 parentheses.
791
792 @table @option
793 @item b (@emph{-b})
794 Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
795 option is expressed in kilobits/s. Default value is 128k.
796
797 @item q (@emph{-V})
798 Set quality for experimental VBR support. Maximum value range is
799 from -50 to 50, useful range is from -10 to 10. The higher the
800 value, the better the quality. This option is valid only using the
801 @command{ffmpeg} command-line tool. For library interface users,
802 use @option{global_quality}.
803
804 @item mode (@emph{--mode})
805 Set the mode of the resulting audio. Possible values:
806
807 @table @samp
808 @item auto
809 Choose mode automatically based on the input. This is the default.
810 @item stereo
811 Stereo
812 @item joint_stereo
813 Joint stereo
814 @item dual_channel
815 Dual channel
816 @item mono
817 Mono
818 @end table
819
820 @item psymodel (@emph{--psyc-mode})
821 Set psychoacoustic model to use in encoding. The argument must be
822 an integer between -1 and 4, inclusive. The higher the value, the
823 better the quality. The default value is 3.
824
825 @item energy_levels (@emph{--energy})
826 Enable energy levels extensions when set to 1. The default value is
827 0 (disabled).
828
829 @item error_protection (@emph{--protect})
830 Enable CRC error protection when set to 1. The default value is 0
831 (disabled).
832
833 @item copyright (@emph{--copyright})
834 Set MPEG audio copyright flag when set to 1. The default value is 0
835 (disabled).
836
837 @item original (@emph{--original})
838 Set MPEG audio original flag when set to 1. The default value is 0
839 (disabled).
840
841 @end table
842
843 @anchor{libvo-aacenc}
844 @section libvo-aacenc
845
846 VisualOn AAC encoder.
847
848 Requires the presence of the libvo-aacenc headers and library during
849 configuration. You need to explicitly configure the build with
850 @code{--enable-libvo-aacenc --enable-version3}.
851
852 This encoder is considered to be worse than the
853 @ref{aacenc,,native experimental FFmpeg AAC encoder}, according to
854 multiple sources.
855
856 @subsection Options
857
858 The VisualOn AAC encoder only support encoding AAC-LC and up to 2
859 channels. It is also CBR-only.
860
861 @table @option
862
863 @item b
864 Set bit rate in bits/s.
865
866 @end table
867
868 @section libvo-amrwbenc
869
870 VisualOn Adaptive Multi-Rate Wideband encoder.
871
872 Requires the presence of the libvo-amrwbenc headers and library during
873 configuration. You need to explicitly configure the build with
874 @code{--enable-libvo-amrwbenc --enable-version3}.
875
876 This is a mono-only encoder. Officially it only supports 16000Hz sample
877 rate, but you can override it by setting @option{strict} to
878 @samp{unofficial} or lower.
879
880 @subsection Options
881
882 @table @option
883
884 @item b
885 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
886 libavcodec will round to the nearest valid bitrate.
887
888 @table @samp
889 @item 6600
890 @item 8850
891 @item 12650
892 @item 14250
893 @item 15850
894 @item 18250
895 @item 19850
896 @item 23050
897 @item 23850
898 @end table
899
900 @item dtx
901 Allow discontinuous transmission (generate comfort noise) when set to 1. The
902 default value is 0 (disabled).
903
904 @end table
905
906 @section libopus
907
908 libopus Opus Interactive Audio Codec encoder wrapper.
909
910 Requires the presence of the libopus headers and library during
911 configuration. You need to explicitly configure the build with
912 @code{--enable-libopus}.
913
914 @subsection Option Mapping
915
916 Most libopus options are modeled after the @command{opusenc} utility from
917 opus-tools. The following is an option mapping chart describing options
918 supported by the libopus wrapper, and their @command{opusenc}-equivalent
919 in parentheses.
920
921 @table @option
922
923 @item b (@emph{bitrate})
924 Set the bit rate in bits/s.  FFmpeg's @option{b} option is
925 expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
926 kilobits/s.
927
928 @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
929 Set VBR mode. The FFmpeg @option{vbr} option has the following
930 valid arguments, with the their @command{opusenc} equivalent options
931 in parentheses:
932
933 @table @samp
934 @item off (@emph{hard-cbr})
935 Use constant bit rate encoding.
936
937 @item on (@emph{vbr})
938 Use variable bit rate encoding (the default).
939
940 @item constrained (@emph{cvbr})
941 Use constrained variable bit rate encoding.
942 @end table
943
944 @item compression_level (@emph{comp})
945 Set encoding algorithm complexity. Valid options are integers in
946 the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
947 gives the highest quality but slowest encoding. The default is 10.
948
949 @item frame_duration (@emph{framesize})
950 Set maximum frame size, or duration of a frame in milliseconds. The
951 argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
952 frame sizes achieve lower latency but less quality at a given bitrate.
953 Sizes greater than 20ms are only interesting at fairly low bitrates.
954 The default of FFmpeg is 10ms, but is 20ms in @command{opusenc}.
955
956 @item packet_loss (@emph{expect-loss})
957 Set expected packet loss percentage. The default is 0.
958
959 @item application (N.A.)
960 Set intended application type. Valid options are listed below:
961
962 @table @samp
963 @item voip
964 Favor improved speech intelligibility.
965 @item audio
966 Favor faithfulness to the input (the default).
967 @item lowdelay
968 Restrict to only the lowest delay modes.
969 @end table
970
971 @item cutoff (N.A.)
972 Set cutoff bandwidth in Hz. The argument must be exactly one of the
973 following: 4000, 6000, 8000, 12000, or 20000, corresponding to
974 narrowband, mediumband, wideband, super wideband, and fullband
975 respectively. The default is 0 (cutoff disabled).
976
977 @end table
978
979 @section libvorbis
980
981 libvorbis encoder wrapper.
982
983 Requires the presence of the libvorbisenc headers and library during
984 configuration. You need to explicitly configure the build with
985 @code{--enable-libvorbis}.
986
987 @subsection Options
988
989 The following options are supported by the libvorbis wrapper. The
990 @command{oggenc}-equivalent of the options are listed in parentheses.
991
992 To get a more accurate and extensive documentation of the libvorbis
993 options, consult the libvorbisenc's and @command{oggenc}'s documentations.
994 See @url{http://xiph.org/vorbis/},
995 @url{http://wiki.xiph.org/Vorbis-tools}, and oggenc(1).
996
997 @table @option
998 @item b (@emph{-b})
999 Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
1000 expressed in kilobits/s.
1001
1002 @item q (@emph{-q})
1003 Set constant quality setting for VBR. The value should be a float
1004 number in the range of -1.0 to 10.0. The higher the value, the better
1005 the quality. The default value is @samp{3.0}.
1006
1007 This option is valid only using the @command{ffmpeg} command-line tool.
1008 For library interface users, use @option{global_quality}.
1009
1010 @item cutoff (@emph{--advanced-encode-option lowpass_frequency=N})
1011 Set cutoff bandwidth in Hz, a value of 0 disables cutoff. @command{oggenc}'s
1012 related option is expressed in kHz. The default value is @samp{0} (cutoff
1013 disabled).
1014
1015 @item minrate (@emph{-m})
1016 Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
1017 expressed in kilobits/s.
1018
1019 @item maxrate (@emph{-M})
1020 Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
1021 expressed in kilobits/s. This only has effect on ABR mode.
1022
1023 @item iblock (@emph{--advanced-encode-option impulse_noisetune=N})
1024 Set noise floor bias for impulse blocks. The value is a float number from
1025 -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
1026 to the crispness of transients in the encoded audio. The tradeoff for better
1027 transient response is a higher bitrate.
1028
1029 @end table
1030
1031 @section libwavpack
1032
1033 A wrapper providing WavPack encoding through libwavpack.
1034
1035 Only lossless mode using 32-bit integer samples is supported currently.
1036 The @option{compression_level} option can be used to control speed vs.
1037 compression tradeoff, with the values mapped to libwavpack as follows:
1038
1039 @table @option
1040
1041 @item 0
1042 Fast mode - corresponding to the wavpack @option{-f} option.
1043
1044 @item 1
1045 Normal (default) settings.
1046
1047 @item 2
1048 High quality - corresponding to the wavpack @option{-h} option.
1049
1050 @item 3
1051 Very high quality - corresponding to the wavpack @option{-hh} option.
1052
1053 @item 4-8
1054 Same as 3, but with extra processing enabled - corresponding to the wavpack
1055 @option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
1056 @option{-x6}.
1057
1058 @end table
1059
1060 @c man end AUDIO ENCODERS
1061
1062 @chapter Video Encoders
1063 @c man begin VIDEO ENCODERS
1064
1065 A description of some of the currently available video encoders
1066 follows.
1067
1068 @section libtheora
1069
1070 libtheora Theora encoder wrapper.
1071
1072 Requires the presence of the libtheora headers and library during
1073 configuration. You need to explicitly configure the build with
1074 @code{--enable-libtheora}.
1075
1076 For more informations about the libtheora project see
1077 @url{http://www.theora.org/}.
1078
1079 @subsection Options
1080
1081 The following global options are mapped to internal libtheora options
1082 which affect the quality and the bitrate of the encoded stream.
1083
1084 @table @option
1085 @item b
1086 Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode.  In
1087 case VBR (Variable Bit Rate) mode is enabled this option is ignored.
1088
1089 @item flags
1090 Used to enable constant quality mode (VBR) encoding through the
1091 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
1092 modes.
1093
1094 @item g
1095 Set the GOP size.
1096
1097 @item global_quality
1098 Set the global quality as an integer in lambda units.
1099
1100 Only relevant when VBR mode is enabled with @code{flags +qscale}. The
1101 value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
1102 clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
1103 value in the native libtheora range [0-63]. A higher value corresponds
1104 to a higher quality.
1105
1106 @item q
1107 Enable VBR mode when set to a non-negative value, and set constant
1108 quality value as a double floating point value in QP units.
1109
1110 The value is clipped in the [0-10] range, and then multiplied by 6.3
1111 to get a value in the native libtheora range [0-63].
1112
1113 This option is valid only using the @command{ffmpeg} command-line
1114 tool. For library interface users, use @option{global_quality}.
1115 @end table
1116
1117 @subsection Examples
1118
1119 @itemize
1120 @item
1121 Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
1122 @example
1123 ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
1124 @end example
1125
1126 @item
1127 Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
1128 @example
1129 ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
1130 @end example
1131 @end itemize
1132
1133 @section libvpx
1134
1135 VP8 format supported through libvpx.
1136
1137 Requires the presence of the libvpx headers and library during configuration.
1138 You need to explicitly configure the build with @code{--enable-libvpx}.
1139
1140 @subsection Options
1141
1142 Mapping from FFmpeg to libvpx options with conversion notes in parentheses.
1143
1144 @table @option
1145
1146 @item threads
1147 g_threads
1148
1149 @item profile
1150 g_profile
1151
1152 @item vb
1153 rc_target_bitrate
1154
1155 @item g
1156 kf_max_dist
1157
1158 @item keyint_min
1159 kf_min_dist
1160
1161 @item qmin
1162 rc_min_quantizer
1163
1164 @item qmax
1165 rc_max_quantizer
1166
1167 @item bufsize, vb
1168 rc_buf_sz
1169 @code{(bufsize * 1000 / vb)}
1170
1171 rc_buf_optimal_sz
1172 @code{(bufsize * 1000 / vb * 5 / 6)}
1173
1174 @item rc_init_occupancy, vb
1175 rc_buf_initial_sz
1176 @code{(rc_init_occupancy * 1000 / vb)}
1177
1178 @item rc_buffer_aggressivity
1179 rc_undershoot_pct
1180
1181 @item skip_threshold
1182 rc_dropframe_thresh
1183
1184 @item qcomp
1185 rc_2pass_vbr_bias_pct
1186
1187 @item maxrate, vb
1188 rc_2pass_vbr_maxsection_pct
1189 @code{(maxrate * 100 / vb)}
1190
1191 @item minrate, vb
1192 rc_2pass_vbr_minsection_pct
1193 @code{(minrate * 100 / vb)}
1194
1195 @item minrate, maxrate, vb
1196 @code{VPX_CBR}
1197 @code{(minrate == maxrate == vb)}
1198
1199 @item crf
1200 @code{VPX_CQ}, @code{VP8E_SET_CQ_LEVEL}
1201
1202 @item quality
1203 @table @option
1204 @item @var{best}
1205 @code{VPX_DL_BEST_QUALITY}
1206 @item @var{good}
1207 @code{VPX_DL_GOOD_QUALITY}
1208 @item @var{realtime}
1209 @code{VPX_DL_REALTIME}
1210 @end table
1211
1212 @item speed
1213 @code{VP8E_SET_CPUUSED}
1214
1215 @item nr
1216 @code{VP8E_SET_NOISE_SENSITIVITY}
1217
1218 @item mb_threshold
1219 @code{VP8E_SET_STATIC_THRESHOLD}
1220
1221 @item slices
1222 @code{VP8E_SET_TOKEN_PARTITIONS}
1223
1224 @item max-intra-rate
1225 @code{VP8E_SET_MAX_INTRA_BITRATE_PCT}
1226
1227 @item force_key_frames
1228 @code{VPX_EFLAG_FORCE_KF}
1229
1230 @item Alternate reference frame related
1231 @table @option
1232 @item vp8flags altref
1233 @code{VP8E_SET_ENABLEAUTOALTREF}
1234 @item @var{arnr_max_frames}
1235 @code{VP8E_SET_ARNR_MAXFRAMES}
1236 @item @var{arnr_type}
1237 @code{VP8E_SET_ARNR_TYPE}
1238 @item @var{arnr_strength}
1239 @code{VP8E_SET_ARNR_STRENGTH}
1240 @item @var{rc_lookahead}
1241 g_lag_in_frames
1242 @end table
1243
1244 @item vp8flags error_resilient
1245 g_error_resilient
1246
1247 @end table
1248
1249 For more information about libvpx see:
1250 @url{http://www.webmproject.org/}
1251
1252 @section libx264
1253
1254 x264 H.264/MPEG-4 AVC encoder wrapper.
1255
1256 This encoder requires the presence of the libx264 headers and library
1257 during configuration. You need to explicitly configure the build with
1258 @code{--enable-libx264}.
1259
1260 libx264 supports an impressive number of features, including 8x8 and
1261 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
1262 entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
1263 for detail retention (adaptive quantization, psy-RD, psy-trellis).
1264
1265 Many libx264 encoder options are mapped to FFmpeg global codec
1266 options, while unique encoder options are provided through private
1267 options. Additionally the @option{x264opts} and @option{x264-params}
1268 private options allows to pass a list of key=value tuples as accepted
1269 by the libx264 @code{x264_param_parse} function.
1270
1271 The x264 project website is at
1272 @url{http://www.videolan.org/developers/x264.html}.
1273
1274 @subsection Options
1275
1276 The following options are supported by the libx264 wrapper. The
1277 @command{x264}-equivalent options or values are listed in parentheses
1278 for easy migration.
1279
1280 To reduce the duplication of documentation, only the private options
1281 and some others requiring special attention are documented here. For
1282 the documentation of the undocumented generic options, see
1283 @ref{codec-options,,the Codec Options chapter}.
1284
1285 To get a more accurate and extensive documentation of the libx264
1286 options, invoke the command @command{x264 --full-help} or consult
1287 the libx264 documentation.
1288
1289 @table @option
1290 @item b (@emph{bitrate})
1291 Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
1292 expressed in bits/s, while @command{x264}'s @option{bitrate} is in
1293 kilobits/s.
1294
1295 @item bf (@emph{bframes})
1296
1297 @item g (@emph{keyint})
1298
1299 @item qmax (@emph{qpmax})
1300
1301 @item qmin (@emph{qpmin})
1302
1303 @item qdiff (@emph{qpstep})
1304
1305 @item qblur (@emph{qblur})
1306
1307 @item qcomp (@emph{qcomp})
1308
1309 @item refs (@emph{ref})
1310
1311 @item sc_threshold (@emph{scenecut})
1312
1313 @item trellis (@emph{trellis})
1314
1315 @item nr  (@emph{nr})
1316
1317 @item me_range (@emph{merange})
1318
1319 @item me_method (@emph{me})
1320 Set motion estimation method. Possible values in the decreasing order
1321 of speed:
1322
1323 @table @samp
1324 @item dia (@emph{dia})
1325 @item epzs (@emph{dia})
1326 Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
1327 @samp{dia}.
1328 @item hex (@emph{hex})
1329 Hexagonal search with radius 2.
1330 @item umh (@emph{umh})
1331 Uneven multi-hexagon search.
1332 @item esa (@emph{esa})
1333 Exhaustive search.
1334 @item tesa (@emph{tesa})
1335 Hadamard exhaustive search (slowest).
1336 @end table
1337
1338 @item subq (@emph{subme})
1339
1340 @item b_strategy (@emph{b-adapt})
1341
1342 @item keyint_min (@emph{min-keyint})
1343
1344 @item coder
1345 Set entropy encoder. Possible values:
1346
1347 @table @samp
1348 @item ac
1349 Enable CABAC.
1350
1351 @item vlc
1352 Enable CAVLC and disable CABAC. It generates the same effect as
1353 @command{x264}'s @option{--no-cabac} option.
1354 @end table
1355
1356 @item cmp
1357 Set full pixel motion estimation comparation algorithm. Possible values:
1358
1359 @table @samp
1360 @item chroma
1361 Enable chroma in motion estimation.
1362
1363 @item sad
1364 Ignore chroma in motion estimation. It generates the same effect as
1365 @command{x264}'s @option{--no-chroma-me} option.
1366 @end table
1367
1368 @item threads (@emph{threads})
1369
1370 @item thread_type
1371 Set multithreading technique. Possible values:
1372
1373 @table @samp
1374 @item slice
1375 Slice-based multithreading. It generates the same effect as
1376 @command{x264}'s @option{--sliced-threads} option.
1377 @item frame
1378 Frame-based multithreading.
1379 @end table
1380
1381 @item flags
1382 Set encoding flags. It can be used to disable closed GOP and enable
1383 open GOP by setting it to @code{-cgop}. The result is similar to
1384 the behavior of @command{x264}'s @option{--open-gop} option.
1385
1386 @item rc_init_occupancy (@emph{vbv-init})
1387
1388 @item preset (@emph{preset})
1389 Set the encoding preset.
1390
1391 @item tune (@emph{tune})
1392 Set tuning of the encoding params.
1393
1394 @item profile (@emph{profile})
1395 Set profile restrictions.
1396
1397 @item fastfirstpass
1398 Enable fast settings when encoding first pass, when set to 1. When set
1399 to 0, it has the same effect of @command{x264}'s
1400 @option{--slow-firstpass} option.
1401
1402 @item crf (@emph{crf})
1403 Set the quality for constant quality mode.
1404
1405 @item crf_max (@emph{crf-max})
1406 In CRF mode, prevents VBV from lowering quality beyond this point.
1407
1408 @item qp (@emph{qp})
1409 Set constant quantization rate control method parameter.
1410
1411 @item aq-mode (@emph{aq-mode})
1412 Set AQ method. Possible values:
1413
1414 @table @samp
1415 @item none (@emph{0})
1416 Disabled.
1417
1418 @item variance (@emph{1})
1419 Variance AQ (complexity mask).
1420
1421 @item autovariance (@emph{2})
1422 Auto-variance AQ (experimental).
1423 @end table
1424
1425 @item aq-strength (@emph{aq-strength})
1426 Set AQ strength, reduce blocking and blurring in flat and textured areas.
1427
1428 @item psy
1429 Use psychovisual optimizations when set to 1. When set to 0, it has the
1430 same effect as @command{x264}'s @option{--no-psy} option.
1431
1432 @item psy-rd  (@emph{psy-rd})
1433 Set strength of psychovisual optimization, in
1434 @var{psy-rd}:@var{psy-trellis} format.
1435
1436 @item rc-lookahead (@emph{rc-lookahead})
1437 Set number of frames to look ahead for frametype and ratecontrol.
1438
1439 @item weightb
1440 Enable weighted prediction for B-frames when set to 1. When set to 0,
1441 it has the same effect as @command{x264}'s @option{--no-weightb} option.
1442
1443 @item weightp (@emph{weightp})
1444 Set weighted prediction method for P-frames. Possible values:
1445
1446 @table @samp
1447 @item none (@emph{0})
1448 Disabled
1449 @item simple (@emph{1})
1450 Enable only weighted refs
1451 @item smart (@emph{2})
1452 Enable both weighted refs and duplicates
1453 @end table
1454
1455 @item ssim (@emph{ssim})
1456 Enable calculation and printing SSIM stats after the encoding.
1457
1458 @item intra-refresh (@emph{intra-refresh})
1459 Enable the use of Periodic Intra Refresh instead of IDR frames when set
1460 to 1.
1461
1462 @item bluray-compat (@emph{bluray-compat})
1463 Configure the encoder to be compatible with the bluray standard.
1464 It is a shorthand for setting "bluray-compat=1 force-cfr=1".
1465
1466 @item b-bias (@emph{b-bias})
1467 Set the influence on how often B-frames are used.
1468
1469 @item b-pyramid (@emph{b-pyramid})
1470 Set method for keeping of some B-frames as references. Possible values:
1471
1472 @table @samp
1473 @item none (@emph{none})
1474 Disabled.
1475 @item strict (@emph{strict})
1476 Strictly hierarchical pyramid.
1477 @item normal (@emph{normal})
1478 Non-strict (not Blu-ray compatible).
1479 @end table
1480
1481 @item mixed-refs
1482 Enable the use of one reference per partition, as opposed to one
1483 reference per macroblock when set to 1. When set to 0, it has the
1484 same effect as @command{x264}'s @option{--no-mixed-refs} option.
1485
1486 @item 8x8dct
1487 Enable adaptive spatial transform (high profile 8x8 transform)
1488 when set to 1. When set to 0, it has the same effect as
1489 @command{x264}'s @option{--no-8x8dct} option.
1490
1491 @item fast-pskip
1492 Enable early SKIP detection on P-frames when set to 1. When set
1493 to 0, it has the same effect as @command{x264}'s
1494 @option{--no-fast-pskip} option.
1495
1496 @item aud (@emph{aud})
1497 Enable use of access unit delimiters when set to 1.
1498
1499 @item mbtree
1500 Enable use macroblock tree ratecontrol when set to 1. When set
1501 to 0, it has the same effect as @command{x264}'s
1502 @option{--no-mbtree} option.
1503
1504 @item deblock (@emph{deblock})
1505 Set loop filter parameters, in @var{alpha}:@var{beta} form.
1506
1507 @item cplxblur (@emph{cplxblur})
1508 Set fluctuations reduction in QP (before curve compression).
1509
1510 @item partitions (@emph{partitions})
1511 Set partitions to consider as a comma-separated list of. Possible
1512 values in the list:
1513
1514 @table @samp
1515 @item p8x8
1516 8x8 P-frame partition.
1517 @item p4x4
1518 4x4 P-frame partition.
1519 @item b8x8
1520 4x4 B-frame partition.
1521 @item i8x8
1522 8x8 I-frame partition.
1523 @item i4x4
1524 4x4 I-frame partition.
1525 (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
1526 @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
1527 option) to be enabled.)
1528 @item none (@emph{none})
1529 Do not consider any partitions.
1530 @item all (@emph{all})
1531 Consider every partition.
1532 @end table
1533
1534 @item direct-pred (@emph{direct})
1535 Set direct MV prediction mode. Possible values:
1536
1537 @table @samp
1538 @item none (@emph{none})
1539 Disable MV prediction.
1540 @item spatial (@emph{spatial})
1541 Enable spatial predicting.
1542 @item temporal (@emph{temporal})
1543 Enable temporal predicting.
1544 @item auto (@emph{auto})
1545 Automatically decided.
1546 @end table
1547
1548 @item slice-max-size (@emph{slice-max-size})
1549 Set the limit of the size of each slice in bytes. If not specified
1550 but RTP payload size (@option{ps}) is specified, that is used.
1551
1552 @item stats (@emph{stats})
1553 Set the file name for multi-pass stats.
1554
1555 @item nal-hrd (@emph{nal-hrd})
1556 Set signal HRD information (requires @option{vbv-bufsize} to be set).
1557 Possible values:
1558
1559 @table @samp
1560 @item none (@emph{none})
1561 Disable HRD information signaling.
1562 @item vbr (@emph{vbr})
1563 Variable bit rate.
1564 @item cbr (@emph{cbr})
1565 Constant bit rate (not allowed in MP4 container).
1566 @end table
1567
1568 @item x264opts (N.A.)
1569 Set any x264 option, see @command{x264 --fullhelp} for a list.
1570
1571 Argument is a list of @var{key}=@var{value} couples separated by
1572 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
1573 themselves, use "," instead. They accept it as well since long ago but this
1574 is kept undocumented for some reason.
1575
1576 For example to specify libx264 encoding options with @command{ffmpeg}:
1577 @example
1578 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
1579 @end example
1580
1581 @item x264-params (N.A.)
1582 Override the x264 configuration using a :-separated list of key=value
1583 parameters.
1584
1585 This option is functionally the same as the @option{x264opts}, but is
1586 duplicated for compability with the Libav fork.
1587
1588 For example to specify libx264 encoding options with @command{ffmpeg}:
1589 @example
1590 ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
1591 cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
1592 no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
1593 @end example
1594 @end table
1595
1596 Encoding ffpresets for common usages are provided so they can be used with the
1597 general presets system (e.g. passing the @option{pre} option).
1598
1599 @section libxvid
1600
1601 Xvid MPEG-4 Part 2 encoder wrapper.
1602
1603 This encoder requires the presence of the libxvidcore headers and library
1604 during configuration. You need to explicitly configure the build with
1605 @code{--enable-libxvid --enable-gpl}.
1606
1607 The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
1608 users can encode to this format without this library.
1609
1610 @subsection Options
1611
1612 The following options are supported by the libxvid wrapper. Some of
1613 the following options are listed but are not documented, and
1614 correspond to shared codec options. See @ref{codec-options,,the Codec
1615 Options chapter} for their documentation. The other shared options
1616 which are not listed have no effect for the libxvid encoder.
1617
1618 @table @option
1619 @item b
1620
1621 @item g
1622
1623 @item qmin
1624
1625 @item qmax
1626
1627 @item mpeg_quant
1628
1629 @item threads
1630
1631 @item bf
1632
1633 @item b_qfactor
1634
1635 @item b_qoffset
1636
1637 @item flags
1638 Set specific encoding flags. Possible values:
1639
1640 @table @samp
1641
1642 @item mv4
1643 Use four motion vector by macroblock.
1644
1645 @item aic
1646 Enable high quality AC prediction.
1647
1648 @item gray
1649 Only encode grayscale.
1650
1651 @item gmc
1652 Enable the use of global motion compensation (GMC).
1653
1654 @item qpel
1655 Enable quarter-pixel motion compensation.
1656
1657 @item cgop
1658 Enable closed GOP.
1659
1660 @item global_header
1661 Place global headers in extradata instead of every keyframe.
1662
1663 @end table
1664
1665 @item trellis
1666
1667 @item me_method
1668 Set motion estimation method. Possible values in decreasing order of
1669 speed and increasing order of quality:
1670
1671 @table @samp
1672 @item zero
1673 Use no motion estimation (default).
1674
1675 @item phods
1676 @item x1
1677 @item log
1678 Enable advanced diamond zonal search for 16x16 blocks and half-pixel
1679 refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
1680 @samp{phods}.
1681
1682 @item epzs
1683 Enable all of the things described above, plus advanced diamond zonal
1684 search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
1685 estimation on chroma planes.
1686
1687 @item full
1688 Enable all of the things described above, plus extended 16x16 and 8x8
1689 blocks search.
1690 @end table
1691
1692 @item mbd
1693 Set macroblock decision algorithm. Possible values in the increasing
1694 order of quality:
1695
1696 @table @samp
1697 @item simple
1698 Use macroblock comparing function algorithm (default).
1699
1700 @item bits
1701 Enable rate distortion-based half pixel and quarter pixel refinement for
1702 16x16 blocks.
1703
1704 @item rd
1705 Enable all of the things described above, plus rate distortion-based
1706 half pixel and quarter pixel refinement for 8x8 blocks, and rate
1707 distortion-based search using square pattern.
1708 @end table
1709
1710 @item lumi_aq
1711 Enable lumi masking adaptive quantization when set to 1. Default is 0
1712 (disabled).
1713
1714 @item variance_aq
1715 Enable variance adaptive quantization when set to 1. Default is 0
1716 (disabled).
1717
1718 When combined with @option{lumi_aq}, the resulting quality will not
1719 be better than any of the two specified individually. In other
1720 words, the resulting quality will be the worse one of the two
1721 effects.
1722
1723 @item ssim
1724 Set structural similarity (SSIM) displaying method. Possible values:
1725
1726 @table @samp
1727 @item off
1728 Disable displaying of SSIM information.
1729
1730 @item avg
1731 Output average SSIM at the end of encoding to stdout. The format of
1732 showing the average SSIM is:
1733
1734 @example
1735 Average SSIM: %f
1736 @end example
1737
1738 For users who are not familiar with C, %f means a float number, or
1739 a decimal (e.g. 0.939232).
1740
1741 @item frame
1742 Output both per-frame SSIM data during encoding and average SSIM at
1743 the end of encoding to stdout. The format of per-frame information
1744 is:
1745
1746 @example
1747        SSIM: avg: %1.3f min: %1.3f max: %1.3f
1748 @end example
1749
1750 For users who are not familiar with C, %1.3f means a float number
1751 rounded to 3 digits after the dot (e.g. 0.932).
1752
1753 @end table
1754
1755 @item ssim_acc
1756 Set SSIM accuracy. Valid options are integers within the range of
1757 0-4, while 0 gives the most accurate result and 4 computes the
1758 fastest.
1759
1760 @end table
1761
1762 @section png
1763
1764 PNG image encoder.
1765
1766 @subsection Private options
1767
1768 @table @option
1769 @item dpi @var{integer}
1770 Set physical density of pixels, in dots per inch, unset by default
1771 @item dpm @var{integer}
1772 Set physical density of pixels, in dots per meter, unset by default
1773 @end table
1774
1775 @section ProRes
1776
1777 Apple ProRes encoder.
1778
1779 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
1780 The used encoder can be choosen with the @code{-vcodec} option.
1781
1782 @subsection Private Options for prores-ks
1783
1784 @table @option
1785 @item profile @var{integer}
1786 Select the ProRes profile to encode
1787 @table @samp
1788 @item proxy
1789 @item lt
1790 @item standard
1791 @item hq
1792 @item 4444
1793 @end table
1794
1795 @item quant_mat @var{integer}
1796 Select quantization matrix.
1797 @table @samp
1798 @item auto
1799 @item default
1800 @item proxy
1801 @item lt
1802 @item standard
1803 @item hq
1804 @end table
1805 If set to @var{auto}, the matrix matching the profile will be picked.
1806 If not set, the matrix providing the highest quality, @var{default}, will be
1807 picked.
1808
1809 @item bits_per_mb @var{integer}
1810 How many bits to allot for coding one macroblock. Different profiles use
1811 between 200 and 2400 bits per macroblock, the maximum is 8000.
1812
1813 @item mbs_per_slice @var{integer}
1814 Number of macroblocks in each slice (1-8); the default value (8)
1815 should be good in almost all situations.
1816
1817 @item vendor @var{string}
1818 Override the 4-byte vendor ID.
1819 A custom vendor ID like @var{apl0} would claim the stream was produced by
1820 the Apple encoder.
1821
1822 @item alpha_bits @var{integer}
1823 Specify number of bits for alpha component.
1824 Possible values are @var{0}, @var{8} and @var{16}.
1825 Use @var{0} to disable alpha plane coding.
1826
1827 @end table
1828
1829 @subsection Speed considerations
1830
1831 In the default mode of operation the encoder has to honor frame constraints
1832 (i.e. not produc frames with size bigger than requested) while still making
1833 output picture as good as possible.
1834 A frame containing a lot of small details is harder to compress and the encoder
1835 would spend more time searching for appropriate quantizers for each slice.
1836
1837 Setting a higher @option{bits_per_mb} limit will improve the speed.
1838
1839 For the fastest encoding speed set the @option{qscale} parameter (4 is the
1840 recommended value) and do not set a size constraint.
1841
1842 @c man end VIDEO ENCODERS