Merge commit '799f57ac96f9891d1a0f7d6c4b218ed536e8aca5'
[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 @section ac3 and ac3_fixed
29
30 AC-3 audio encoders.
31
32 These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
33 the undocumented RealAudio 3 (a.k.a. dnet).
34
35 The @var{ac3} encoder uses floating-point math, while the @var{ac3_fixed}
36 encoder only uses fixed-point integer math. This does not mean that one is
37 always faster, just that one or the other may be better suited to a
38 particular system. The floating-point encoder will generally produce better
39 quality audio for a given bitrate. The @var{ac3_fixed} encoder is not the
40 default codec for any of the output formats, so it must be specified explicitly
41 using the option @code{-acodec ac3_fixed} in order to use it.
42
43 @subsection AC-3 Metadata
44
45 The AC-3 metadata options are used to set parameters that describe the audio,
46 but in most cases do not affect the audio encoding itself. Some of the options
47 do directly affect or influence the decoding and playback of the resulting
48 bitstream, while others are just for informational purposes. A few of the
49 options will add bits to the output stream that could otherwise be used for
50 audio data, and will thus affect the quality of the output. Those will be
51 indicated accordingly with a note in the option list below.
52
53 These parameters are described in detail in several publicly-available
54 documents.
55 @itemize
56 @item @uref{http://www.atsc.org/cms/standards/a_52-2010.pdf,A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard}
57 @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}
58 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf,Dolby Metadata Guide}
59 @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf,Dolby Digital Professional Encoding Guidelines}
60 @end itemize
61
62 @subsubsection Metadata Control Options
63
64 @table @option
65
66 @item -per_frame_metadata @var{boolean}
67 Allow Per-Frame Metadata. Specifies if the encoder should check for changing
68 metadata for each frame.
69 @table @option
70 @item 0
71 The metadata values set at initialization will be used for every frame in the
72 stream. (default)
73 @item 1
74 Metadata values can be changed before encoding each frame.
75 @end table
76
77 @end table
78
79 @subsubsection Downmix Levels
80
81 @table @option
82
83 @item -center_mixlev @var{level}
84 Center Mix Level. The amount of gain the decoder should apply to the center
85 channel when downmixing to stereo. This field will only be written to the
86 bitstream if a center channel is present. The value is specified as a scale
87 factor. There are 3 valid values:
88 @table @option
89 @item 0.707
90 Apply -3dB gain
91 @item 0.595
92 Apply -4.5dB gain (default)
93 @item 0.500
94 Apply -6dB gain
95 @end table
96
97 @item -surround_mixlev @var{level}
98 Surround Mix Level. The amount of gain the decoder should apply to the surround
99 channel(s) when downmixing to stereo. This field will only be written to the
100 bitstream if one or more surround channels are present. The value is specified
101 as a scale factor.  There are 3 valid values:
102 @table @option
103 @item 0.707
104 Apply -3dB gain
105 @item 0.500
106 Apply -6dB gain (default)
107 @item 0.000
108 Silence Surround Channel(s)
109 @end table
110
111 @end table
112
113 @subsubsection Audio Production Information
114 Audio Production Information is optional information describing the mixing
115 environment.  Either none or both of the fields are written to the bitstream.
116
117 @table @option
118
119 @item -mixing_level @var{number}
120 Mixing Level. Specifies peak sound pressure level (SPL) in the production
121 environment when the mix was mastered. Valid values are 80 to 111, or -1 for
122 unknown or not indicated. The default value is -1, but that value cannot be
123 used if the Audio Production Information is written to the bitstream. Therefore,
124 if the @code{room_type} option is not the default value, the @code{mixing_level}
125 option must not be -1.
126
127 @item -room_type @var{type}
128 Room Type. Describes the equalization used during the final mixing session at
129 the studio or on the dubbing stage. A large room is a dubbing stage with the
130 industry standard X-curve equalization; a small room has flat equalization.
131 This field will not be written to the bitstream if both the @code{mixing_level}
132 option and the @code{room_type} option have the default values.
133 @table @option
134 @item 0
135 @itemx notindicated
136 Not Indicated (default)
137 @item 1
138 @itemx large
139 Large Room
140 @item 2
141 @itemx small
142 Small Room
143 @end table
144
145 @end table
146
147 @subsubsection Other Metadata Options
148
149 @table @option
150
151 @item -copyright @var{boolean}
152 Copyright Indicator. Specifies whether a copyright exists for this audio.
153 @table @option
154 @item 0
155 @itemx off
156 No Copyright Exists (default)
157 @item 1
158 @itemx on
159 Copyright Exists
160 @end table
161
162 @item -dialnorm @var{value}
163 Dialogue Normalization. Indicates how far the average dialogue level of the
164 program is below digital 100% full scale (0 dBFS). This parameter determines a
165 level shift during audio reproduction that sets the average volume of the
166 dialogue to a preset level. The goal is to match volume level between program
167 sources. A value of -31dB will result in no volume level change, relative to
168 the source volume, during audio reproduction. Valid values are whole numbers in
169 the range -31 to -1, with -31 being the default.
170
171 @item -dsur_mode @var{mode}
172 Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
173 (Pro Logic). This field will only be written to the bitstream if the audio
174 stream is stereo. Using this option does @b{NOT} mean the encoder will actually
175 apply Dolby Surround processing.
176 @table @option
177 @item 0
178 @itemx notindicated
179 Not Indicated (default)
180 @item 1
181 @itemx off
182 Not Dolby Surround Encoded
183 @item 2
184 @itemx on
185 Dolby Surround Encoded
186 @end table
187
188 @item -original @var{boolean}
189 Original Bit Stream Indicator. Specifies whether this audio is from the
190 original source and not a copy.
191 @table @option
192 @item 0
193 @itemx off
194 Not Original Source
195 @item 1
196 @itemx on
197 Original Source (default)
198 @end table
199
200 @end table
201
202 @subsection Extended Bitstream Information
203 The extended bitstream options are part of the Alternate Bit Stream Syntax as
204 specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
205 If any one parameter in a group is specified, all values in that group will be
206 written to the bitstream.  Default values are used for those that are written
207 but have not been specified.  If the mixing levels are written, the decoder
208 will use these values instead of the ones specified in the @code{center_mixlev}
209 and @code{surround_mixlev} options if it supports the Alternate Bit Stream
210 Syntax.
211
212 @subsubsection Extended Bitstream Information - Part 1
213
214 @table @option
215
216 @item -dmix_mode @var{mode}
217 Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
218 (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
219 @table @option
220 @item 0
221 @itemx notindicated
222 Not Indicated (default)
223 @item 1
224 @itemx ltrt
225 Lt/Rt Downmix Preferred
226 @item 2
227 @itemx loro
228 Lo/Ro Downmix Preferred
229 @end table
230
231 @item -ltrt_cmixlev @var{level}
232 Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
233 center channel when downmixing to stereo in Lt/Rt mode.
234 @table @option
235 @item 1.414
236 Apply +3dB gain
237 @item 1.189
238 Apply +1.5dB gain
239 @item 1.000
240 Apply 0dB gain
241 @item 0.841
242 Apply -1.5dB gain
243 @item 0.707
244 Apply -3.0dB gain
245 @item 0.595
246 Apply -4.5dB gain (default)
247 @item 0.500
248 Apply -6.0dB gain
249 @item 0.000
250 Silence Center Channel
251 @end table
252
253 @item -ltrt_surmixlev @var{level}
254 Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
255 surround channel(s) when downmixing to stereo in Lt/Rt mode.
256 @table @option
257 @item 0.841
258 Apply -1.5dB gain
259 @item 0.707
260 Apply -3.0dB gain
261 @item 0.595
262 Apply -4.5dB gain
263 @item 0.500
264 Apply -6.0dB gain (default)
265 @item 0.000
266 Silence Surround Channel(s)
267 @end table
268
269 @item -loro_cmixlev @var{level}
270 Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
271 center channel when downmixing to stereo in Lo/Ro mode.
272 @table @option
273 @item 1.414
274 Apply +3dB gain
275 @item 1.189
276 Apply +1.5dB gain
277 @item 1.000
278 Apply 0dB gain
279 @item 0.841
280 Apply -1.5dB gain
281 @item 0.707
282 Apply -3.0dB gain
283 @item 0.595
284 Apply -4.5dB gain (default)
285 @item 0.500
286 Apply -6.0dB gain
287 @item 0.000
288 Silence Center Channel
289 @end table
290
291 @item -loro_surmixlev @var{level}
292 Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
293 surround channel(s) when downmixing to stereo in Lo/Ro mode.
294 @table @option
295 @item 0.841
296 Apply -1.5dB gain
297 @item 0.707
298 Apply -3.0dB gain
299 @item 0.595
300 Apply -4.5dB gain
301 @item 0.500
302 Apply -6.0dB gain (default)
303 @item 0.000
304 Silence Surround Channel(s)
305 @end table
306
307 @end table
308
309 @subsubsection Extended Bitstream Information - Part 2
310
311 @table @option
312
313 @item -dsurex_mode @var{mode}
314 Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
315 (7.1 matrixed to 5.1). Using this option does @b{NOT} mean the encoder will actually
316 apply Dolby Surround EX processing.
317 @table @option
318 @item 0
319 @itemx notindicated
320 Not Indicated (default)
321 @item 1
322 @itemx on
323 Dolby Surround EX Off
324 @item 2
325 @itemx off
326 Dolby Surround EX On
327 @end table
328
329 @item -dheadphone_mode @var{mode}
330 Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
331 encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
332 option does @b{NOT} mean the encoder will actually apply Dolby Headphone
333 processing.
334 @table @option
335 @item 0
336 @itemx notindicated
337 Not Indicated (default)
338 @item 1
339 @itemx on
340 Dolby Headphone Off
341 @item 2
342 @itemx off
343 Dolby Headphone On
344 @end table
345
346 @item -ad_conv_type @var{type}
347 A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
348 conversion.
349 @table @option
350 @item 0
351 @itemx standard
352 Standard A/D Converter (default)
353 @item 1
354 @itemx hdcd
355 HDCD A/D Converter
356 @end table
357
358 @end table
359
360 @subsection Other AC-3 Encoding Options
361
362 @table @option
363
364 @item -stereo_rematrixing @var{boolean}
365 Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
366 is an optional AC-3 feature that increases quality by selectively encoding
367 the left/right channels as mid/side. This option is enabled by default, and it
368 is highly recommended that it be left as enabled except for testing purposes.
369
370 @end table
371
372 @subsection Floating-Point-Only AC-3 Encoding Options
373
374 These options are only valid for the floating-point encoder and do not exist
375 for the fixed-point encoder due to the corresponding features not being
376 implemented in fixed-point.
377
378 @table @option
379
380 @item -channel_coupling @var{boolean}
381 Enables/Disables use of channel coupling, which is an optional AC-3 feature
382 that increases quality by combining high frequency information from multiple
383 channels into a single channel. The per-channel high frequency information is
384 sent with less accuracy in both the frequency and time domains. This allows
385 more bits to be used for lower frequencies while preserving enough information
386 to reconstruct the high frequencies. This option is enabled by default for the
387 floating-point encoder and should generally be left as enabled except for
388 testing purposes or to increase encoding speed.
389 @table @option
390 @item -1
391 @itemx auto
392 Selected by Encoder (default)
393 @item 0
394 @itemx off
395 Disable Channel Coupling
396 @item 1
397 @itemx on
398 Enable Channel Coupling
399 @end table
400
401 @item -cpl_start_band @var{number}
402 Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
403 value higher than the bandwidth is used, it will be reduced to 1 less than the
404 coupling end band. If @var{auto} is used, the start band will be determined by
405 the encoder based on the bit rate, sample rate, and channel layout. This option
406 has no effect if channel coupling is disabled.
407 @table @option
408 @item -1
409 @itemx auto
410 Selected by Encoder (default)
411 @end table
412
413 @end table
414
415 @section libmp3lame
416
417 LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper
418
419 Requires the presence of the libmp3lame headers and library during
420 configuration. You need to explicitly configure the build with
421 @code{--enable-libmp3lame}.
422
423 @subsection Option Mapping
424
425 The following options are supported by the libmp3lame wrapper,
426 the LAME-equivalent options follow the FFmpeg ones.
427
428 @multitable @columnfractions .2 .2
429 @item FFmpeg            @tab LAME
430 @item b                 @tab b
431 FFmpeg @code{b} option is expressed in bits/s, lame @code{bitrate}
432 in kilobits/s.
433 @item q                 @tab V
434 Quality setting for VBR.
435 @item compression_level @tab q
436 Algorithm quality. Valid options are integers from 0-9.
437 @item reservoir         @tab N.A.
438 Enable use of bit reservoir. LAME has this enabled by default.
439 @item joint_stereo      @tab -m j
440 Enables the encoder to use (on a frame by frame basis) either L/R
441 stereo or mid/side stereo.
442 @end multitable
443
444 @section libtwolame
445
446 TwoLAME MP2 encoder wrapper
447
448 Requires the presence of the libtwolame headers and library during
449 configuration. You need to explicitly configure the build with
450 @code{--enable-libtwolame}.
451
452 @subsection Options Mapping
453
454 The following options are supported by the libtwolame wrapper. The
455 TwoLAME-equivalent options follow the FFmpeg ones and are in
456 parentheses.
457
458 @table @option
459 @item b
460 (b) Set bitrate in bits/s. Note that FFmpeg @code{b} option is
461 expressed in bits/s, twolame @code{b} in kilobits/s. The default
462 value is 128k.
463
464 @item q
465 (V) Set quality for experimental VBR support. Maximum value range is
466 from -50 to 50, useful range is from -10 to 10.
467
468 @item mode
469 (mode) Set MPEG mode. Possible values:
470
471 @table @samp
472 @item auto
473 Choose mode automatically based on the input. This is the default.
474 @item stereo
475 Stereo
476 @item joint_stereo
477 Joint stereo
478 @item dual_channel
479 Dual channel
480 @item mono
481 Mono
482 @end table
483
484 @item psymodel
485 (psyc-mode) Set psychoacoustic model to use in encoding. The argument
486 must be an integer between -1 and 4, inclusive. The higher the value,
487 the better the quality. The default value is 3.
488
489 @item energy_levels
490 (energy) Enable energy levels extensions when set to 1. The default
491 value is 0 (disabled).
492
493 @item error_protection
494 (protect) Enable CRC error protection when set to 1. The default value
495 is 0 (disabled).
496
497 @item copyright
498 (copyright) Set MPEG audio copyright flag when set to 1. The default
499 value is 0 (disabled).
500
501 @item original
502 (original) Set MPEG audio original flag when set to 1. The default
503 value is 0 (disabled).
504
505 @end table
506
507 @section libvo-aacenc
508
509 VisualOn AAC encoder
510
511 Requires the presence of the libvo-aacenc headers and library during
512 configuration. You need to explicitly configure the build with
513 @code{--enable-libvo-aacenc --enable-version3}.
514
515 @subsection Options
516
517 The VisualOn AAC encoder only support encoding AAC-LC and up to 2
518 channels. It is also CBR-only. It is considered to be worse than the
519 native experimental FFmpeg AAC encoder.
520
521 @table @option
522
523 @item b
524 Bitrate.
525
526 @end table
527
528 @c man end AUDIO ENCODERS
529
530 @chapter Video Encoders
531 @c man begin VIDEO ENCODERS
532
533 A description of some of the currently available video encoders
534 follows.
535
536 @section libtheora
537
538 Theora format supported through libtheora.
539
540 Requires the presence of the libtheora headers and library during
541 configuration. You need to explicitly configure the build with
542 @code{--enable-libtheora}.
543
544 @subsection Options
545
546 The following global options are mapped to internal libtheora options
547 which affect the quality and the bitrate of the encoded stream.
548
549 @table @option
550 @item b
551 Set the video bitrate, only works if the @code{qscale} flag in
552 @option{flags} is not enabled.
553
554 @item flags
555 Used to enable constant quality mode encoding through the
556 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
557 modes.
558
559 @item g
560 Set the GOP size.
561
562 @item global_quality
563 Set the global quality in lambda units, only works if the
564 @code{qscale} flag in @option{flags} is enabled. The value is clipped
565 in the [0 - 10*@code{FF_QP2LAMBDA}] range, and then multiplied for 6.3
566 to get a value in the native libtheora range [0-63]. A higher value
567 corresponds to a higher quality.
568
569 For example, to set maximum constant quality encoding with
570 @command{ffmpeg}:
571 @example
572 ffmpeg -i INPUT -flags:v qscale -global_quality:v "10*QP2LAMBDA" -codec:v libtheora OUTPUT.ogg
573 @end example
574 @end table
575
576 @section libvpx
577
578 VP8 format supported through libvpx.
579
580 Requires the presence of the libvpx headers and library during configuration.
581 You need to explicitly configure the build with @code{--enable-libvpx}.
582
583 @subsection Options
584
585 Mapping from FFmpeg to libvpx options with conversion notes in parentheses.
586
587 @table @option
588
589 @item threads
590 g_threads
591
592 @item profile
593 g_profile
594
595 @item vb
596 rc_target_bitrate
597
598 @item g
599 kf_max_dist
600
601 @item keyint_min
602 kf_min_dist
603
604 @item qmin
605 rc_min_quantizer
606
607 @item qmax
608 rc_max_quantizer
609
610 @item bufsize, vb
611 rc_buf_sz
612 @code{(bufsize * 1000 / vb)}
613
614 rc_buf_optimal_sz
615 @code{(bufsize * 1000 / vb * 5 / 6)}
616
617 @item rc_init_occupancy, vb
618 rc_buf_initial_sz
619 @code{(rc_init_occupancy * 1000 / vb)}
620
621 @item rc_buffer_aggressivity
622 rc_undershoot_pct
623
624 @item skip_threshold
625 rc_dropframe_thresh
626
627 @item qcomp
628 rc_2pass_vbr_bias_pct
629
630 @item maxrate, vb
631 rc_2pass_vbr_maxsection_pct
632 @code{(maxrate * 100 / vb)}
633
634 @item minrate, vb
635 rc_2pass_vbr_minsection_pct
636 @code{(minrate * 100 / vb)}
637
638 @item minrate, maxrate, vb
639 @code{VPX_CBR}
640 @code{(minrate == maxrate == vb)}
641
642 @item crf
643 @code{VPX_CQ}, @code{VP8E_SET_CQ_LEVEL}
644
645 @item quality
646 @table @option
647 @item @var{best}
648 @code{VPX_DL_BEST_QUALITY}
649 @item @var{good}
650 @code{VPX_DL_GOOD_QUALITY}
651 @item @var{realtime}
652 @code{VPX_DL_REALTIME}
653 @end table
654
655 @item speed
656 @code{VP8E_SET_CPUUSED}
657
658 @item nr
659 @code{VP8E_SET_NOISE_SENSITIVITY}
660
661 @item mb_threshold
662 @code{VP8E_SET_STATIC_THRESHOLD}
663
664 @item slices
665 @code{VP8E_SET_TOKEN_PARTITIONS}
666
667 @item max-intra-rate
668 @code{VP8E_SET_MAX_INTRA_BITRATE_PCT}
669
670 @item force_key_frames
671 @code{VPX_EFLAG_FORCE_KF}
672
673 @item Alternate reference frame related
674 @table @option
675 @item vp8flags altref
676 @code{VP8E_SET_ENABLEAUTOALTREF}
677 @item @var{arnr_max_frames}
678 @code{VP8E_SET_ARNR_MAXFRAMES}
679 @item @var{arnr_type}
680 @code{VP8E_SET_ARNR_TYPE}
681 @item @var{arnr_strength}
682 @code{VP8E_SET_ARNR_STRENGTH}
683 @item @var{rc_lookahead}
684 g_lag_in_frames
685 @end table
686
687 @item vp8flags error_resilient
688 g_error_resilient
689
690 @end table
691
692 For more information about libvpx see:
693 @url{http://www.webmproject.org/}
694
695 @section libx264
696
697 x264 H.264/MPEG-4 AVC encoder wrapper
698
699 Requires the presence of the libx264 headers and library during
700 configuration. You need to explicitly configure the build with
701 @code{--enable-libx264}.
702
703 x264 supports an impressive number of features, including 8x8 and 4x4 adaptive
704 spatial transform, adaptive B-frame placement, CAVLC/CABAC entropy coding,
705 interlacing (MBAFF), lossless mode, psy optimizations for detail retention
706 (adaptive quantization, psy-RD, psy-trellis).
707
708 The FFmpeg wrapper provides a mapping for most of them using global options
709 that match those of the encoders and provides private options for the unique
710 encoder options. Additionally an expert override is provided to directly pass
711 a list of key=value tuples as accepted by x264_param_parse.
712
713 @subsection Option Mapping
714
715 The following options are supported by the x264 wrapper, the x264-equivalent
716 options follow the FFmpeg ones.
717
718 @multitable @columnfractions .2 .2
719 @item b                 @tab bitrate
720 FFmpeg @code{b} option is expressed in bits/s, x264 @code{bitrate} in kilobits/s.
721 @item bf                @tab bframes
722 Maximum number of B-frames.
723 @item g                 @tab keyint
724 Maximum GOP size.
725 @item qmin              @tab qpmin
726 @item qmax              @tab qpmax
727 @item qdiff             @tab qpstep
728 @item qblur             @tab qblur
729 @item qcomp             @tab qcomp
730 @item refs              @tab ref
731 @item sc_threshold      @tab scenecut
732 @item trellis           @tab trellis
733 @item nr                @tab nr
734 Noise reduction.
735 @item me_range          @tab merange
736 @item me_method         @tab me
737 @item subq              @tab subme
738 @item b_strategy        @tab b-adapt
739 @item keyint_min        @tab keyint-min
740 @item coder             @tab cabac
741 Set coder to @code{ac} to use CABAC.
742 @item cmp               @tab chroma-me
743 Set to @code{chroma} to use chroma motion estimation.
744 @item threads           @tab threads
745 @item thread_type       @tab sliced_threads
746 Set to @code{slice} to use sliced threading instead of frame threading.
747 @item flags -cgop       @tab open-gop
748 Set @code{-cgop} to use recovery points to close GOPs.
749 @item rc_init_occupancy @tab vbv-init
750 Initial buffer occupancy.
751 @end multitable
752
753 @subsection Private Options
754 @table @option
755 @item -preset @var{string}
756 Set the encoding preset (cf. x264 --fullhelp).
757 @item -tune @var{string}
758 Tune the encoding params (cf. x264 --fullhelp).
759 @item -profile @var{string}
760 Set profile restrictions (cf. x264 --fullhelp).
761 @item -fastfirstpass @var{integer}
762 Use fast settings when encoding first pass.
763 @item -crf @var{float}
764 Select the quality for constant quality mode.
765 @item -crf_max @var{float}
766 In CRF mode, prevents VBV from lowering quality beyond this point.
767 @item -qp @var{integer}
768 Constant quantization parameter rate control method.
769 @item -aq-mode @var{integer}
770 AQ method
771
772 Possible values:
773 @table @samp
774 @item none
775
776 @item variance
777 Variance AQ (complexity mask).
778 @item autovariance
779 Auto-variance AQ (experimental).
780 @end table
781 @item -aq-strength @var{float}
782 AQ strength, reduces blocking and blurring in flat and textured areas.
783 @item -psy @var{integer}
784 Use psychovisual optimizations.
785 @item -psy-rd @var{string}
786 Strength of psychovisual optimization, in <psy-rd>:<psy-trellis> format.
787 @item -rc-lookahead @var{integer}
788 Number of frames to look ahead for frametype and ratecontrol.
789 @item -weightb @var{integer}
790 Weighted prediction for B-frames.
791 @item -weightp @var{integer}
792 Weighted prediction analysis method.
793
794 Possible values:
795 @table @samp
796 @item none
797
798 @item simple
799
800 @item smart
801
802 @end table
803 @item -ssim @var{integer}
804 Calculate and print SSIM stats.
805 @item -intra-refresh @var{integer}
806 Use Periodic Intra Refresh instead of IDR frames.
807 @item -b-bias @var{integer}
808 Influences how often B-frames are used.
809 @item -b-pyramid @var{integer}
810 Keep some B-frames as references.
811
812 Possible values:
813 @table @samp
814 @item none
815
816 @item strict
817 Strictly hierarchical pyramid.
818 @item normal
819 Non-strict (not Blu-ray compatible).
820 @end table
821 @item -mixed-refs @var{integer}
822 One reference per partition, as opposed to one reference per macroblock.
823 @item -8x8dct @var{integer}
824 High profile 8x8 transform.
825 @item -fast-pskip @var{integer}
826 @item -aud @var{integer}
827 Use access unit delimiters.
828 @item -mbtree @var{integer}
829 Use macroblock tree ratecontrol.
830 @item -deblock @var{string}
831 Loop filter parameters, in <alpha:beta> form.
832 @item -cplxblur @var{float}
833 Reduce fluctuations in QP (before curve compression).
834 @item -partitions @var{string}
835 A comma-separated list of partitions to consider, possible values: p8x8, p4x4, b8x8, i8x8, i4x4, none, all.
836 @item -direct-pred @var{integer}
837 Direct MV prediction mode
838
839 Possible values:
840 @table @samp
841 @item none
842
843 @item spatial
844
845 @item temporal
846
847 @item auto
848
849 @end table
850 @item -slice-max-size @var{integer}
851 Limit the size of each slice in bytes.
852 @item -stats @var{string}
853 Filename for 2 pass stats.
854 @item -nal-hrd @var{integer}
855 Signal HRD information (requires vbv-bufsize; cbr not allowed in .mp4).
856
857 Possible values:
858 @table @samp
859 @item none
860
861 @item vbr
862
863 @item cbr
864
865 @end table
866
867 @item x264opts @var{options}
868 Allow to set any x264 option, see @code{x264 --fullhelp} for a list.
869
870 @var{options} is a list of @var{key}=@var{value} couples separated by
871 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
872 themselves, use "," instead. They accept it as well since long ago but this
873 is kept undocumented for some reason.
874
875 For example to specify libx264 encoding options with @command{ffmpeg}:
876 @example
877 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
878 @end example
879
880 For more information about libx264 and the supported options see:
881 @url{http://www.videolan.org/developers/x264.html}
882
883 @item -x264-params @var{string}
884 Override the x264 configuration using a :-separated list of key=value parameters.
885 @example
886 -x264-params level=30:bframes=0:weightp=0:cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:no-fast-pskip=1:subq=6:8x8dct=0:trellis=0
887 @end example
888 @end table
889
890 Encoding avpresets for common usages are provided so they can be used with the
891 general presets system (e.g. passing the @code{-pre} option).
892
893 @section png
894
895 PNG image encoder.
896
897 @subsection Private options
898
899 @table @option
900 @item dpi @var{integer}
901 Set physical density of pixels, in dots per inch, unset by default
902 @item dpm @var{integer}
903 Set physical density of pixels, in dots per meter, unset by default
904 @end table
905
906 @section ProRes
907
908 Apple ProRes encoder.
909
910 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
911 The used encoder can be choosen with the @code{-vcodec} option.
912
913 @subsection Private Options for prores-ks
914
915 @table @option
916 @item profile @var{integer}
917 Select the ProRes profile to encode
918 @table @samp
919 @item proxy
920 @item lt
921 @item standard
922 @item hq
923 @item 4444
924 @end table
925
926 @item quant_mat @var{integer}
927 Select quantization matrix.
928 @table @samp
929 @item auto
930 @item default
931 @item proxy
932 @item lt
933 @item standard
934 @item hq
935 @end table
936 If set to @var{auto}, the matrix matching the profile will be picked.
937 If not set, the matrix providing the highest quality, @var{default}, will be
938 picked.
939
940 @item bits_per_mb @var{integer}
941 How many bits to allot for coding one macroblock. Different profiles use
942 between 200 and 2400 bits per macroblock, the maximum is 8000.
943
944 @item mbs_per_slice @var{integer}
945 Number of macroblocks in each slice (1-8); the default value (8)
946 should be good in almost all situations.
947
948 @item vendor @var{string}
949 Override the 4-byte vendor ID.
950 A custom vendor ID like @var{apl0} would claim the stream was produced by
951 the Apple encoder.
952
953 @item alpha_bits @var{integer}
954 Specify number of bits for alpha component.
955 Possible values are @var{0}, @var{8} and @var{16}.
956 Use @var{0} to disable alpha plane coding.
957
958 @end table
959
960 @subsection Speed considerations
961
962 In the default mode of operation the encoder has to honor frame constraints
963 (i.e. not produc frames with size bigger than requested) while still making
964 output picture as good as possible.
965 A frame containing a lot of small details is harder to compress and the encoder
966 would spend more time searching for appropriate quantizers for each slice.
967
968 Setting a higher @option{bits_per_mb} limit will improve the speed.
969
970 For the fastest encoding speed set the @option{qscale} parameter (4 is the
971 recommended value) and do not set a size constraint.
972
973 @c man end VIDEO ENCODERS