3 @c man begin CODEC OPTIONS
5 libavcodec provides some generic global options, which can be set on
6 all the encoders and decoders. In addition each codec may support
7 so-called private options, which are specific for a given codec.
9 Sometimes, a global option may only affect a specific kind of codec,
10 and may be unsensical or ignored by another, so you need to be aware
11 of the meaning of the specified options. Also some options are
12 meant only for decoding or encoding.
14 Options may be set by specifying -@var{option} @var{value} in the
15 FFmpeg tools, or by setting the value explicitly in the
16 @code{AVCodecContext} options or using the @file{libavutil/opt.h} API
19 The list of supported options follow:
22 @item b @var{integer} (@emph{encoding,audio,video})
23 Set bitrate in bits/s. Default value is 200K.
25 @item ab @var{integer} (@emph{encoding,audio})
26 Set audio bitrate (in bits/s). Default value is 128K.
28 @item bt @var{integer} (@emph{encoding,video})
29 Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate
30 tolerance specifies how far ratecontrol is willing to deviate from the
31 target average bitrate value. This is not related to min/max
32 bitrate. Lowering tolerance too much has an adverse effect on quality.
34 @item flags @var{flags} (@emph{decoding/encoding,audio,video,subtitles})
40 Use four motion vector by macroblock (mpeg4).
42 Use 1/4 pel motion compensation.
50 Always try a mb with mv=<0,0>.
54 Use internal 2pass ratecontrol in first pass mode.
56 Use internal 2pass ratecontrol in second pass mode.
58 Only decode/encode grayscale.
62 Set error[?] variables during encoding.
66 Normalize adaptive quantization.
72 Place global headers in extradata instead of every keyframe.
74 Use only bitexact stuff (except (I)DCT).
76 Apply H263 advanced intra coding / mpeg4 ac prediction.
78 Deprecated, use mpegvideo private options instead.
80 Deprecated, use mpegvideo private options instead.
82 Apply interlaced motion estimation.
87 @item me_method @var{integer} (@emph{encoding,video})
88 Set motion estimation method.
93 zero motion estimation (fastest)
95 full motion estimation (slowest)
97 EPZS motion estimation (default)
99 esa motion estimation (alias for full)
101 tesa motion estimation
103 dia motion estimation (alias for epzs)
105 log motion estimation
107 phods motion estimation
111 hex motion estimation
113 umh motion estimation
115 iter motion estimation
118 @item extradata_size @var{integer}
121 @item time_base @var{rational number}
124 It is the fundamental unit of time (in seconds) in terms of which
125 frame timestamps are represented. For fixed-fps content, timebase
126 should be @code{1 / frame_rate} and timestamp increments should be
129 @item g @var{integer} (@emph{encoding,video})
130 Set the group of picture size. Default value is 12.
132 @item ar @var{integer} (@emph{decoding/encoding,audio})
133 Set audio sampling rate (in Hz).
135 @item ac @var{integer} (@emph{decoding/encoding,audio})
136 Set number of audio channels.
138 @item cutoff @var{integer} (@emph{encoding,audio})
139 Set cutoff bandwidth.
141 @item frame_size @var{integer} (@emph{encoding,audio})
142 Set audio frame size.
144 Each submitted frame except the last must contain exactly frame_size
145 samples per channel. May be 0 when the codec has
146 CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not
147 restricted. It is set by some decoders to indicate constant frame
150 @item frame_number @var{integer}
151 Set the frame number.
153 @item delay @var{integer}
155 @item qcomp @var{float} (@emph{encoding,video})
156 Set video quantizer scale compression (VBR). It is used as a constant
157 in the ratecontrol equation. Recommended range for default rc_eq:
160 @item qblur @var{float} (@emph{encoding,video})
161 Set video quantizer scale blur (VBR).
163 @item qmin @var{integer} (@emph{encoding,video})
164 Set min video quantizer scale (VBR). Must be included between -1 and
165 69, default value is 2.
167 @item qmax @var{integer} (@emph{encoding,video})
168 Set max video quantizer scale (VBR). Must be included between -1 and
169 1024, default value is 31.
171 @item qdiff @var{integer} (@emph{encoding,video})
172 Set max difference between the quantizer scale (VBR).
174 @item bf @var{integer} (@emph{encoding,video})
175 Set max number of B frames between non-B-frames.
177 Must be an integer between -1 and 16. 0 means that B-frames are
178 disabled. If a value of -1 is used, it will choose an automatic value
179 depending on the encoder.
183 @item b_qfactor @var{float} (@emph{encoding,video})
184 Set qp factor between P and B frames.
186 @item rc_strategy @var{integer} (@emph{encoding,video})
187 Set ratecontrol method.
189 @item b_strategy @var{integer} (@emph{encoding,video})
190 Set strategy to choose between I/P/B-frames.
192 @item ps @var{integer} (@emph{encoding,video})
193 Set RTP payload size in bytes.
195 @item mv_bits @var{integer}
196 @item header_bits @var{integer}
197 @item i_tex_bits @var{integer}
198 @item p_tex_bits @var{integer}
199 @item i_count @var{integer}
200 @item p_count @var{integer}
201 @item skip_count @var{integer}
202 @item misc_bits @var{integer}
203 @item frame_bits @var{integer}
204 @item codec_tag @var{integer}
205 @item bug @var{flags} (@emph{decoding,video})
206 Workaround not auto detected encoder bugs.
213 some old lavc generated msmpeg4v3 files (no autodetection)
215 Xvid interlacing bug (autodetected if fourcc==XVIX)
217 (autodetected if fourcc==UMP4)
219 padding bug (autodetected)
223 illegal vlc bug (autodetected per fourcc)
227 old standard qpel (autodetected per fourcc/version)
230 @item direct_blocksize
231 direct-qpel-blocksize bug (autodetected per fourcc/version)
233 edge padding bug (autodetected per fourcc/version)
239 Workaround various bugs in microsoft broken decoders.
244 @item lelim @var{integer} (@emph{encoding,video})
245 Set single coefficient elimination threshold for luminance (negative
246 values also consider DC coefficient).
248 @item celim @var{integer} (@emph{encoding,video})
249 Set single coefficient elimination threshold for chrominance (negative
250 values also consider dc coefficient)
252 @item strict @var{integer} (@emph{decoding/encoding,audio,video})
253 Specify how strictly to follow the standards.
258 strictly conform to a older more strict version of the spec or reference software
260 strictly conform to all the things in the spec no matter what consequences
264 allow unofficial extensions
266 allow non standardized experimental things, experimental
267 (unfinished/work in progress/not well tested) decoders and encoders.
268 Note: experimental decoders can pose a security risk, do not use this for
269 decoding untrusted input.
272 @item b_qoffset @var{float} (@emph{encoding,video})
273 Set QP offset between P and B frames.
275 @item err_detect @var{flags} (@emph{decoding,audio,video})
276 Set error detection flags.
283 detect bitstream specification deviations
285 detect improper bitstream length
287 abort decoding on minor error detection
289 ignore decoding errors, and continue decoding.
290 This is useful if you want to analyze the content of a video and thus want
291 everything to be decoded no matter what. This option will not result in a video
292 that is pleasing to watch in case of errors.
294 consider things that violate the spec and have not been seen in the wild as errors
296 consider all spec non compliancies as errors
298 consider things that a sane encoder should not do as an error
301 @item has_b_frames @var{integer}
303 @item block_align @var{integer}
305 @item mpeg_quant @var{integer} (@emph{encoding,video})
306 Use MPEG quantizers instead of H.263.
308 @item qsquish @var{float} (@emph{encoding,video})
309 How to keep quantizer between qmin and qmax (0 = clip, 1 = use
310 differentiable function).
312 @item rc_qmod_amp @var{float} (@emph{encoding,video})
313 Set experimental quantizer modulation.
315 @item rc_qmod_freq @var{integer} (@emph{encoding,video})
316 Set experimental quantizer modulation.
318 @item rc_override_count @var{integer}
320 @item rc_eq @var{string} (@emph{encoding,video})
321 Set rate control equation. When computing the expression, besides the
322 standard functions defined in the section 'Expression Evaluation', the
323 following functions are available: bits2qp(bits), qp2bits(qp). Also
324 the following constants are available: iTex pTex tex mv fCode iCount
325 mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex
328 @item maxrate @var{integer} (@emph{encoding,audio,video})
329 Set max bitrate tolerance (in bits/s). Requires bufsize to be set.
331 @item minrate @var{integer} (@emph{encoding,audio,video})
332 Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR
333 encode. It is of little use elsewise.
335 @item bufsize @var{integer} (@emph{encoding,audio,video})
336 Set ratecontrol buffer size (in bits).
338 @item rc_buf_aggressivity @var{float} (@emph{encoding,video})
341 @item i_qfactor @var{float} (@emph{encoding,video})
342 Set QP factor between P and I frames.
344 @item i_qoffset @var{float} (@emph{encoding,video})
345 Set QP offset between P and I frames.
347 @item rc_init_cplx @var{float} (@emph{encoding,video})
348 Set initial complexity for 1-pass encoding.
350 @item dct @var{integer} (@emph{encoding,video})
356 autoselect a good one (default)
366 floating point AAN DCT
369 @item lumi_mask @var{float} (@emph{encoding,video})
370 Compress bright areas stronger than medium ones.
372 @item tcplx_mask @var{float} (@emph{encoding,video})
373 Set temporal complexity masking.
375 @item scplx_mask @var{float} (@emph{encoding,video})
376 Set spatial complexity masking.
378 @item p_mask @var{float} (@emph{encoding,video})
381 @item dark_mask @var{float} (@emph{encoding,video})
382 Compress dark areas stronger than medium ones.
384 @item idct @var{integer} (@emph{decoding/encoding,video})
385 Select IDCT implementation.
398 Automatically pick a IDCT compatible with the simple one
421 floating point AAN IDCT
424 @item slice_count @var{integer}
426 @item ec @var{flags} (@emph{decoding,video})
427 Set error concealment strategy.
432 iterative motion vector (MV) search (slow)
434 use strong deblock filter for damaged MBs
436 favor predicting from the previous frame instead of the current
439 @item bits_per_coded_sample @var{integer}
441 @item pred @var{integer} (@emph{encoding,video})
442 Set prediction method.
454 @item aspect @var{rational number} (@emph{encoding,video})
455 Set sample aspect ratio.
457 @item debug @var{flags} (@emph{decoding/encoding,audio,video,subtitles})
458 Print specific debug info.
471 per-block quantization parameter (QP)
485 memory management control operations (H.264)
489 visualize quantization parameter (QP), lower QP are tinted greener
491 visualize block types
493 picture buffer allocations
498 @item vismv @var{integer} (@emph{decoding,video})
499 Visualize motion vectors (MVs).
501 This option is deprecated, see the codecview filter instead.
506 forward predicted MVs of P-frames
508 forward predicted MVs of B-frames
510 backward predicted MVs of B-frames
513 @item cmp @var{integer} (@emph{encoding,video})
514 Set full pel me compare function.
519 sum of absolute differences, fast (default)
521 sum of squared errors
523 sum of absolute Hadamard transformed differences
525 sum of absolute DCT transformed differences
527 sum of squared quantization errors (avoid, low quality)
529 number of bits needed for the block
531 rate distortion optimal, slow
535 sum of absolute vertical differences
537 sum of squared vertical differences
539 noise preserving sum of squared differences
541 5/3 wavelet, only used in snow
543 9/7 wavelet, only used in snow
550 @item subcmp @var{integer} (@emph{encoding,video})
551 Set sub pel me compare function.
556 sum of absolute differences, fast (default)
558 sum of squared errors
560 sum of absolute Hadamard transformed differences
562 sum of absolute DCT transformed differences
564 sum of squared quantization errors (avoid, low quality)
566 number of bits needed for the block
568 rate distortion optimal, slow
572 sum of absolute vertical differences
574 sum of squared vertical differences
576 noise preserving sum of squared differences
578 5/3 wavelet, only used in snow
580 9/7 wavelet, only used in snow
587 @item mbcmp @var{integer} (@emph{encoding,video})
588 Set macroblock compare function.
593 sum of absolute differences, fast (default)
595 sum of squared errors
597 sum of absolute Hadamard transformed differences
599 sum of absolute DCT transformed differences
601 sum of squared quantization errors (avoid, low quality)
603 number of bits needed for the block
605 rate distortion optimal, slow
609 sum of absolute vertical differences
611 sum of squared vertical differences
613 noise preserving sum of squared differences
615 5/3 wavelet, only used in snow
617 9/7 wavelet, only used in snow
624 @item ildctcmp @var{integer} (@emph{encoding,video})
625 Set interlaced dct compare function.
630 sum of absolute differences, fast (default)
632 sum of squared errors
634 sum of absolute Hadamard transformed differences
636 sum of absolute DCT transformed differences
638 sum of squared quantization errors (avoid, low quality)
640 number of bits needed for the block
642 rate distortion optimal, slow
646 sum of absolute vertical differences
648 sum of squared vertical differences
650 noise preserving sum of squared differences
652 5/3 wavelet, only used in snow
654 9/7 wavelet, only used in snow
661 @item dia_size @var{integer} (@emph{encoding,video})
662 Set diamond type & size for motion estimation.
664 @item last_pred @var{integer} (@emph{encoding,video})
665 Set amount of motion predictors from the previous frame.
667 @item preme @var{integer} (@emph{encoding,video})
668 Set pre motion estimation.
670 @item precmp @var{integer} (@emph{encoding,video})
671 Set pre motion estimation compare function.
676 sum of absolute differences, fast (default)
678 sum of squared errors
680 sum of absolute Hadamard transformed differences
682 sum of absolute DCT transformed differences
684 sum of squared quantization errors (avoid, low quality)
686 number of bits needed for the block
688 rate distortion optimal, slow
692 sum of absolute vertical differences
694 sum of squared vertical differences
696 noise preserving sum of squared differences
698 5/3 wavelet, only used in snow
700 9/7 wavelet, only used in snow
707 @item pre_dia_size @var{integer} (@emph{encoding,video})
708 Set diamond type & size for motion estimation pre-pass.
710 @item subq @var{integer} (@emph{encoding,video})
711 Set sub pel motion estimation quality.
713 @item dtg_active_format @var{integer}
715 @item me_range @var{integer} (@emph{encoding,video})
716 Set limit motion vectors range (1023 for DivX player).
718 @item ibias @var{integer} (@emph{encoding,video})
719 Set intra quant bias.
721 @item pbias @var{integer} (@emph{encoding,video})
722 Set inter quant bias.
724 @item color_table_id @var{integer}
726 @item global_quality @var{integer} (@emph{encoding,audio,video})
728 @item coder @var{integer} (@emph{encoding,video})
733 variable length coder / huffman coder
744 @item context @var{integer} (@emph{encoding,video})
747 @item slice_flags @var{integer}
749 @item xvmc_acceleration @var{integer}
751 @item mbd @var{integer} (@emph{encoding,video})
752 Set macroblock decision algorithm (high quality mode).
761 use best rate distortion
764 @item stream_codec_tag @var{integer}
766 @item sc_threshold @var{integer} (@emph{encoding,video})
767 Set scene change threshold.
769 @item lmin @var{integer} (@emph{encoding,video})
770 Set min lagrange factor (VBR).
772 @item lmax @var{integer} (@emph{encoding,video})
773 Set max lagrange factor (VBR).
775 @item nr @var{integer} (@emph{encoding,video})
778 @item rc_init_occupancy @var{integer} (@emph{encoding,video})
779 Set number of bits which should be loaded into the rc buffer before
782 @item flags2 @var{flags} (@emph{decoding/encoding,audio,video})
787 Allow non spec compliant speedup tricks.
789 Deprecated, use mpegvideo private options instead.
791 Skip bitstream encoding.
793 Ignore cropping information from sps.
795 Place global headers at every keyframe instead of in extradata.
797 Frame data might be split into multiple chunks.
799 Show all frames before the first keyframe.
801 Deprecated, use mpegvideo private options instead.
803 Export motion vectors into frame side-data (see @code{AV_FRAME_DATA_MOTION_VECTORS})
804 for codecs that support it. See also @file{doc/examples/export_mvs.c}.
807 @item error @var{integer} (@emph{encoding,video})
809 @item qns @var{integer} (@emph{encoding,video})
810 Deprecated, use mpegvideo private options instead.
812 @item threads @var{integer} (@emph{decoding/encoding,video})
817 detect a good number of threads
820 @item me_threshold @var{integer} (@emph{encoding,video})
821 Set motion estimation threshold.
823 @item mb_threshold @var{integer} (@emph{encoding,video})
824 Set macroblock threshold.
826 @item dc @var{integer} (@emph{encoding,video})
827 Set intra_dc_precision.
829 @item nssew @var{integer} (@emph{encoding,video})
832 @item skip_top @var{integer} (@emph{decoding,video})
833 Set number of macroblock rows at the top which are skipped.
835 @item skip_bottom @var{integer} (@emph{decoding,video})
836 Set number of macroblock rows at the bottom which are skipped.
838 @item profile @var{integer} (@emph{encoding,audio,video})
876 @item level @var{integer} (@emph{encoding,audio,video})
884 @item lowres @var{integer} (@emph{decoding,audio,video})
885 Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions.
887 @item skip_threshold @var{integer} (@emph{encoding,video})
888 Set frame skip threshold.
890 @item skip_factor @var{integer} (@emph{encoding,video})
891 Set frame skip factor.
893 @item skip_exp @var{integer} (@emph{encoding,video})
894 Set frame skip exponent.
895 Negative values behave identical to the corresponding positive ones, except
896 that the score is normalized.
897 Positive values exist primarily for compatibility reasons and are not so useful.
899 @item skipcmp @var{integer} (@emph{encoding,video})
900 Set frame skip compare function.
905 sum of absolute differences, fast (default)
907 sum of squared errors
909 sum of absolute Hadamard transformed differences
911 sum of absolute DCT transformed differences
913 sum of squared quantization errors (avoid, low quality)
915 number of bits needed for the block
917 rate distortion optimal, slow
921 sum of absolute vertical differences
923 sum of squared vertical differences
925 noise preserving sum of squared differences
927 5/3 wavelet, only used in snow
929 9/7 wavelet, only used in snow
936 @item border_mask @var{float} (@emph{encoding,video})
937 Increase the quantizer for macroblocks close to borders.
939 @item mblmin @var{integer} (@emph{encoding,video})
940 Set min macroblock lagrange factor (VBR).
942 @item mblmax @var{integer} (@emph{encoding,video})
943 Set max macroblock lagrange factor (VBR).
945 @item mepc @var{integer} (@emph{encoding,video})
946 Set motion estimation bitrate penalty compensation (1.0 = 256).
948 @item skip_loop_filter @var{integer} (@emph{decoding,video})
949 @item skip_idct @var{integer} (@emph{decoding,video})
950 @item skip_frame @var{integer} (@emph{decoding,video})
952 Make decoder discard processing depending on the frame type selected
955 @option{skip_loop_filter} skips frame loop filtering, @option{skip_idct}
956 skips frame IDCT/dequantization, @option{skip_frame} skips decoding.
964 Discard useless frames like 0-sized frames.
967 Discard all non-reference frames.
970 Discard all bidirectional frames.
973 Discard all frames excepts keyframes.
979 Default value is @samp{default}.
981 @item bidir_refine @var{integer} (@emph{encoding,video})
982 Refine the two motion vectors used in bidirectional macroblocks.
984 @item brd_scale @var{integer} (@emph{encoding,video})
985 Downscale frames for dynamic B-frame decision.
987 @item keyint_min @var{integer} (@emph{encoding,video})
988 Set minimum interval between IDR-frames.
990 @item refs @var{integer} (@emph{encoding,video})
991 Set reference frames to consider for motion compensation.
993 @item chromaoffset @var{integer} (@emph{encoding,video})
994 Set chroma qp offset from luma.
996 @item trellis @var{integer} (@emph{encoding,audio,video})
997 Set rate-distortion optimal quantization.
999 @item sc_factor @var{integer} (@emph{encoding,video})
1000 Set value multiplied by qscale for each frame and added to
1003 @item mv0_threshold @var{integer} (@emph{encoding,video})
1004 @item b_sensitivity @var{integer} (@emph{encoding,video})
1005 Adjust sensitivity of b_frame_strategy 1.
1007 @item compression_level @var{integer} (@emph{encoding,audio,video})
1008 @item min_prediction_order @var{integer} (@emph{encoding,audio})
1009 @item max_prediction_order @var{integer} (@emph{encoding,audio})
1010 @item timecode_frame_start @var{integer} (@emph{encoding,video})
1011 Set GOP timecode frame start number, in non drop frame format.
1013 @item request_channels @var{integer} (@emph{decoding,audio})
1014 Set desired number of audio channels.
1016 @item bits_per_raw_sample @var{integer}
1017 @item channel_layout @var{integer} (@emph{decoding/encoding,audio})
1022 @item request_channel_layout @var{integer} (@emph{decoding,audio})
1027 @item rc_max_vbv_use @var{float} (@emph{encoding,video})
1028 @item rc_min_vbv_use @var{float} (@emph{encoding,video})
1029 @item ticks_per_frame @var{integer} (@emph{decoding/encoding,audio,video})
1030 @item color_primaries @var{integer} (@emph{decoding/encoding,video})
1031 @item color_trc @var{integer} (@emph{decoding/encoding,video})
1032 @item colorspace @var{integer} (@emph{decoding/encoding,video})
1033 @item color_range @var{integer} (@emph{decoding/encoding,video})
1034 @item chroma_sample_location @var{integer} (@emph{decoding/encoding,video})
1036 @item log_level_offset @var{integer}
1037 Set the log level offset.
1039 @item slices @var{integer} (@emph{encoding,video})
1040 Number of slices, used in parallelized encoding.
1042 @item thread_type @var{flags} (@emph{decoding/encoding,video})
1043 Select which multithreading methods to use.
1045 Use of @samp{frame} will increase decoding delay by one frame per
1046 thread, so clients which cannot provide future frames should not use
1052 Decode more than one part of a single frame at once.
1054 Multithreading using slices works only when the video was encoded with
1058 Decode more than one frame at once.
1061 Default value is @samp{slice+frame}.
1063 @item audio_service_type @var{integer} (@emph{encoding,audio})
1064 Set audio service type.
1088 @item request_sample_fmt @var{sample_fmt} (@emph{decoding,audio})
1089 Set sample format audio decoders should prefer. Default value is
1092 @item pkt_timebase @var{rational number}
1094 @item sub_charenc @var{encoding} (@emph{decoding,subtitles})
1095 Set the input subtitles character encoding.
1097 @item field_order @var{field_order} (@emph{video})
1098 Set/override the field order of the video.
1104 Interlaced video, top field coded and displayed first
1106 Interlaced video, bottom field coded and displayed first
1108 Interlaced video, top coded first, bottom displayed first
1110 Interlaced video, bottom coded first, top displayed first
1113 @item skip_alpha @var{integer} (@emph{decoding,video})
1114 Set to 1 to disable processing alpha (transparency). This works like the
1115 @samp{gray} flag in the @option{flags} option which skips chroma information
1116 instead of alpha. Default is 0.
1119 @c man end CODEC OPTIONS
1121 @ifclear config-writeonly
1122 @include decoders.texi
1124 @ifclear config-readonly
1125 @include encoders.texi