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