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