doc/encoders: Add libvo-amrwbenc 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 @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 @section libwavpack
529
530 A wrapper providing WavPack encoding through libwavpack.
531
532 Only lossless mode using 32-bit integer samples is supported currently.
533 The @option{compression_level} option can be used to control speed vs.
534 compression tradeoff, with the values mapped to libwavpack as follows:
535
536 @table @option
537
538 @item 0
539 Fast mode - corresponding to the wavpack @option{-f} option.
540
541 @item 1
542 Normal (default) settings.
543
544 @item 2
545 High quality - corresponding to the wavpack @option{-h} option.
546
547 @item 3
548 Very high quality - corresponding to the wavpack @option{-hh} option.
549
550 @item 4-8
551 Same as 3, but with extra processing enabled - corresponding to the wavpack
552 @option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
553 @option{-x6}.
554
555 @end table
556
557 @section libvo-amrwbenc
558
559 VisualOn Adaptive Multi-Rate Wideband encoder
560
561 Requires the presence of the libvo-amrwbenc headers and library during
562 configuration. You need to explicitly configure the build with
563 @code{--enable-libvo-amrwbenc --enable-version3}.
564
565 This is a mono-only encoder. Officially it only supports 16000Hz sample
566 rate, but you can override it by setting @option{strict} to
567 @samp{unofficial} or lower.
568
569 @subsection Options
570
571 @table @option
572
573 @item b
574 Set bitrate in bits/s. Only the following bitrates are supported, otherwise
575 libavcodec will round to the nearest valid bitrate.
576
577 @table @samp
578 @item 6600
579 @item 8850
580 @item 12650
581 @item 14250
582 @item 15850
583 @item 18250
584 @item 19850
585 @item 23050
586 @item 23850
587 @end table
588
589 @item dtx
590 Allow discontinuous transmission (generate comfort noise) when set to 1. The
591 default value is 0 (disabled).
592
593 @end table
594
595 @c man end AUDIO ENCODERS
596
597 @chapter Video Encoders
598 @c man begin VIDEO ENCODERS
599
600 A description of some of the currently available video encoders
601 follows.
602
603 @section libtheora
604
605 Theora format supported through libtheora.
606
607 Requires the presence of the libtheora headers and library during
608 configuration. You need to explicitly configure the build with
609 @code{--enable-libtheora}.
610
611 @subsection Options
612
613 The following global options are mapped to internal libtheora options
614 which affect the quality and the bitrate of the encoded stream.
615
616 @table @option
617 @item b
618 Set the video bitrate, only works if the @code{qscale} flag in
619 @option{flags} is not enabled.
620
621 @item flags
622 Used to enable constant quality mode encoding through the
623 @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
624 modes.
625
626 @item g
627 Set the GOP size.
628
629 @item global_quality
630 Set the global quality in lambda units, only works if the
631 @code{qscale} flag in @option{flags} is enabled. The value is clipped
632 in the [0 - 10*@code{FF_QP2LAMBDA}] range, and then multiplied for 6.3
633 to get a value in the native libtheora range [0-63]. A higher value
634 corresponds to a higher quality.
635
636 For example, to set maximum constant quality encoding with
637 @command{ffmpeg}:
638 @example
639 ffmpeg -i INPUT -flags:v qscale -global_quality:v "10*QP2LAMBDA" -codec:v libtheora OUTPUT.ogg
640 @end example
641 @end table
642
643 @section libvpx
644
645 VP8 format supported through libvpx.
646
647 Requires the presence of the libvpx headers and library during configuration.
648 You need to explicitly configure the build with @code{--enable-libvpx}.
649
650 @subsection Options
651
652 Mapping from FFmpeg to libvpx options with conversion notes in parentheses.
653
654 @table @option
655
656 @item threads
657 g_threads
658
659 @item profile
660 g_profile
661
662 @item vb
663 rc_target_bitrate
664
665 @item g
666 kf_max_dist
667
668 @item keyint_min
669 kf_min_dist
670
671 @item qmin
672 rc_min_quantizer
673
674 @item qmax
675 rc_max_quantizer
676
677 @item bufsize, vb
678 rc_buf_sz
679 @code{(bufsize * 1000 / vb)}
680
681 rc_buf_optimal_sz
682 @code{(bufsize * 1000 / vb * 5 / 6)}
683
684 @item rc_init_occupancy, vb
685 rc_buf_initial_sz
686 @code{(rc_init_occupancy * 1000 / vb)}
687
688 @item rc_buffer_aggressivity
689 rc_undershoot_pct
690
691 @item skip_threshold
692 rc_dropframe_thresh
693
694 @item qcomp
695 rc_2pass_vbr_bias_pct
696
697 @item maxrate, vb
698 rc_2pass_vbr_maxsection_pct
699 @code{(maxrate * 100 / vb)}
700
701 @item minrate, vb
702 rc_2pass_vbr_minsection_pct
703 @code{(minrate * 100 / vb)}
704
705 @item minrate, maxrate, vb
706 @code{VPX_CBR}
707 @code{(minrate == maxrate == vb)}
708
709 @item crf
710 @code{VPX_CQ}, @code{VP8E_SET_CQ_LEVEL}
711
712 @item quality
713 @table @option
714 @item @var{best}
715 @code{VPX_DL_BEST_QUALITY}
716 @item @var{good}
717 @code{VPX_DL_GOOD_QUALITY}
718 @item @var{realtime}
719 @code{VPX_DL_REALTIME}
720 @end table
721
722 @item speed
723 @code{VP8E_SET_CPUUSED}
724
725 @item nr
726 @code{VP8E_SET_NOISE_SENSITIVITY}
727
728 @item mb_threshold
729 @code{VP8E_SET_STATIC_THRESHOLD}
730
731 @item slices
732 @code{VP8E_SET_TOKEN_PARTITIONS}
733
734 @item max-intra-rate
735 @code{VP8E_SET_MAX_INTRA_BITRATE_PCT}
736
737 @item force_key_frames
738 @code{VPX_EFLAG_FORCE_KF}
739
740 @item Alternate reference frame related
741 @table @option
742 @item vp8flags altref
743 @code{VP8E_SET_ENABLEAUTOALTREF}
744 @item @var{arnr_max_frames}
745 @code{VP8E_SET_ARNR_MAXFRAMES}
746 @item @var{arnr_type}
747 @code{VP8E_SET_ARNR_TYPE}
748 @item @var{arnr_strength}
749 @code{VP8E_SET_ARNR_STRENGTH}
750 @item @var{rc_lookahead}
751 g_lag_in_frames
752 @end table
753
754 @item vp8flags error_resilient
755 g_error_resilient
756
757 @end table
758
759 For more information about libvpx see:
760 @url{http://www.webmproject.org/}
761
762 @section libx264
763
764 x264 H.264/MPEG-4 AVC encoder wrapper
765
766 Requires the presence of the libx264 headers and library during
767 configuration. You need to explicitly configure the build with
768 @code{--enable-libx264}.
769
770 x264 supports an impressive number of features, including 8x8 and 4x4 adaptive
771 spatial transform, adaptive B-frame placement, CAVLC/CABAC entropy coding,
772 interlacing (MBAFF), lossless mode, psy optimizations for detail retention
773 (adaptive quantization, psy-RD, psy-trellis).
774
775 The FFmpeg wrapper provides a mapping for most of them using global options
776 that match those of the encoders and provides private options for the unique
777 encoder options. Additionally an expert override is provided to directly pass
778 a list of key=value tuples as accepted by x264_param_parse.
779
780 @subsection Option Mapping
781
782 The following options are supported by the x264 wrapper, the x264-equivalent
783 options follow the FFmpeg ones.
784
785 @multitable @columnfractions .2 .2
786 @item b                 @tab bitrate
787 FFmpeg @code{b} option is expressed in bits/s, x264 @code{bitrate} in kilobits/s.
788 @item bf                @tab bframes
789 Maximum number of B-frames.
790 @item g                 @tab keyint
791 Maximum GOP size.
792 @item qmin              @tab qpmin
793 @item qmax              @tab qpmax
794 @item qdiff             @tab qpstep
795 @item qblur             @tab qblur
796 @item qcomp             @tab qcomp
797 @item refs              @tab ref
798 @item sc_threshold      @tab scenecut
799 @item trellis           @tab trellis
800 @item nr                @tab nr
801 Noise reduction.
802 @item me_range          @tab merange
803 @item me_method         @tab me
804 @item subq              @tab subme
805 @item b_strategy        @tab b-adapt
806 @item keyint_min        @tab keyint-min
807 @item coder             @tab cabac
808 Set coder to @code{ac} to use CABAC.
809 @item cmp               @tab chroma-me
810 Set to @code{chroma} to use chroma motion estimation.
811 @item threads           @tab threads
812 @item thread_type       @tab sliced_threads
813 Set to @code{slice} to use sliced threading instead of frame threading.
814 @item flags -cgop       @tab open-gop
815 Set @code{-cgop} to use recovery points to close GOPs.
816 @item rc_init_occupancy @tab vbv-init
817 Initial buffer occupancy.
818 @end multitable
819
820 @subsection Private Options
821 @table @option
822 @item -preset @var{string}
823 Set the encoding preset (cf. x264 --fullhelp).
824 @item -tune @var{string}
825 Tune the encoding params (cf. x264 --fullhelp).
826 @item -profile @var{string}
827 Set profile restrictions (cf. x264 --fullhelp).
828 @item -fastfirstpass @var{integer}
829 Use fast settings when encoding first pass.
830 @item -crf @var{float}
831 Select the quality for constant quality mode.
832 @item -crf_max @var{float}
833 In CRF mode, prevents VBV from lowering quality beyond this point.
834 @item -qp @var{integer}
835 Constant quantization parameter rate control method.
836 @item -aq-mode @var{integer}
837 AQ method
838
839 Possible values:
840 @table @samp
841 @item none
842
843 @item variance
844 Variance AQ (complexity mask).
845 @item autovariance
846 Auto-variance AQ (experimental).
847 @end table
848 @item -aq-strength @var{float}
849 AQ strength, reduces blocking and blurring in flat and textured areas.
850 @item -psy @var{integer}
851 Use psychovisual optimizations.
852 @item -psy-rd @var{string}
853 Strength of psychovisual optimization, in <psy-rd>:<psy-trellis> format.
854 @item -rc-lookahead @var{integer}
855 Number of frames to look ahead for frametype and ratecontrol.
856 @item -weightb @var{integer}
857 Weighted prediction for B-frames.
858 @item -weightp @var{integer}
859 Weighted prediction analysis method.
860
861 Possible values:
862 @table @samp
863 @item none
864
865 @item simple
866
867 @item smart
868
869 @end table
870 @item -ssim @var{integer}
871 Calculate and print SSIM stats.
872 @item -intra-refresh @var{integer}
873 Use Periodic Intra Refresh instead of IDR frames.
874 @item -b-bias @var{integer}
875 Influences how often B-frames are used.
876 @item -b-pyramid @var{integer}
877 Keep some B-frames as references.
878
879 Possible values:
880 @table @samp
881 @item none
882
883 @item strict
884 Strictly hierarchical pyramid.
885 @item normal
886 Non-strict (not Blu-ray compatible).
887 @end table
888 @item -mixed-refs @var{integer}
889 One reference per partition, as opposed to one reference per macroblock.
890 @item -8x8dct @var{integer}
891 High profile 8x8 transform.
892 @item -fast-pskip @var{integer}
893 @item -aud @var{integer}
894 Use access unit delimiters.
895 @item -mbtree @var{integer}
896 Use macroblock tree ratecontrol.
897 @item -deblock @var{string}
898 Loop filter parameters, in <alpha:beta> form.
899 @item -cplxblur @var{float}
900 Reduce fluctuations in QP (before curve compression).
901 @item -partitions @var{string}
902 A comma-separated list of partitions to consider, possible values: p8x8, p4x4, b8x8, i8x8, i4x4, none, all.
903 @item -direct-pred @var{integer}
904 Direct MV prediction mode
905
906 Possible values:
907 @table @samp
908 @item none
909
910 @item spatial
911
912 @item temporal
913
914 @item auto
915
916 @end table
917 @item -slice-max-size @var{integer}
918 Limit the size of each slice in bytes.
919 @item -stats @var{string}
920 Filename for 2 pass stats.
921 @item -nal-hrd @var{integer}
922 Signal HRD information (requires vbv-bufsize; cbr not allowed in .mp4).
923
924 Possible values:
925 @table @samp
926 @item none
927
928 @item vbr
929
930 @item cbr
931
932 @end table
933
934 @item x264opts @var{options}
935 Allow to set any x264 option, see @code{x264 --fullhelp} for a list.
936
937 @var{options} is a list of @var{key}=@var{value} couples separated by
938 ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
939 themselves, use "," instead. They accept it as well since long ago but this
940 is kept undocumented for some reason.
941
942 For example to specify libx264 encoding options with @command{ffmpeg}:
943 @example
944 ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
945 @end example
946
947 For more information about libx264 and the supported options see:
948 @url{http://www.videolan.org/developers/x264.html}
949
950 @item -x264-params @var{string}
951 Override the x264 configuration using a :-separated list of key=value parameters.
952 @example
953 -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
954 @end example
955 @end table
956
957 Encoding avpresets for common usages are provided so they can be used with the
958 general presets system (e.g. passing the @code{-pre} option).
959
960 @section png
961
962 PNG image encoder.
963
964 @subsection Private options
965
966 @table @option
967 @item dpi @var{integer}
968 Set physical density of pixels, in dots per inch, unset by default
969 @item dpm @var{integer}
970 Set physical density of pixels, in dots per meter, unset by default
971 @end table
972
973 @section ProRes
974
975 Apple ProRes encoder.
976
977 FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
978 The used encoder can be choosen with the @code{-vcodec} option.
979
980 @subsection Private Options for prores-ks
981
982 @table @option
983 @item profile @var{integer}
984 Select the ProRes profile to encode
985 @table @samp
986 @item proxy
987 @item lt
988 @item standard
989 @item hq
990 @item 4444
991 @end table
992
993 @item quant_mat @var{integer}
994 Select quantization matrix.
995 @table @samp
996 @item auto
997 @item default
998 @item proxy
999 @item lt
1000 @item standard
1001 @item hq
1002 @end table
1003 If set to @var{auto}, the matrix matching the profile will be picked.
1004 If not set, the matrix providing the highest quality, @var{default}, will be
1005 picked.
1006
1007 @item bits_per_mb @var{integer}
1008 How many bits to allot for coding one macroblock. Different profiles use
1009 between 200 and 2400 bits per macroblock, the maximum is 8000.
1010
1011 @item mbs_per_slice @var{integer}
1012 Number of macroblocks in each slice (1-8); the default value (8)
1013 should be good in almost all situations.
1014
1015 @item vendor @var{string}
1016 Override the 4-byte vendor ID.
1017 A custom vendor ID like @var{apl0} would claim the stream was produced by
1018 the Apple encoder.
1019
1020 @item alpha_bits @var{integer}
1021 Specify number of bits for alpha component.
1022 Possible values are @var{0}, @var{8} and @var{16}.
1023 Use @var{0} to disable alpha plane coding.
1024
1025 @end table
1026
1027 @subsection Speed considerations
1028
1029 In the default mode of operation the encoder has to honor frame constraints
1030 (i.e. not produc frames with size bigger than requested) while still making
1031 output picture as good as possible.
1032 A frame containing a lot of small details is harder to compress and the encoder
1033 would spend more time searching for appropriate quantizers for each slice.
1034
1035 Setting a higher @option{bits_per_mb} limit will improve the speed.
1036
1037 For the fastest encoding speed set the @option{qscale} parameter (4 is the
1038 recommended value) and do not set a size constraint.
1039
1040 @c man end VIDEO ENCODERS