You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3478 lines
99KB

  1. @chapter Encoders
  2. @c man begin ENCODERS
  3. Encoders are configured elements in FFmpeg which allow the encoding of
  4. multimedia streams.
  5. When you configure your FFmpeg build, all the supported native encoders
  6. are enabled by default. Encoders requiring an external library must be enabled
  7. manually via the corresponding @code{--enable-lib} option. You can list all
  8. available encoders using the configure option @code{--list-encoders}.
  9. You can disable all the encoders with the configure option
  10. @code{--disable-encoders} and selectively enable / disable single encoders
  11. with the options @code{--enable-encoder=@var{ENCODER}} /
  12. @code{--disable-encoder=@var{ENCODER}}.
  13. The option @code{-encoders} of the ff* tools will display the list of
  14. enabled encoders.
  15. @c man end ENCODERS
  16. @chapter Audio Encoders
  17. @c man begin AUDIO ENCODERS
  18. A description of some of the currently available audio encoders
  19. follows.
  20. @anchor{aacenc}
  21. @section aac
  22. Advanced Audio Coding (AAC) encoder.
  23. This encoder is the default AAC encoder, natively implemented into FFmpeg.
  24. @subsection Options
  25. @table @option
  26. @item b
  27. Set bit rate in bits/s. Setting this automatically activates constant bit rate
  28. (CBR) mode. If this option is unspecified it is set to 128kbps.
  29. @item q
  30. Set quality for variable bit rate (VBR) mode. This option is valid only using
  31. the @command{ffmpeg} command-line tool. For library interface users, use
  32. @option{global_quality}.
  33. @item cutoff
  34. Set cutoff frequency. If unspecified will allow the encoder to dynamically
  35. adjust the cutoff to improve clarity on low bitrates.
  36. @item aac_coder
  37. Set AAC encoder coding method. Possible values:
  38. @table @samp
  39. @item twoloop
  40. Two loop searching (TLS) method.
  41. This method first sets quantizers depending on band thresholds and then tries
  42. to find an optimal combination by adding or subtracting a specific value from
  43. all quantizers and adjusting some individual quantizer a little. Will tune
  44. itself based on whether @option{aac_is}, @option{aac_ms} and @option{aac_pns}
  45. are enabled.
  46. @item anmr
  47. Average noise to mask ratio (ANMR) trellis-based solution.
  48. This is an experimental coder which currently produces a lower quality, is more
  49. unstable and is slower than the default twoloop coder but has potential.
  50. Currently has no support for the @option{aac_is} or @option{aac_pns} options.
  51. Not currently recommended.
  52. @item fast
  53. Constant quantizer method.
  54. Uses a cheaper version of twoloop algorithm that doesn't try to do as many
  55. clever adjustments. Worse with low bitrates (less than 64kbps), but is better
  56. and much faster at higher bitrates.
  57. This is the default choice for a coder
  58. @end table
  59. @item aac_ms
  60. Sets mid/side coding mode. The default value of "auto" will automatically use
  61. M/S with bands which will benefit from such coding. Can be forced for all bands
  62. using the value "enable", which is mainly useful for debugging or disabled using
  63. "disable".
  64. @item aac_is
  65. Sets intensity stereo coding tool usage. By default, it's enabled and will
  66. automatically toggle IS for similar pairs of stereo bands if it's beneficial.
  67. Can be disabled for debugging by setting the value to "disable".
  68. @item aac_pns
  69. Uses perceptual noise substitution to replace low entropy high frequency bands
  70. with imperceptible white noise during the decoding process. By default, it's
  71. enabled, but can be disabled for debugging purposes by using "disable".
  72. @item aac_tns
  73. Enables the use of a multitap FIR filter which spans through the high frequency
  74. bands to hide quantization noise during the encoding process and is reverted
  75. by the decoder. As well as decreasing unpleasant artifacts in the high range
  76. this also reduces the entropy in the high bands and allows for more bits to
  77. be used by the mid-low bands. By default it's enabled but can be disabled for
  78. debugging by setting the option to "disable".
  79. @item aac_ltp
  80. Enables the use of the long term prediction extension which increases coding
  81. efficiency in very low bandwidth situations such as encoding of voice or
  82. solo piano music by extending constant harmonic peaks in bands throughout
  83. frames. This option is implied by profile:a aac_low and is incompatible with
  84. aac_pred. Use in conjunction with @option{-ar} to decrease the samplerate.
  85. @item aac_pred
  86. Enables the use of a more traditional style of prediction where the spectral
  87. coefficients transmitted are replaced by the difference of the current
  88. coefficients minus the previous "predicted" coefficients. In theory and sometimes
  89. in practice this can improve quality for low to mid bitrate audio.
  90. This option implies the aac_main profile and is incompatible with aac_ltp.
  91. @item profile
  92. Sets the encoding profile, possible values:
  93. @table @samp
  94. @item aac_low
  95. The default, AAC "Low-complexity" profile. Is the most compatible and produces
  96. decent quality.
  97. @item mpeg2_aac_low
  98. Equivalent to @code{-profile:a aac_low -aac_pns 0}. PNS was introduced with the
  99. MPEG4 specifications.
  100. @item aac_ltp
  101. Long term prediction profile, is enabled by and will enable the @option{aac_ltp}
  102. option. Introduced in MPEG4.
  103. @item aac_main
  104. Main-type prediction profile, is enabled by and will enable the @option{aac_pred}
  105. option. Introduced in MPEG2.
  106. @end table
  107. If this option is unspecified it is set to @samp{aac_low}.
  108. @end table
  109. @section ac3 and ac3_fixed
  110. AC-3 audio encoders.
  111. These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  112. the undocumented RealAudio 3 (a.k.a. dnet).
  113. The @var{ac3} encoder uses floating-point math, while the @var{ac3_fixed}
  114. encoder only uses fixed-point integer math. This does not mean that one is
  115. always faster, just that one or the other may be better suited to a
  116. particular system. The floating-point encoder will generally produce better
  117. quality audio for a given bitrate. The @var{ac3_fixed} encoder is not the
  118. default codec for any of the output formats, so it must be specified explicitly
  119. using the option @code{-acodec ac3_fixed} in order to use it.
  120. @subsection AC-3 Metadata
  121. The AC-3 metadata options are used to set parameters that describe the audio,
  122. but in most cases do not affect the audio encoding itself. Some of the options
  123. do directly affect or influence the decoding and playback of the resulting
  124. bitstream, while others are just for informational purposes. A few of the
  125. options will add bits to the output stream that could otherwise be used for
  126. audio data, and will thus affect the quality of the output. Those will be
  127. indicated accordingly with a note in the option list below.
  128. These parameters are described in detail in several publicly-available
  129. documents.
  130. @itemize
  131. @item @uref{http://www.atsc.org/cms/standards/a_52-2010.pdf,A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard}
  132. @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}
  133. @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf,Dolby Metadata Guide}
  134. @item @uref{http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf,Dolby Digital Professional Encoding Guidelines}
  135. @end itemize
  136. @subsubsection Metadata Control Options
  137. @table @option
  138. @item -per_frame_metadata @var{boolean}
  139. Allow Per-Frame Metadata. Specifies if the encoder should check for changing
  140. metadata for each frame.
  141. @table @option
  142. @item 0
  143. The metadata values set at initialization will be used for every frame in the
  144. stream. (default)
  145. @item 1
  146. Metadata values can be changed before encoding each frame.
  147. @end table
  148. @end table
  149. @subsubsection Downmix Levels
  150. @table @option
  151. @item -center_mixlev @var{level}
  152. Center Mix Level. The amount of gain the decoder should apply to the center
  153. channel when downmixing to stereo. This field will only be written to the
  154. bitstream if a center channel is present. The value is specified as a scale
  155. factor. There are 3 valid values:
  156. @table @option
  157. @item 0.707
  158. Apply -3dB gain
  159. @item 0.595
  160. Apply -4.5dB gain (default)
  161. @item 0.500
  162. Apply -6dB gain
  163. @end table
  164. @item -surround_mixlev @var{level}
  165. Surround Mix Level. The amount of gain the decoder should apply to the surround
  166. channel(s) when downmixing to stereo. This field will only be written to the
  167. bitstream if one or more surround channels are present. The value is specified
  168. as a scale factor. There are 3 valid values:
  169. @table @option
  170. @item 0.707
  171. Apply -3dB gain
  172. @item 0.500
  173. Apply -6dB gain (default)
  174. @item 0.000
  175. Silence Surround Channel(s)
  176. @end table
  177. @end table
  178. @subsubsection Audio Production Information
  179. Audio Production Information is optional information describing the mixing
  180. environment. Either none or both of the fields are written to the bitstream.
  181. @table @option
  182. @item -mixing_level @var{number}
  183. Mixing Level. Specifies peak sound pressure level (SPL) in the production
  184. environment when the mix was mastered. Valid values are 80 to 111, or -1 for
  185. unknown or not indicated. The default value is -1, but that value cannot be
  186. used if the Audio Production Information is written to the bitstream. Therefore,
  187. if the @code{room_type} option is not the default value, the @code{mixing_level}
  188. option must not be -1.
  189. @item -room_type @var{type}
  190. Room Type. Describes the equalization used during the final mixing session at
  191. the studio or on the dubbing stage. A large room is a dubbing stage with the
  192. industry standard X-curve equalization; a small room has flat equalization.
  193. This field will not be written to the bitstream if both the @code{mixing_level}
  194. option and the @code{room_type} option have the default values.
  195. @table @option
  196. @item 0
  197. @itemx notindicated
  198. Not Indicated (default)
  199. @item 1
  200. @itemx large
  201. Large Room
  202. @item 2
  203. @itemx small
  204. Small Room
  205. @end table
  206. @end table
  207. @subsubsection Other Metadata Options
  208. @table @option
  209. @item -copyright @var{boolean}
  210. Copyright Indicator. Specifies whether a copyright exists for this audio.
  211. @table @option
  212. @item 0
  213. @itemx off
  214. No Copyright Exists (default)
  215. @item 1
  216. @itemx on
  217. Copyright Exists
  218. @end table
  219. @item -dialnorm @var{value}
  220. Dialogue Normalization. Indicates how far the average dialogue level of the
  221. program is below digital 100% full scale (0 dBFS). This parameter determines a
  222. level shift during audio reproduction that sets the average volume of the
  223. dialogue to a preset level. The goal is to match volume level between program
  224. sources. A value of -31dB will result in no volume level change, relative to
  225. the source volume, during audio reproduction. Valid values are whole numbers in
  226. the range -31 to -1, with -31 being the default.
  227. @item -dsur_mode @var{mode}
  228. Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
  229. (Pro Logic). This field will only be written to the bitstream if the audio
  230. stream is stereo. Using this option does @b{NOT} mean the encoder will actually
  231. apply Dolby Surround processing.
  232. @table @option
  233. @item 0
  234. @itemx notindicated
  235. Not Indicated (default)
  236. @item 1
  237. @itemx off
  238. Not Dolby Surround Encoded
  239. @item 2
  240. @itemx on
  241. Dolby Surround Encoded
  242. @end table
  243. @item -original @var{boolean}
  244. Original Bit Stream Indicator. Specifies whether this audio is from the
  245. original source and not a copy.
  246. @table @option
  247. @item 0
  248. @itemx off
  249. Not Original Source
  250. @item 1
  251. @itemx on
  252. Original Source (default)
  253. @end table
  254. @end table
  255. @subsection Extended Bitstream Information
  256. The extended bitstream options are part of the Alternate Bit Stream Syntax as
  257. specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
  258. If any one parameter in a group is specified, all values in that group will be
  259. written to the bitstream. Default values are used for those that are written
  260. but have not been specified. If the mixing levels are written, the decoder
  261. will use these values instead of the ones specified in the @code{center_mixlev}
  262. and @code{surround_mixlev} options if it supports the Alternate Bit Stream
  263. Syntax.
  264. @subsubsection Extended Bitstream Information - Part 1
  265. @table @option
  266. @item -dmix_mode @var{mode}
  267. Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
  268. (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
  269. @table @option
  270. @item 0
  271. @itemx notindicated
  272. Not Indicated (default)
  273. @item 1
  274. @itemx ltrt
  275. Lt/Rt Downmix Preferred
  276. @item 2
  277. @itemx loro
  278. Lo/Ro Downmix Preferred
  279. @end table
  280. @item -ltrt_cmixlev @var{level}
  281. Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
  282. center channel when downmixing to stereo in Lt/Rt mode.
  283. @table @option
  284. @item 1.414
  285. Apply +3dB gain
  286. @item 1.189
  287. Apply +1.5dB gain
  288. @item 1.000
  289. Apply 0dB gain
  290. @item 0.841
  291. Apply -1.5dB gain
  292. @item 0.707
  293. Apply -3.0dB gain
  294. @item 0.595
  295. Apply -4.5dB gain (default)
  296. @item 0.500
  297. Apply -6.0dB gain
  298. @item 0.000
  299. Silence Center Channel
  300. @end table
  301. @item -ltrt_surmixlev @var{level}
  302. Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
  303. surround channel(s) when downmixing to stereo in Lt/Rt mode.
  304. @table @option
  305. @item 0.841
  306. Apply -1.5dB gain
  307. @item 0.707
  308. Apply -3.0dB gain
  309. @item 0.595
  310. Apply -4.5dB gain
  311. @item 0.500
  312. Apply -6.0dB gain (default)
  313. @item 0.000
  314. Silence Surround Channel(s)
  315. @end table
  316. @item -loro_cmixlev @var{level}
  317. Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
  318. center channel when downmixing to stereo in Lo/Ro mode.
  319. @table @option
  320. @item 1.414
  321. Apply +3dB gain
  322. @item 1.189
  323. Apply +1.5dB gain
  324. @item 1.000
  325. Apply 0dB gain
  326. @item 0.841
  327. Apply -1.5dB gain
  328. @item 0.707
  329. Apply -3.0dB gain
  330. @item 0.595
  331. Apply -4.5dB gain (default)
  332. @item 0.500
  333. Apply -6.0dB gain
  334. @item 0.000
  335. Silence Center Channel
  336. @end table
  337. @item -loro_surmixlev @var{level}
  338. Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
  339. surround channel(s) when downmixing to stereo in Lo/Ro mode.
  340. @table @option
  341. @item 0.841
  342. Apply -1.5dB gain
  343. @item 0.707
  344. Apply -3.0dB gain
  345. @item 0.595
  346. Apply -4.5dB gain
  347. @item 0.500
  348. Apply -6.0dB gain (default)
  349. @item 0.000
  350. Silence Surround Channel(s)
  351. @end table
  352. @end table
  353. @subsubsection Extended Bitstream Information - Part 2
  354. @table @option
  355. @item -dsurex_mode @var{mode}
  356. Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
  357. (7.1 matrixed to 5.1). Using this option does @b{NOT} mean the encoder will actually
  358. apply Dolby Surround EX processing.
  359. @table @option
  360. @item 0
  361. @itemx notindicated
  362. Not Indicated (default)
  363. @item 1
  364. @itemx on
  365. Dolby Surround EX Off
  366. @item 2
  367. @itemx off
  368. Dolby Surround EX On
  369. @end table
  370. @item -dheadphone_mode @var{mode}
  371. Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
  372. encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
  373. option does @b{NOT} mean the encoder will actually apply Dolby Headphone
  374. processing.
  375. @table @option
  376. @item 0
  377. @itemx notindicated
  378. Not Indicated (default)
  379. @item 1
  380. @itemx on
  381. Dolby Headphone Off
  382. @item 2
  383. @itemx off
  384. Dolby Headphone On
  385. @end table
  386. @item -ad_conv_type @var{type}
  387. A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
  388. conversion.
  389. @table @option
  390. @item 0
  391. @itemx standard
  392. Standard A/D Converter (default)
  393. @item 1
  394. @itemx hdcd
  395. HDCD A/D Converter
  396. @end table
  397. @end table
  398. @subsection Other AC-3 Encoding Options
  399. @table @option
  400. @item -stereo_rematrixing @var{boolean}
  401. Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
  402. is an optional AC-3 feature that increases quality by selectively encoding
  403. the left/right channels as mid/side. This option is enabled by default, and it
  404. is highly recommended that it be left as enabled except for testing purposes.
  405. @item cutoff @var{frequency}
  406. Set lowpass cutoff frequency. If unspecified, the encoder selects a default
  407. determined by various other encoding parameters.
  408. @end table
  409. @subsection Floating-Point-Only AC-3 Encoding Options
  410. These options are only valid for the floating-point encoder and do not exist
  411. for the fixed-point encoder due to the corresponding features not being
  412. implemented in fixed-point.
  413. @table @option
  414. @item -channel_coupling @var{boolean}
  415. Enables/Disables use of channel coupling, which is an optional AC-3 feature
  416. that increases quality by combining high frequency information from multiple
  417. channels into a single channel. The per-channel high frequency information is
  418. sent with less accuracy in both the frequency and time domains. This allows
  419. more bits to be used for lower frequencies while preserving enough information
  420. to reconstruct the high frequencies. This option is enabled by default for the
  421. floating-point encoder and should generally be left as enabled except for
  422. testing purposes or to increase encoding speed.
  423. @table @option
  424. @item -1
  425. @itemx auto
  426. Selected by Encoder (default)
  427. @item 0
  428. @itemx off
  429. Disable Channel Coupling
  430. @item 1
  431. @itemx on
  432. Enable Channel Coupling
  433. @end table
  434. @item -cpl_start_band @var{number}
  435. Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
  436. value higher than the bandwidth is used, it will be reduced to 1 less than the
  437. coupling end band. If @var{auto} is used, the start band will be determined by
  438. the encoder based on the bit rate, sample rate, and channel layout. This option
  439. has no effect if channel coupling is disabled.
  440. @table @option
  441. @item -1
  442. @itemx auto
  443. Selected by Encoder (default)
  444. @end table
  445. @end table
  446. @anchor{flac}
  447. @section flac
  448. FLAC (Free Lossless Audio Codec) Encoder
  449. @subsection Options
  450. The following options are supported by FFmpeg's flac encoder.
  451. @table @option
  452. @item compression_level
  453. Sets the compression level, which chooses defaults for many other options
  454. if they are not set explicitly. Valid values are from 0 to 12, 5 is the
  455. default.
  456. @item frame_size
  457. Sets the size of the frames in samples per channel.
  458. @item lpc_coeff_precision
  459. Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the
  460. default.
  461. @item lpc_type
  462. Sets the first stage LPC algorithm
  463. @table @samp
  464. @item none
  465. LPC is not used
  466. @item fixed
  467. fixed LPC coefficients
  468. @item levinson
  469. @item cholesky
  470. @end table
  471. @item lpc_passes
  472. Number of passes to use for Cholesky factorization during LPC analysis
  473. @item min_partition_order
  474. The minimum partition order
  475. @item max_partition_order
  476. The maximum partition order
  477. @item prediction_order_method
  478. @table @samp
  479. @item estimation
  480. @item 2level
  481. @item 4level
  482. @item 8level
  483. @item search
  484. Bruteforce search
  485. @item log
  486. @end table
  487. @item ch_mode
  488. Channel mode
  489. @table @samp
  490. @item auto
  491. The mode is chosen automatically for each frame
  492. @item indep
  493. Channels are independently coded
  494. @item left_side
  495. @item right_side
  496. @item mid_side
  497. @end table
  498. @item exact_rice_parameters
  499. Chooses if rice parameters are calculated exactly or approximately.
  500. if set to 1 then they are chosen exactly, which slows the code down slightly and
  501. improves compression slightly.
  502. @item multi_dim_quant
  503. Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is
  504. applied after the first stage to finetune the coefficients. This is quite slow
  505. and slightly improves compression.
  506. @end table
  507. @anchor{opusenc}
  508. @section opus
  509. Opus encoder.
  510. This is a native FFmpeg encoder for the Opus format. Currently its in development and
  511. only implements the CELT part of the codec. Its quality is usually worse and at best
  512. is equal to the libopus encoder.
  513. @subsection Options
  514. @table @option
  515. @item b
  516. Set bit rate in bits/s. If unspecified it uses the number of channels and the layout
  517. to make a good guess.
  518. @item opus_delay
  519. Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly
  520. decrease quality.
  521. @end table
  522. @anchor{libfdk-aac-enc}
  523. @section libfdk_aac
  524. libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
  525. The libfdk-aac library is based on the Fraunhofer FDK AAC code from
  526. the Android project.
  527. Requires the presence of the libfdk-aac headers and library during
  528. configuration. You need to explicitly configure the build with
  529. @code{--enable-libfdk-aac}. The library is also incompatible with GPL,
  530. so if you allow the use of GPL, you should configure with
  531. @code{--enable-gpl --enable-nonfree --enable-libfdk-aac}.
  532. This encoder has support for the AAC-HE profiles.
  533. VBR encoding, enabled through the @option{vbr} or @option{flags
  534. +qscale} options, is experimental and only works with some
  535. combinations of parameters.
  536. Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or
  537. higher.
  538. For more information see the fdk-aac project at
  539. @url{http://sourceforge.net/p/opencore-amr/fdk-aac/}.
  540. @subsection Options
  541. The following options are mapped on the shared FFmpeg codec options.
  542. @table @option
  543. @item b
  544. Set bit rate in bits/s. If the bitrate is not explicitly specified, it
  545. is automatically set to a suitable value depending on the selected
  546. profile.
  547. In case VBR mode is enabled the option is ignored.
  548. @item ar
  549. Set audio sampling rate (in Hz).
  550. @item channels
  551. Set the number of audio channels.
  552. @item flags +qscale
  553. Enable fixed quality, VBR (Variable Bit Rate) mode.
  554. Note that VBR is implicitly enabled when the @option{vbr} value is
  555. positive.
  556. @item cutoff
  557. Set cutoff frequency. If not specified (or explicitly set to 0) it
  558. will use a value automatically computed by the library. Default value
  559. is 0.
  560. @item profile
  561. Set audio profile.
  562. The following profiles are recognized:
  563. @table @samp
  564. @item aac_low
  565. Low Complexity AAC (LC)
  566. @item aac_he
  567. High Efficiency AAC (HE-AAC)
  568. @item aac_he_v2
  569. High Efficiency AAC version 2 (HE-AACv2)
  570. @item aac_ld
  571. Low Delay AAC (LD)
  572. @item aac_eld
  573. Enhanced Low Delay AAC (ELD)
  574. @end table
  575. If not specified it is set to @samp{aac_low}.
  576. @end table
  577. The following are private options of the libfdk_aac encoder.
  578. @table @option
  579. @item afterburner
  580. Enable afterburner feature if set to 1, disabled if set to 0. This
  581. improves the quality but also the required processing power.
  582. Default value is 1.
  583. @item eld_sbr
  584. Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
  585. if set to 0.
  586. Default value is 0.
  587. @item eld_v2
  588. Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1,
  589. disabled if set to 0.
  590. Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) > (4.0.0).
  591. Default value is 0.
  592. @item signaling
  593. Set SBR/PS signaling style.
  594. It can assume one of the following values:
  595. @table @samp
  596. @item default
  597. choose signaling implicitly (explicit hierarchical by default,
  598. implicit if global header is disabled)
  599. @item implicit
  600. implicit backwards compatible signaling
  601. @item explicit_sbr
  602. explicit SBR, implicit PS signaling
  603. @item explicit_hierarchical
  604. explicit hierarchical signaling
  605. @end table
  606. Default value is @samp{default}.
  607. @item latm
  608. Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
  609. Default value is 0.
  610. @item header_period
  611. Set StreamMuxConfig and PCE repetition period (in frames) for sending
  612. in-band configuration buffers within LATM/LOAS transport layer.
  613. Must be a 16-bits non-negative integer.
  614. Default value is 0.
  615. @item vbr
  616. Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
  617. good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
  618. (Constant Bit Rate) is enabled.
  619. Currently only the @samp{aac_low} profile supports VBR encoding.
  620. VBR modes 1-5 correspond to roughly the following average bit rates:
  621. @table @samp
  622. @item 1
  623. 32 kbps/channel
  624. @item 2
  625. 40 kbps/channel
  626. @item 3
  627. 48-56 kbps/channel
  628. @item 4
  629. 64 kbps/channel
  630. @item 5
  631. about 80-96 kbps/channel
  632. @end table
  633. Default value is 0.
  634. @end table
  635. @subsection Examples
  636. @itemize
  637. @item
  638. Use @command{ffmpeg} to convert an audio file to VBR AAC in an M4A (MP4)
  639. container:
  640. @example
  641. ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
  642. @end example
  643. @item
  644. Use @command{ffmpeg} to convert an audio file to CBR 64k kbps AAC, using the
  645. High-Efficiency AAC profile:
  646. @example
  647. ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
  648. @end example
  649. @end itemize
  650. @anchor{libmp3lame}
  651. @section libmp3lame
  652. LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper.
  653. Requires the presence of the libmp3lame headers and library during
  654. configuration. You need to explicitly configure the build with
  655. @code{--enable-libmp3lame}.
  656. See @ref{libshine} for a fixed-point MP3 encoder, although with a
  657. lower quality.
  658. @subsection Options
  659. The following options are supported by the libmp3lame wrapper. The
  660. @command{lame}-equivalent of the options are listed in parentheses.
  661. @table @option
  662. @item b (@emph{-b})
  663. Set bitrate expressed in bits/s for CBR or ABR. LAME @code{bitrate} is
  664. expressed in kilobits/s.
  665. @item q (@emph{-V})
  666. Set constant quality setting for VBR. This option is valid only
  667. using the @command{ffmpeg} command-line tool. For library interface
  668. users, use @option{global_quality}.
  669. @item compression_level (@emph{-q})
  670. Set algorithm quality. Valid arguments are integers in the 0-9 range,
  671. with 0 meaning highest quality but slowest, and 9 meaning fastest
  672. while producing the worst quality.
  673. @item cutoff (@emph{--lowpass})
  674. Set lowpass cutoff frequency. If unspecified, the encoder dynamically
  675. adjusts the cutoff.
  676. @item reservoir
  677. Enable use of bit reservoir when set to 1. Default value is 1. LAME
  678. has this enabled by default, but can be overridden by use
  679. @option{--nores} option.
  680. @item joint_stereo (@emph{-m j})
  681. Enable the encoder to use (on a frame by frame basis) either L/R
  682. stereo or mid/side stereo. Default value is 1.
  683. @item abr (@emph{--abr})
  684. Enable the encoder to use ABR when set to 1. The @command{lame}
  685. @option{--abr} sets the target bitrate, while this options only
  686. tells FFmpeg to use ABR still relies on @option{b} to set bitrate.
  687. @end table
  688. @section libopencore-amrnb
  689. OpenCORE Adaptive Multi-Rate Narrowband encoder.
  690. Requires the presence of the libopencore-amrnb headers and library during
  691. configuration. You need to explicitly configure the build with
  692. @code{--enable-libopencore-amrnb --enable-version3}.
  693. This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
  694. but you can override it by setting @option{strict} to @samp{unofficial} or
  695. lower.
  696. @subsection Options
  697. @table @option
  698. @item b
  699. Set bitrate in bits per second. Only the following bitrates are supported,
  700. otherwise libavcodec will round to the nearest valid bitrate.
  701. @table @option
  702. @item 4750
  703. @item 5150
  704. @item 5900
  705. @item 6700
  706. @item 7400
  707. @item 7950
  708. @item 10200
  709. @item 12200
  710. @end table
  711. @item dtx
  712. Allow discontinuous transmission (generate comfort noise) when set to 1. The
  713. default value is 0 (disabled).
  714. @end table
  715. @section libopus
  716. libopus Opus Interactive Audio Codec encoder wrapper.
  717. Requires the presence of the libopus headers and library during
  718. configuration. You need to explicitly configure the build with
  719. @code{--enable-libopus}.
  720. @subsection Option Mapping
  721. Most libopus options are modelled after the @command{opusenc} utility from
  722. opus-tools. The following is an option mapping chart describing options
  723. supported by the libopus wrapper, and their @command{opusenc}-equivalent
  724. in parentheses.
  725. @table @option
  726. @item b (@emph{bitrate})
  727. Set the bit rate in bits/s. FFmpeg's @option{b} option is
  728. expressed in bits/s, while @command{opusenc}'s @option{bitrate} in
  729. kilobits/s.
  730. @item vbr (@emph{vbr}, @emph{hard-cbr}, and @emph{cvbr})
  731. Set VBR mode. The FFmpeg @option{vbr} option has the following
  732. valid arguments, with the @command{opusenc} equivalent options
  733. in parentheses:
  734. @table @samp
  735. @item off (@emph{hard-cbr})
  736. Use constant bit rate encoding.
  737. @item on (@emph{vbr})
  738. Use variable bit rate encoding (the default).
  739. @item constrained (@emph{cvbr})
  740. Use constrained variable bit rate encoding.
  741. @end table
  742. @item compression_level (@emph{comp})
  743. Set encoding algorithm complexity. Valid options are integers in
  744. the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
  745. gives the highest quality but slowest encoding. The default is 10.
  746. @item frame_duration (@emph{framesize})
  747. Set maximum frame size, or duration of a frame in milliseconds. The
  748. argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
  749. frame sizes achieve lower latency but less quality at a given bitrate.
  750. Sizes greater than 20ms are only interesting at fairly low bitrates.
  751. The default is 20ms.
  752. @item packet_loss (@emph{expect-loss})
  753. Set expected packet loss percentage. The default is 0.
  754. @item application (N.A.)
  755. Set intended application type. Valid options are listed below:
  756. @table @samp
  757. @item voip
  758. Favor improved speech intelligibility.
  759. @item audio
  760. Favor faithfulness to the input (the default).
  761. @item lowdelay
  762. Restrict to only the lowest delay modes.
  763. @end table
  764. @item cutoff (N.A.)
  765. Set cutoff bandwidth in Hz. The argument must be exactly one of the
  766. following: 4000, 6000, 8000, 12000, or 20000, corresponding to
  767. narrowband, mediumband, wideband, super wideband, and fullband
  768. respectively. The default is 0 (cutoff disabled).
  769. @item mapping_family (@emph{mapping_family})
  770. Set channel mapping family to be used by the encoder. The default value of -1
  771. uses mapping family 0 for mono and stereo inputs, and mapping family 1
  772. otherwise. The default also disables the surround masking and LFE bandwidth
  773. optimzations in libopus, and requires that the input contains 8 channels or
  774. fewer.
  775. Other values include 0 for mono and stereo, 1 for surround sound with masking
  776. and LFE bandwidth optimizations, and 255 for independent streams with an
  777. unspecified channel layout.
  778. @item apply_phase_inv (N.A.) (requires libopus >= 1.2)
  779. If set to 0, disables the use of phase inversion for intensity stereo,
  780. improving the quality of mono downmixes, but slightly reducing normal stereo
  781. quality. The default is 1 (phase inversion enabled).
  782. @end table
  783. @anchor{libshine}
  784. @section libshine
  785. Shine Fixed-Point MP3 encoder wrapper.
  786. Shine is a fixed-point MP3 encoder. It has a far better performance on
  787. platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
  788. However, as it is more targeted on performance than quality, it is not on par
  789. with LAME and other production-grade encoders quality-wise. Also, according to
  790. the project's homepage, this encoder may not be free of bugs as the code was
  791. written a long time ago and the project was dead for at least 5 years.
  792. This encoder only supports stereo and mono input. This is also CBR-only.
  793. The original project (last updated in early 2007) is at
  794. @url{http://sourceforge.net/projects/libshine-fxp/}. We only support the
  795. updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}.
  796. Requires the presence of the libshine headers and library during
  797. configuration. You need to explicitly configure the build with
  798. @code{--enable-libshine}.
  799. See also @ref{libmp3lame}.
  800. @subsection Options
  801. The following options are supported by the libshine wrapper. The
  802. @command{shineenc}-equivalent of the options are listed in parentheses.
  803. @table @option
  804. @item b (@emph{-b})
  805. Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option
  806. is expressed in kilobits/s.
  807. @end table
  808. @section libtwolame
  809. TwoLAME MP2 encoder wrapper.
  810. Requires the presence of the libtwolame headers and library during
  811. configuration. You need to explicitly configure the build with
  812. @code{--enable-libtwolame}.
  813. @subsection Options
  814. The following options are supported by the libtwolame wrapper. The
  815. @command{twolame}-equivalent options follow the FFmpeg ones and are in
  816. parentheses.
  817. @table @option
  818. @item b (@emph{-b})
  819. Set bitrate expressed in bits/s for CBR. @command{twolame} @option{b}
  820. option is expressed in kilobits/s. Default value is 128k.
  821. @item q (@emph{-V})
  822. Set quality for experimental VBR support. Maximum value range is
  823. from -50 to 50, useful range is from -10 to 10. The higher the
  824. value, the better the quality. This option is valid only using the
  825. @command{ffmpeg} command-line tool. For library interface users,
  826. use @option{global_quality}.
  827. @item mode (@emph{--mode})
  828. Set the mode of the resulting audio. Possible values:
  829. @table @samp
  830. @item auto
  831. Choose mode automatically based on the input. This is the default.
  832. @item stereo
  833. Stereo
  834. @item joint_stereo
  835. Joint stereo
  836. @item dual_channel
  837. Dual channel
  838. @item mono
  839. Mono
  840. @end table
  841. @item psymodel (@emph{--psyc-mode})
  842. Set psychoacoustic model to use in encoding. The argument must be
  843. an integer between -1 and 4, inclusive. The higher the value, the
  844. better the quality. The default value is 3.
  845. @item energy_levels (@emph{--energy})
  846. Enable energy levels extensions when set to 1. The default value is
  847. 0 (disabled).
  848. @item error_protection (@emph{--protect})
  849. Enable CRC error protection when set to 1. The default value is 0
  850. (disabled).
  851. @item copyright (@emph{--copyright})
  852. Set MPEG audio copyright flag when set to 1. The default value is 0
  853. (disabled).
  854. @item original (@emph{--original})
  855. Set MPEG audio original flag when set to 1. The default value is 0
  856. (disabled).
  857. @end table
  858. @section libvo-amrwbenc
  859. VisualOn Adaptive Multi-Rate Wideband encoder.
  860. Requires the presence of the libvo-amrwbenc headers and library during
  861. configuration. You need to explicitly configure the build with
  862. @code{--enable-libvo-amrwbenc --enable-version3}.
  863. This is a mono-only encoder. Officially it only supports 16000Hz sample
  864. rate, but you can override it by setting @option{strict} to
  865. @samp{unofficial} or lower.
  866. @subsection Options
  867. @table @option
  868. @item b
  869. Set bitrate in bits/s. Only the following bitrates are supported, otherwise
  870. libavcodec will round to the nearest valid bitrate.
  871. @table @samp
  872. @item 6600
  873. @item 8850
  874. @item 12650
  875. @item 14250
  876. @item 15850
  877. @item 18250
  878. @item 19850
  879. @item 23050
  880. @item 23850
  881. @end table
  882. @item dtx
  883. Allow discontinuous transmission (generate comfort noise) when set to 1. The
  884. default value is 0 (disabled).
  885. @end table
  886. @section libvorbis
  887. libvorbis encoder wrapper.
  888. Requires the presence of the libvorbisenc headers and library during
  889. configuration. You need to explicitly configure the build with
  890. @code{--enable-libvorbis}.
  891. @subsection Options
  892. The following options are supported by the libvorbis wrapper. The
  893. @command{oggenc}-equivalent of the options are listed in parentheses.
  894. To get a more accurate and extensive documentation of the libvorbis
  895. options, consult the libvorbisenc's and @command{oggenc}'s documentations.
  896. See @url{http://xiph.org/vorbis/},
  897. @url{http://wiki.xiph.org/Vorbis-tools}, and oggenc(1).
  898. @table @option
  899. @item b (@emph{-b})
  900. Set bitrate expressed in bits/s for ABR. @command{oggenc} @option{-b} is
  901. expressed in kilobits/s.
  902. @item q (@emph{-q})
  903. Set constant quality setting for VBR. The value should be a float
  904. number in the range of -1.0 to 10.0. The higher the value, the better
  905. the quality. The default value is @samp{3.0}.
  906. This option is valid only using the @command{ffmpeg} command-line tool.
  907. For library interface users, use @option{global_quality}.
  908. @item cutoff (@emph{--advanced-encode-option lowpass_frequency=N})
  909. Set cutoff bandwidth in Hz, a value of 0 disables cutoff. @command{oggenc}'s
  910. related option is expressed in kHz. The default value is @samp{0} (cutoff
  911. disabled).
  912. @item minrate (@emph{-m})
  913. Set minimum bitrate expressed in bits/s. @command{oggenc} @option{-m} is
  914. expressed in kilobits/s.
  915. @item maxrate (@emph{-M})
  916. Set maximum bitrate expressed in bits/s. @command{oggenc} @option{-M} is
  917. expressed in kilobits/s. This only has effect on ABR mode.
  918. @item iblock (@emph{--advanced-encode-option impulse_noisetune=N})
  919. Set noise floor bias for impulse blocks. The value is a float number from
  920. -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
  921. to the crispness of transients in the encoded audio. The tradeoff for better
  922. transient response is a higher bitrate.
  923. @end table
  924. @anchor{libwavpack}
  925. @section libwavpack
  926. A wrapper providing WavPack encoding through libwavpack.
  927. Only lossless mode using 32-bit integer samples is supported currently.
  928. Requires the presence of the libwavpack headers and library during
  929. configuration. You need to explicitly configure the build with
  930. @code{--enable-libwavpack}.
  931. Note that a libavcodec-native encoder for the WavPack codec exists so users can
  932. encode audios with this codec without using this encoder. See @ref{wavpackenc}.
  933. @subsection Options
  934. @command{wavpack} command line utility's corresponding options are listed in
  935. parentheses, if any.
  936. @table @option
  937. @item frame_size (@emph{--blocksize})
  938. Default is 32768.
  939. @item compression_level
  940. Set speed vs. compression tradeoff. Acceptable arguments are listed below:
  941. @table @samp
  942. @item 0 (@emph{-f})
  943. Fast mode.
  944. @item 1
  945. Normal (default) settings.
  946. @item 2 (@emph{-h})
  947. High quality.
  948. @item 3 (@emph{-hh})
  949. Very high quality.
  950. @item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
  951. Same as @samp{3}, but with extra processing enabled.
  952. @samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
  953. @end table
  954. @end table
  955. @anchor{mjpegenc}
  956. @section mjpeg
  957. Motion JPEG encoder.
  958. @subsection Options
  959. @table @option
  960. @item huffman
  961. Set the huffman encoding strategy. Possible values:
  962. @table @samp
  963. @item default
  964. Use the default huffman tables. This is the default strategy.
  965. @item optimal
  966. Compute and use optimal huffman tables.
  967. @end table
  968. @end table
  969. @anchor{wavpackenc}
  970. @section wavpack
  971. WavPack lossless audio encoder.
  972. This is a libavcodec-native WavPack encoder. There is also an encoder based on
  973. libwavpack, but there is virtually no reason to use that encoder.
  974. See also @ref{libwavpack}.
  975. @subsection Options
  976. The equivalent options for @command{wavpack} command line utility are listed in
  977. parentheses.
  978. @subsubsection Shared options
  979. The following shared options are effective for this encoder. Only special notes
  980. about this particular encoder will be documented here. For the general meaning
  981. of the options, see @ref{codec-options,,the Codec Options chapter}.
  982. @table @option
  983. @item frame_size (@emph{--blocksize})
  984. For this encoder, the range for this option is between 128 and 131072. Default
  985. is automatically decided based on sample rate and number of channel.
  986. For the complete formula of calculating default, see
  987. @file{libavcodec/wavpackenc.c}.
  988. @item compression_level (@emph{-f}, @emph{-h}, @emph{-hh}, and @emph{-x})
  989. This option's syntax is consistent with @ref{libwavpack}'s.
  990. @end table
  991. @subsubsection Private options
  992. @table @option
  993. @item joint_stereo (@emph{-j})
  994. Set whether to enable joint stereo. Valid values are:
  995. @table @samp
  996. @item on (@emph{1})
  997. Force mid/side audio encoding.
  998. @item off (@emph{0})
  999. Force left/right audio encoding.
  1000. @item auto
  1001. Let the encoder decide automatically.
  1002. @end table
  1003. @item optimize_mono
  1004. Set whether to enable optimization for mono. This option is only effective for
  1005. non-mono streams. Available values:
  1006. @table @samp
  1007. @item on
  1008. enabled
  1009. @item off
  1010. disabled
  1011. @end table
  1012. @end table
  1013. @c man end AUDIO ENCODERS
  1014. @chapter Video Encoders
  1015. @c man begin VIDEO ENCODERS
  1016. A description of some of the currently available video encoders
  1017. follows.
  1018. @section Hap
  1019. Vidvox Hap video encoder.
  1020. @subsection Options
  1021. @table @option
  1022. @item format @var{integer}
  1023. Specifies the Hap format to encode.
  1024. @table @option
  1025. @item hap
  1026. @item hap_alpha
  1027. @item hap_q
  1028. @end table
  1029. Default value is @option{hap}.
  1030. @item chunks @var{integer}
  1031. Specifies the number of chunks to split frames into, between 1 and 64. This
  1032. permits multithreaded decoding of large frames, potentially at the cost of
  1033. data-rate. The encoder may modify this value to divide frames evenly.
  1034. Default value is @var{1}.
  1035. @item compressor @var{integer}
  1036. Specifies the second-stage compressor to use. If set to @option{none},
  1037. @option{chunks} will be limited to 1, as chunked uncompressed frames offer no
  1038. benefit.
  1039. @table @option
  1040. @item none
  1041. @item snappy
  1042. @end table
  1043. Default value is @option{snappy}.
  1044. @end table
  1045. @section jpeg2000
  1046. The native jpeg 2000 encoder is lossy by default, the @code{-q:v}
  1047. option can be used to set the encoding quality. Lossless encoding
  1048. can be selected with @code{-pred 1}.
  1049. @subsection Options
  1050. @table @option
  1051. @item format @var{integer}
  1052. Can be set to either @code{j2k} or @code{jp2} (the default) that
  1053. makes it possible to store non-rgb pix_fmts.
  1054. @item tile_width @var{integer}
  1055. Sets tile width. Range is 1 to 1073741824. Default is 256.
  1056. @item tile_height @var{integer}
  1057. Sets tile height. Range is 1 to 1073741824. Default is 256.
  1058. @item pred @var{integer}
  1059. Allows setting the discrete wavelet transform (DWT) type
  1060. @table @option
  1061. @item dwt97int (Lossy)
  1062. @item dwt53 (Lossless)
  1063. @end table
  1064. Default is @code{dwt97int}
  1065. @item sop @var{boolean}
  1066. Enable this to add SOP marker at the start of each packet. Disabled by default.
  1067. @item eph @var{boolean}
  1068. Enable this to add EPH marker at the end of each packet header. Disabled by default.
  1069. @item prog @var{integer}
  1070. Sets the progression order to be used by the encoder.
  1071. Possible values are:
  1072. @table @option
  1073. @item lrcp
  1074. @item rlcp
  1075. @item rpcl
  1076. @item pcrl
  1077. @item cprl
  1078. @end table
  1079. Set to @code{lrcp} by default.
  1080. @item layer_rates @var{string}
  1081. By default, when this option is not used, compression is done using the quality metric.
  1082. This option allows for compression using compression ratio. The compression ratio for each
  1083. level could be specified. The compression ratio of a layer @code{l} species the what ratio of
  1084. total file size is contained in the first @code{l} layers.
  1085. Example usage:
  1086. @example
  1087. ffmpeg -i input.bmp -c:v jpeg2000 -layer_rates "100,10,1" output.j2k
  1088. @end example
  1089. This would compress the image to contain 3 layers, where the data contained in the
  1090. first layer would be compressed by 1000 times, compressed by 100 in the first two layers,
  1091. and shall contain all data while using all 3 layers.
  1092. @end table
  1093. @section librav1e
  1094. rav1e AV1 encoder wrapper.
  1095. Requires the presence of the rav1e headers and library during configuration.
  1096. You need to explicitly configure the build with @code{--enable-librav1e}.
  1097. @subsection Options
  1098. @table @option
  1099. @item qmax
  1100. Sets the maximum quantizer to use when using bitrate mode.
  1101. @item qmin
  1102. Sets the minimum quantizer to use when using bitrate mode.
  1103. @item qp
  1104. Uses quantizer mode to encode at the given quantizer (0-255).
  1105. @item speed
  1106. Selects the speed preset (0-10) to encode with.
  1107. @item tiles
  1108. Selects how many tiles to encode with.
  1109. @item tile-rows
  1110. Selects how many rows of tiles to encode with.
  1111. @item tile-columns
  1112. Selects how many columns of tiles to encode with.
  1113. @item rav1e-params
  1114. Set rav1e options using a list of @var{key}=@var{value} pairs separated
  1115. by ":". See @command{rav1e --help} for a list of options.
  1116. For example to specify librav1e encoding options with @option{-rav1e-params}:
  1117. @example
  1118. ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
  1119. @end example
  1120. @end table
  1121. @section libaom-av1
  1122. libaom AV1 encoder wrapper.
  1123. Requires the presence of the libaom headers and library during
  1124. configuration. You need to explicitly configure the build with
  1125. @code{--enable-libaom}.
  1126. @subsection Options
  1127. The wrapper supports the following standard libavcodec options:
  1128. @table @option
  1129. @item b
  1130. Set bitrate target in bits/second. By default this will use
  1131. variable-bitrate mode. If @option{maxrate} and @option{minrate} are
  1132. also set to the same value then it will use constant-bitrate mode,
  1133. otherwise if @option{crf} is set as well then it will use
  1134. constrained-quality mode.
  1135. @item g keyint_min
  1136. Set key frame placement. The GOP size sets the maximum distance between
  1137. key frames; if zero the output stream will be intra-only. The minimum
  1138. distance is ignored unless it is the same as the GOP size, in which case
  1139. key frames will always appear at a fixed interval. Not set by default,
  1140. so without this option the library has completely free choice about
  1141. where to place key frames.
  1142. @item qmin qmax
  1143. Set minimum/maximum quantisation values. Valid range is from 0 to 63
  1144. (warning: this does not match the quantiser values actually used by AV1
  1145. - divide by four to map real quantiser values to this range). Defaults
  1146. to min/max (no constraint).
  1147. @item minrate maxrate bufsize rc_init_occupancy
  1148. Set rate control buffering parameters. Not used if not set - defaults
  1149. to unconstrained variable bitrate.
  1150. @item threads
  1151. Set the number of threads to use while encoding. This may require the
  1152. @option{tiles} or @option{row-mt} options to also be set to actually
  1153. use the specified number of threads fully. Defaults to the number of
  1154. hardware threads supported by the host machine.
  1155. @item profile
  1156. Set the encoding profile. Defaults to using the profile which matches
  1157. the bit depth and chroma subsampling of the input.
  1158. @end table
  1159. The wrapper also has some specific options:
  1160. @table @option
  1161. @item cpu-used
  1162. Set the quality/encoding speed tradeoff. Valid range is from 0 to 8,
  1163. higher numbers indicating greater speed and lower quality. The default
  1164. value is 1, which will be slow and high quality.
  1165. @item auto-alt-ref
  1166. Enable use of alternate reference frames. Defaults to the internal
  1167. default of the library.
  1168. @item arnr-max-frames (@emph{frames})
  1169. Set altref noise reduction max frame count. Default is -1.
  1170. @item arnr-strength (@emph{strength})
  1171. Set altref noise reduction filter strength. Range is -1 to 6. Default is -1.
  1172. @item aq-mode (@emph{aq-mode})
  1173. Set adaptive quantization mode. Possible values:
  1174. @table @samp
  1175. @item none (@emph{0})
  1176. Disabled.
  1177. @item variance (@emph{1})
  1178. Variance-based.
  1179. @item complexity (@emph{2})
  1180. Complexity-based.
  1181. @item cyclic (@emph{3})
  1182. Cyclic refresh.
  1183. @end table
  1184. @item tune (@emph{tune})
  1185. Set the distortion metric the encoder is tuned with. Default is @code{psnr}.
  1186. @table @samp
  1187. @item psnr (@emph{0})
  1188. @item ssim (@emph{1})
  1189. @end table
  1190. @item lag-in-frames
  1191. Set the maximum number of frames which the encoder may keep in flight
  1192. at any one time for lookahead purposes. Defaults to the internal
  1193. default of the library.
  1194. @item error-resilience
  1195. Enable error resilience features:
  1196. @table @option
  1197. @item default
  1198. Improve resilience against losses of whole frames.
  1199. @end table
  1200. Not enabled by default.
  1201. @item crf
  1202. Set the quality/size tradeoff for constant-quality (no bitrate target)
  1203. and constrained-quality (with maximum bitrate target) modes. Valid
  1204. range is 0 to 63, higher numbers indicating lower quality and smaller
  1205. output size. Only used if set; by default only the bitrate target is
  1206. used.
  1207. @item static-thresh
  1208. Set a change threshold on blocks below which they will be skipped by
  1209. the encoder. Defined in arbitrary units as a nonnegative integer,
  1210. defaulting to zero (no blocks are skipped).
  1211. @item drop-threshold
  1212. Set a threshold for dropping frames when close to rate control bounds.
  1213. Defined as a percentage of the target buffer - when the rate control
  1214. buffer falls below this percentage, frames will be dropped until it
  1215. has refilled above the threshold. Defaults to zero (no frames are
  1216. dropped).
  1217. @item denoise-noise-level (@emph{level})
  1218. Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if
  1219. this option is not set or set to 0.
  1220. @item denoise-block-size (@emph{pixels})
  1221. Block size used for denoising for grain synthesis. If not set, AV1 codec
  1222. uses the default value of 32.
  1223. @item undershoot-pct (@emph{pct})
  1224. Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100.
  1225. Default is -1.
  1226. @item overshoot-pct (@emph{pct})
  1227. Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000.
  1228. Default is -1.
  1229. @item minsection-pct (@emph{pct})
  1230. Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct
  1231. is not set, the libaomenc wrapper computes it as follows: @code{(minrate * 100 / bitrate)}.
  1232. Range is -1 to 100. Default is -1 (unset).
  1233. @item maxsection-pct (@emph{pct})
  1234. Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct
  1235. is not set, the libaomenc wrapper computes it as follows: @code{(maxrate * 100 / bitrate)}.
  1236. Range is -1 to 5000. Default is -1 (unset).
  1237. @item frame-parallel (@emph{boolean})
  1238. Enable frame parallel decodability features. Default is true.
  1239. @item tiles
  1240. Set the number of tiles to encode the input video with, as columns x
  1241. rows. Larger numbers allow greater parallelism in both encoding and
  1242. decoding, but may decrease coding efficiency. Defaults to the minimum
  1243. number of tiles required by the size of the input video (this is 1x1
  1244. (that is, a single tile) for sizes up to and including 4K).
  1245. @item tile-columns tile-rows
  1246. Set the number of tiles as log2 of the number of tile rows and columns.
  1247. Provided for compatibility with libvpx/VP9.
  1248. @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
  1249. Enable row based multi-threading. Disabled by default.
  1250. @item enable-cdef (@emph{boolean})
  1251. Enable Constrained Directional Enhancement Filter. The libaom-av1
  1252. encoder enables CDEF by default.
  1253. @item enable-restoration (@emph{boolean})
  1254. Enable Loop Restoration Filter. Default is true for libaom-av1.
  1255. @item enable-global-motion (@emph{boolean})
  1256. Enable the use of global motion for block prediction. Default is true.
  1257. @item enable-intrabc (@emph{boolean})
  1258. Enable block copy mode for intra block prediction. This mode is
  1259. useful for screen content. Default is true.
  1260. @item enable-rect-partitions (@emph{boolean}) (Requires libaom >= v2.0.0)
  1261. Enable rectangular partitions. Default is true.
  1262. @item enable-1to4-partitions (@emph{boolean}) (Requires libaom >= v2.0.0)
  1263. Enable 1:4/4:1 partitions. Default is true.
  1264. @item enable-ab-partitions (@emph{boolean}) (Requires libaom >= v2.0.0)
  1265. Enable AB shape partitions. Default is true.
  1266. @item enable-angle-delta (@emph{boolean}) (Requires libaom >= v2.0.0)
  1267. Enable angle delta intra prediction. Default is true.
  1268. @item enable-cfl-intra (@emph{boolean}) (Requires libaom >= v2.0.0)
  1269. Enable chroma predicted from luma intra prediction. Default is true.
  1270. @item enable-filter-intra (@emph{boolean}) (Requires libaom >= v2.0.0)
  1271. Enable filter intra predictor. Default is true.
  1272. @item enable-intra-edge-filter (@emph{boolean}) (Requires libaom >= v2.0.0)
  1273. Enable intra edge filter. Default is true.
  1274. @item enable-smooth-intra (@emph{boolean}) (Requires libaom >= v2.0.0)
  1275. Enable smooth intra prediction mode. Default is true.
  1276. @item enable-paeth-intra (@emph{boolean}) (Requires libaom >= v2.0.0)
  1277. Enable paeth predictor in intra prediction. Default is true.
  1278. @item enable-palette (@emph{boolean}) (Requires libaom >= v2.0.0)
  1279. Enable palette prediction mode. Default is true.
  1280. @item enable-flip-idtx (@emph{boolean}) (Requires libaom >= v2.0.0)
  1281. Enable extended transform type, including FLIPADST_DCT, DCT_FLIPADST,
  1282. FLIPADST_FLIPADST, ADST_FLIPADST, FLIPADST_ADST, IDTX, V_DCT, H_DCT,
  1283. V_ADST, H_ADST, V_FLIPADST, H_FLIPADST. Default is true.
  1284. @item enable-tx64 (@emph{boolean}) (Requires libaom >= v2.0.0)
  1285. Enable 64-pt transform. Default is true.
  1286. @item reduced-tx-type-set (@emph{boolean}) (Requires libaom >= v2.0.0)
  1287. Use reduced set of transform types. Default is false.
  1288. @item use-intra-dct-only (@emph{boolean}) (Requires libaom >= v2.0.0)
  1289. Use DCT only for INTRA modes. Default is false.
  1290. @item use-inter-dct-only (@emph{boolean}) (Requires libaom >= v2.0.0)
  1291. Use DCT only for INTER modes. Default is false.
  1292. @item use-intra-default-tx-only (@emph{boolean}) (Requires libaom >= v2.0.0)
  1293. Use Default-transform only for INTRA modes. Default is false.
  1294. @item enable-ref-frame-mvs (@emph{boolean}) (Requires libaom >= v2.0.0)
  1295. Enable temporal mv prediction. Default is true.
  1296. @item enable-reduced-reference-set (@emph{boolean}) (Requires libaom >= v2.0.0)
  1297. Use reduced set of single and compound references. Default is false.
  1298. @item enable-obmc (@emph{boolean}) (Requires libaom >= v2.0.0)
  1299. Enable obmc. Default is true.
  1300. @item enable-dual-filter (@emph{boolean}) (Requires libaom >= v2.0.0)
  1301. Enable dual filter. Default is true.
  1302. @item enable-diff-wtd-comp (@emph{boolean}) (Requires libaom >= v2.0.0)
  1303. Enable difference-weighted compound. Default is true.
  1304. @item enable-dist-wtd-comp (@emph{boolean}) (Requires libaom >= v2.0.0)
  1305. Enable distance-weighted compound. Default is true.
  1306. @item enable-onesided-comp (@emph{boolean}) (Requires libaom >= v2.0.0)
  1307. Enable one sided compound. Default is true.
  1308. @item enable-interinter-wedge (@emph{boolean}) (Requires libaom >= v2.0.0)
  1309. Enable interinter wedge compound. Default is true.
  1310. @item enable-interintra-wedge (@emph{boolean}) (Requires libaom >= v2.0.0)
  1311. Enable interintra wedge compound. Default is true.
  1312. @item enable-masked-comp (@emph{boolean}) (Requires libaom >= v2.0.0)
  1313. Enable masked compound. Default is true.
  1314. @item enable-interintra-comp (@emph{boolean}) (Requires libaom >= v2.0.0)
  1315. Enable interintra compound. Default is true.
  1316. @item enable-smooth-interintra (@emph{boolean}) (Requires libaom >= v2.0.0)
  1317. Enable smooth interintra mode. Default is true.
  1318. @end table
  1319. @section libsvtav1
  1320. SVT-AV1 encoder wrapper.
  1321. Requires the presence of the SVT-AV1 headers and library during configuration.
  1322. You need to explicitly configure the build with @code{--enable-libsvtav1}.
  1323. @subsection Options
  1324. @table @option
  1325. @item profile
  1326. Set the encoding profile.
  1327. @item level
  1328. Set the operating point level.
  1329. @item tier
  1330. Set the operating point tier.
  1331. @item rc
  1332. Set the rate control mode to use.
  1333. Possible modes:
  1334. @table @option
  1335. @item cqp
  1336. Constant quantizer: use fixed values of qindex (dependent on the frame type)
  1337. throughout the stream. This mode is the default.
  1338. @item vbr
  1339. Variable bitrate: use a target bitrate for the whole stream.
  1340. @item cvbr
  1341. Constrained variable bitrate: use a target bitrate for each GOP.
  1342. @end table
  1343. @item qmax
  1344. Set the maximum quantizer to use when using a bitrate mode.
  1345. @item qmin
  1346. Set the minimum quantizer to use when using a bitrate mode.
  1347. @item qp
  1348. Set the quantizer used in cqp rate control mode (0-63).
  1349. @item sc_detection
  1350. Enable scene change detection.
  1351. @item la_depth
  1352. Set number of frames to look ahead (0-120).
  1353. @item preset
  1354. Set the quality-speed tradeoff, in the range 0 to 8. Higher values are
  1355. faster but lower quality. Defaults to 8 (highest speed).
  1356. @item tile_rows
  1357. Set log2 of the number of rows of tiles to use (0-6).
  1358. @item tile_columns
  1359. Set log2 of the number of columns of tiles to use (0-4).
  1360. @end table
  1361. @section libkvazaar
  1362. Kvazaar H.265/HEVC encoder.
  1363. Requires the presence of the libkvazaar headers and library during
  1364. configuration. You need to explicitly configure the build with
  1365. @option{--enable-libkvazaar}.
  1366. @subsection Options
  1367. @table @option
  1368. @item b
  1369. Set target video bitrate in bit/s and enable rate control.
  1370. @item kvazaar-params
  1371. Set kvazaar parameters as a list of @var{name}=@var{value} pairs separated
  1372. by commas (,). See kvazaar documentation for a list of options.
  1373. @end table
  1374. @section libopenh264
  1375. Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
  1376. This encoder requires the presence of the libopenh264 headers and
  1377. library during configuration. You need to explicitly configure the
  1378. build with @code{--enable-libopenh264}. The library is detected using
  1379. @command{pkg-config}.
  1380. For more information about the library see
  1381. @url{http://www.openh264.org}.
  1382. @subsection Options
  1383. The following FFmpeg global options affect the configurations of the
  1384. libopenh264 encoder.
  1385. @table @option
  1386. @item b
  1387. Set the bitrate (as a number of bits per second).
  1388. @item g
  1389. Set the GOP size.
  1390. @item maxrate
  1391. Set the max bitrate (as a number of bits per second).
  1392. @item flags +global_header
  1393. Set global header in the bitstream.
  1394. @item slices
  1395. Set the number of slices, used in parallelized encoding. Default value
  1396. is 0. This is only used when @option{slice_mode} is set to
  1397. @samp{fixed}.
  1398. @item slice_mode
  1399. Set slice mode. Can assume one of the following possible values:
  1400. @table @samp
  1401. @item fixed
  1402. a fixed number of slices
  1403. @item rowmb
  1404. one slice per row of macroblocks
  1405. @item auto
  1406. automatic number of slices according to number of threads
  1407. @item dyn
  1408. dynamic slicing
  1409. @end table
  1410. Default value is @samp{auto}.
  1411. @item loopfilter
  1412. Enable loop filter, if set to 1 (automatically enabled). To disable
  1413. set a value of 0.
  1414. @item profile
  1415. Set profile restrictions. If set to the value of @samp{main} enable
  1416. CABAC (set the @code{SEncParamExt.iEntropyCodingModeFlag} flag to 1).
  1417. @item max_nal_size
  1418. Set maximum NAL size in bytes.
  1419. @item allow_skip_frames
  1420. Allow skipping frames to hit the target bitrate if set to 1.
  1421. @end table
  1422. @section libtheora
  1423. libtheora Theora encoder wrapper.
  1424. Requires the presence of the libtheora headers and library during
  1425. configuration. You need to explicitly configure the build with
  1426. @code{--enable-libtheora}.
  1427. For more information about the libtheora project see
  1428. @url{http://www.theora.org/}.
  1429. @subsection Options
  1430. The following global options are mapped to internal libtheora options
  1431. which affect the quality and the bitrate of the encoded stream.
  1432. @table @option
  1433. @item b
  1434. Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode. In
  1435. case VBR (Variable Bit Rate) mode is enabled this option is ignored.
  1436. @item flags
  1437. Used to enable constant quality mode (VBR) encoding through the
  1438. @option{qscale} flag, and to enable the @code{pass1} and @code{pass2}
  1439. modes.
  1440. @item g
  1441. Set the GOP size.
  1442. @item global_quality
  1443. Set the global quality as an integer in lambda units.
  1444. Only relevant when VBR mode is enabled with @code{flags +qscale}. The
  1445. value is converted to QP units by dividing it by @code{FF_QP2LAMBDA},
  1446. clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
  1447. value in the native libtheora range [0-63]. A higher value corresponds
  1448. to a higher quality.
  1449. @item q
  1450. Enable VBR mode when set to a non-negative value, and set constant
  1451. quality value as a double floating point value in QP units.
  1452. The value is clipped in the [0-10] range, and then multiplied by 6.3
  1453. to get a value in the native libtheora range [0-63].
  1454. This option is valid only using the @command{ffmpeg} command-line
  1455. tool. For library interface users, use @option{global_quality}.
  1456. @end table
  1457. @subsection Examples
  1458. @itemize
  1459. @item
  1460. Set maximum constant quality (VBR) encoding with @command{ffmpeg}:
  1461. @example
  1462. ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
  1463. @end example
  1464. @item
  1465. Use @command{ffmpeg} to convert a CBR 1000 kbps Theora video stream:
  1466. @example
  1467. ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
  1468. @end example
  1469. @end itemize
  1470. @section libvpx
  1471. VP8/VP9 format supported through libvpx.
  1472. Requires the presence of the libvpx headers and library during configuration.
  1473. You need to explicitly configure the build with @code{--enable-libvpx}.
  1474. @subsection Options
  1475. The following options are supported by the libvpx wrapper. The
  1476. @command{vpxenc}-equivalent options or values are listed in parentheses
  1477. for easy migration.
  1478. To reduce the duplication of documentation, only the private options
  1479. and some others requiring special attention are documented here. For
  1480. the documentation of the undocumented generic options, see
  1481. @ref{codec-options,,the Codec Options chapter}.
  1482. To get more documentation of the libvpx options, invoke the command
  1483. @command{ffmpeg -h encoder=libvpx}, @command{ffmpeg -h encoder=libvpx-vp9} or
  1484. @command{vpxenc --help}. Further information is available in the libvpx API
  1485. documentation.
  1486. @table @option
  1487. @item b (@emph{target-bitrate})
  1488. Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
  1489. expressed in bits/s, while @command{vpxenc}'s @option{target-bitrate} is in
  1490. kilobits/s.
  1491. @item g (@emph{kf-max-dist})
  1492. @item keyint_min (@emph{kf-min-dist})
  1493. @item qmin (@emph{min-q})
  1494. @item qmax (@emph{max-q})
  1495. @item bufsize (@emph{buf-sz}, @emph{buf-optimal-sz})
  1496. Set ratecontrol buffer size (in bits). Note @command{vpxenc}'s options are
  1497. specified in milliseconds, the libvpx wrapper converts this value as follows:
  1498. @code{buf-sz = bufsize * 1000 / bitrate},
  1499. @code{buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6}.
  1500. @item rc_init_occupancy (@emph{buf-initial-sz})
  1501. Set number of bits which should be loaded into the rc buffer before decoding
  1502. starts. Note @command{vpxenc}'s option is specified in milliseconds, the libvpx
  1503. wrapper converts this value as follows:
  1504. @code{rc_init_occupancy * 1000 / bitrate}.
  1505. @item undershoot-pct
  1506. Set datarate undershoot (min) percentage of the target bitrate.
  1507. @item overshoot-pct
  1508. Set datarate overshoot (max) percentage of the target bitrate.
  1509. @item skip_threshold (@emph{drop-frame})
  1510. @item qcomp (@emph{bias-pct})
  1511. @item maxrate (@emph{maxsection-pct})
  1512. Set GOP max bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
  1513. percentage of the target bitrate, the libvpx wrapper converts this value as
  1514. follows: @code{(maxrate * 100 / bitrate)}.
  1515. @item minrate (@emph{minsection-pct})
  1516. Set GOP min bitrate in bits/s. Note @command{vpxenc}'s option is specified as a
  1517. percentage of the target bitrate, the libvpx wrapper converts this value as
  1518. follows: @code{(minrate * 100 / bitrate)}.
  1519. @item minrate, maxrate, b @emph{end-usage=cbr}
  1520. @code{(minrate == maxrate == bitrate)}.
  1521. @item crf (@emph{end-usage=cq}, @emph{cq-level})
  1522. @item tune (@emph{tune})
  1523. @table @samp
  1524. @item psnr (@emph{psnr})
  1525. @item ssim (@emph{ssim})
  1526. @end table
  1527. @item quality, deadline (@emph{deadline})
  1528. @table @samp
  1529. @item best
  1530. Use best quality deadline. Poorly named and quite slow, this option should be
  1531. avoided as it may give worse quality output than good.
  1532. @item good
  1533. Use good quality deadline. This is a good trade-off between speed and quality
  1534. when used with the @option{cpu-used} option.
  1535. @item realtime
  1536. Use realtime quality deadline.
  1537. @end table
  1538. @item speed, cpu-used (@emph{cpu-used})
  1539. Set quality/speed ratio modifier. Higher values speed up the encode at the cost
  1540. of quality.
  1541. @item nr (@emph{noise-sensitivity})
  1542. @item static-thresh
  1543. Set a change threshold on blocks below which they will be skipped by the
  1544. encoder.
  1545. @item slices (@emph{token-parts})
  1546. Note that FFmpeg's @option{slices} option gives the total number of partitions,
  1547. while @command{vpxenc}'s @option{token-parts} is given as
  1548. @code{log2(partitions)}.
  1549. @item max-intra-rate
  1550. Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
  1551. means unlimited.
  1552. @item force_key_frames
  1553. @code{VPX_EFLAG_FORCE_KF}
  1554. @item Alternate reference frame related
  1555. @table @option
  1556. @item auto-alt-ref
  1557. Enable use of alternate reference frames (2-pass only).
  1558. Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
  1559. @item arnr-maxframes
  1560. Set altref noise reduction max frame count.
  1561. @item arnr-type
  1562. Set altref noise reduction filter type: backward, forward, centered.
  1563. @item arnr-strength
  1564. Set altref noise reduction filter strength.
  1565. @item rc-lookahead, lag-in-frames (@emph{lag-in-frames})
  1566. Set number of frames to look ahead for frametype and ratecontrol.
  1567. @end table
  1568. @item error-resilient
  1569. Enable error resiliency features.
  1570. @item sharpness @var{integer}
  1571. Increase sharpness at the expense of lower PSNR.
  1572. The valid range is [0, 7].
  1573. @item ts-parameters
  1574. Sets the temporal scalability configuration using a :-separated list of
  1575. key=value pairs. For example, to specify temporal scalability parameters
  1576. with @code{ffmpeg}:
  1577. @example
  1578. ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
  1579. ts_target_bitrate=250,500,1000:ts_rate_decimator=4,2,1:\
  1580. ts_periodicity=4:ts_layer_id=0,2,1,2:ts_layering_mode=3 OUTPUT
  1581. @end example
  1582. Below is a brief explanation of each of the parameters, please
  1583. refer to @code{struct vpx_codec_enc_cfg} in @code{vpx/vpx_encoder.h} for more
  1584. details.
  1585. @table @option
  1586. @item ts_number_layers
  1587. Number of temporal coding layers.
  1588. @item ts_target_bitrate
  1589. Target bitrate for each temporal layer (in kbps).
  1590. (bitrate should be inclusive of the lower temporal layer).
  1591. @item ts_rate_decimator
  1592. Frame rate decimation factor for each temporal layer.
  1593. @item ts_periodicity
  1594. Length of the sequence defining frame temporal layer membership.
  1595. @item ts_layer_id
  1596. Template defining the membership of frames to temporal layers.
  1597. @item ts_layering_mode
  1598. (optional) Selecting the temporal structure from a set of pre-defined temporal layering modes.
  1599. Currently supports the following options.
  1600. @table @option
  1601. @item 0
  1602. No temporal layering flags are provided internally,
  1603. relies on flags being passed in using @code{metadata} field in @code{AVFrame}
  1604. with following keys.
  1605. @table @option
  1606. @item vp8-flags
  1607. Sets the flags passed into the encoder to indicate the referencing scheme for
  1608. the current frame.
  1609. Refer to function @code{vpx_codec_encode} in @code{vpx/vpx_encoder.h} for more
  1610. details.
  1611. @item temporal_id
  1612. Explicitly sets the temporal id of the current frame to encode.
  1613. @end table
  1614. @item 2
  1615. Two temporal layers. 0-1...
  1616. @item 3
  1617. Three temporal layers. 0-2-1-2...; with single reference frame.
  1618. @item 4
  1619. Same as option "3", except there is a dependency between
  1620. the two temporal layer 2 frames within the temporal period.
  1621. @end table
  1622. @end table
  1623. @item VP9-specific options
  1624. @table @option
  1625. @item lossless
  1626. Enable lossless mode.
  1627. @item tile-columns
  1628. Set number of tile columns to use. Note this is given as
  1629. @code{log2(tile_columns)}. For example, 8 tile columns would be requested by
  1630. setting the @option{tile-columns} option to 3.
  1631. @item tile-rows
  1632. Set number of tile rows to use. Note this is given as @code{log2(tile_rows)}.
  1633. For example, 4 tile rows would be requested by setting the @option{tile-rows}
  1634. option to 2.
  1635. @item frame-parallel
  1636. Enable frame parallel decodability features.
  1637. @item aq-mode
  1638. Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
  1639. cyclic refresh, 4: equator360).
  1640. @item colorspace @emph{color-space}
  1641. Set input color space. The VP9 bitstream supports signaling the following
  1642. colorspaces:
  1643. @table @option
  1644. @item @samp{rgb} @emph{sRGB}
  1645. @item @samp{bt709} @emph{bt709}
  1646. @item @samp{unspecified} @emph{unknown}
  1647. @item @samp{bt470bg} @emph{bt601}
  1648. @item @samp{smpte170m} @emph{smpte170}
  1649. @item @samp{smpte240m} @emph{smpte240}
  1650. @item @samp{bt2020_ncl} @emph{bt2020}
  1651. @end table
  1652. @item row-mt @var{boolean}
  1653. Enable row based multi-threading.
  1654. @item tune-content
  1655. Set content type: default (0), screen (1), film (2).
  1656. @item corpus-complexity
  1657. Corpus VBR mode is a variant of standard VBR where the complexity distribution
  1658. midpoint is passed in rather than calculated for a specific clip or chunk.
  1659. The valid range is [0, 10000]. 0 (default) uses standard VBR.
  1660. @item enable-tpl @var{boolean}
  1661. Enable temporal dependency model.
  1662. @end table
  1663. @end table
  1664. For more information about libvpx see:
  1665. @url{http://www.webmproject.org/}
  1666. @section libwebp
  1667. libwebp WebP Image encoder wrapper
  1668. libwebp is Google's official encoder for WebP images. It can encode in either
  1669. lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
  1670. frame. Lossless images are a separate codec developed by Google.
  1671. @subsection Pixel Format
  1672. Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
  1673. to limitations of the format and libwebp. Alpha is supported for either mode.
  1674. Because of API limitations, if RGB is passed in when encoding lossy or YUV is
  1675. passed in for encoding lossless, the pixel format will automatically be
  1676. converted using functions from libwebp. This is not ideal and is done only for
  1677. convenience.
  1678. @subsection Options
  1679. @table @option
  1680. @item -lossless @var{boolean}
  1681. Enables/Disables use of lossless mode. Default is 0.
  1682. @item -compression_level @var{integer}
  1683. For lossy, this is a quality/speed tradeoff. Higher values give better quality
  1684. for a given size at the cost of increased encoding time. For lossless, this is
  1685. a size/speed tradeoff. Higher values give smaller size at the cost of increased
  1686. encoding time. More specifically, it controls the number of extra algorithms
  1687. and compression tools used, and varies the combination of these tools. This
  1688. maps to the @var{method} option in libwebp. The valid range is 0 to 6.
  1689. Default is 4.
  1690. @item -qscale @var{float}
  1691. For lossy encoding, this controls image quality, 0 to 100. For lossless
  1692. encoding, this controls the effort and time spent at compressing more. The
  1693. default value is 75. Note that for usage via libavcodec, this option is called
  1694. @var{global_quality} and must be multiplied by @var{FF_QP2LAMBDA}.
  1695. @item -preset @var{type}
  1696. Configuration preset. This does some automatic settings based on the general
  1697. type of the image.
  1698. @table @option
  1699. @item none
  1700. Do not use a preset.
  1701. @item default
  1702. Use the encoder default.
  1703. @item picture
  1704. Digital picture, like portrait, inner shot
  1705. @item photo
  1706. Outdoor photograph, with natural lighting
  1707. @item drawing
  1708. Hand or line drawing, with high-contrast details
  1709. @item icon
  1710. Small-sized colorful images
  1711. @item text
  1712. Text-like
  1713. @end table
  1714. @end table
  1715. @section libx264, libx264rgb
  1716. x264 H.264/MPEG-4 AVC encoder wrapper.
  1717. This encoder requires the presence of the libx264 headers and library
  1718. during configuration. You need to explicitly configure the build with
  1719. @code{--enable-libx264}.
  1720. libx264 supports an impressive number of features, including 8x8 and
  1721. 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
  1722. entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
  1723. for detail retention (adaptive quantization, psy-RD, psy-trellis).
  1724. Many libx264 encoder options are mapped to FFmpeg global codec
  1725. options, while unique encoder options are provided through private
  1726. options. Additionally the @option{x264opts} and @option{x264-params}
  1727. private options allows one to pass a list of key=value tuples as accepted
  1728. by the libx264 @code{x264_param_parse} function.
  1729. The x264 project website is at
  1730. @url{http://www.videolan.org/developers/x264.html}.
  1731. The libx264rgb encoder is the same as libx264, except it accepts packed RGB
  1732. pixel formats as input instead of YUV.
  1733. @subsection Supported Pixel Formats
  1734. x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
  1735. x264's configure time. FFmpeg only supports one bit depth in one particular
  1736. build. In other words, it is not possible to build one FFmpeg with multiple
  1737. versions of x264 with different bit depths.
  1738. @subsection Options
  1739. The following options are supported by the libx264 wrapper. The
  1740. @command{x264}-equivalent options or values are listed in parentheses
  1741. for easy migration.
  1742. To reduce the duplication of documentation, only the private options
  1743. and some others requiring special attention are documented here. For
  1744. the documentation of the undocumented generic options, see
  1745. @ref{codec-options,,the Codec Options chapter}.
  1746. To get a more accurate and extensive documentation of the libx264
  1747. options, invoke the command @command{x264 --fullhelp} or consult
  1748. the libx264 documentation.
  1749. @table @option
  1750. @item b (@emph{bitrate})
  1751. Set bitrate in bits/s. Note that FFmpeg's @option{b} option is
  1752. expressed in bits/s, while @command{x264}'s @option{bitrate} is in
  1753. kilobits/s.
  1754. @item bf (@emph{bframes})
  1755. @item g (@emph{keyint})
  1756. @item qmin (@emph{qpmin})
  1757. Minimum quantizer scale.
  1758. @item qmax (@emph{qpmax})
  1759. Maximum quantizer scale.
  1760. @item qdiff (@emph{qpstep})
  1761. Maximum difference between quantizer scales.
  1762. @item qblur (@emph{qblur})
  1763. Quantizer curve blur
  1764. @item qcomp (@emph{qcomp})
  1765. Quantizer curve compression factor
  1766. @item refs (@emph{ref})
  1767. Number of reference frames each P-frame can use. The range is from @var{0-16}.
  1768. @item sc_threshold (@emph{scenecut})
  1769. Sets the threshold for the scene change detection.
  1770. @item trellis (@emph{trellis})
  1771. Performs Trellis quantization to increase efficiency. Enabled by default.
  1772. @item nr (@emph{nr})
  1773. @item me_range (@emph{merange})
  1774. Maximum range of the motion search in pixels.
  1775. @item me_method (@emph{me})
  1776. Set motion estimation method. Possible values in the decreasing order
  1777. of speed:
  1778. @table @samp
  1779. @item dia (@emph{dia})
  1780. @item epzs (@emph{dia})
  1781. Diamond search with radius 1 (fastest). @samp{epzs} is an alias for
  1782. @samp{dia}.
  1783. @item hex (@emph{hex})
  1784. Hexagonal search with radius 2.
  1785. @item umh (@emph{umh})
  1786. Uneven multi-hexagon search.
  1787. @item esa (@emph{esa})
  1788. Exhaustive search.
  1789. @item tesa (@emph{tesa})
  1790. Hadamard exhaustive search (slowest).
  1791. @end table
  1792. @item forced-idr
  1793. Normally, when forcing a I-frame type, the encoder can select any type
  1794. of I-frame. This option forces it to choose an IDR-frame.
  1795. @item subq (@emph{subme})
  1796. Sub-pixel motion estimation method.
  1797. @item b_strategy (@emph{b-adapt})
  1798. Adaptive B-frame placement decision algorithm. Use only on first-pass.
  1799. @item keyint_min (@emph{min-keyint})
  1800. Minimum GOP size.
  1801. @item coder
  1802. Set entropy encoder. Possible values:
  1803. @table @samp
  1804. @item ac
  1805. Enable CABAC.
  1806. @item vlc
  1807. Enable CAVLC and disable CABAC. It generates the same effect as
  1808. @command{x264}'s @option{--no-cabac} option.
  1809. @end table
  1810. @item cmp
  1811. Set full pixel motion estimation comparison algorithm. Possible values:
  1812. @table @samp
  1813. @item chroma
  1814. Enable chroma in motion estimation.
  1815. @item sad
  1816. Ignore chroma in motion estimation. It generates the same effect as
  1817. @command{x264}'s @option{--no-chroma-me} option.
  1818. @end table
  1819. @item threads (@emph{threads})
  1820. Number of encoding threads.
  1821. @item thread_type
  1822. Set multithreading technique. Possible values:
  1823. @table @samp
  1824. @item slice
  1825. Slice-based multithreading. It generates the same effect as
  1826. @command{x264}'s @option{--sliced-threads} option.
  1827. @item frame
  1828. Frame-based multithreading.
  1829. @end table
  1830. @item flags
  1831. Set encoding flags. It can be used to disable closed GOP and enable
  1832. open GOP by setting it to @code{-cgop}. The result is similar to
  1833. the behavior of @command{x264}'s @option{--open-gop} option.
  1834. @item rc_init_occupancy (@emph{vbv-init})
  1835. @item preset (@emph{preset})
  1836. Set the encoding preset.
  1837. @item tune (@emph{tune})
  1838. Set tuning of the encoding params.
  1839. @item profile (@emph{profile})
  1840. Set profile restrictions.
  1841. @item fastfirstpass
  1842. Enable fast settings when encoding first pass, when set to 1. When set
  1843. to 0, it has the same effect of @command{x264}'s
  1844. @option{--slow-firstpass} option.
  1845. @item crf (@emph{crf})
  1846. Set the quality for constant quality mode.
  1847. @item crf_max (@emph{crf-max})
  1848. In CRF mode, prevents VBV from lowering quality beyond this point.
  1849. @item qp (@emph{qp})
  1850. Set constant quantization rate control method parameter.
  1851. @item aq-mode (@emph{aq-mode})
  1852. Set AQ method. Possible values:
  1853. @table @samp
  1854. @item none (@emph{0})
  1855. Disabled.
  1856. @item variance (@emph{1})
  1857. Variance AQ (complexity mask).
  1858. @item autovariance (@emph{2})
  1859. Auto-variance AQ (experimental).
  1860. @end table
  1861. @item aq-strength (@emph{aq-strength})
  1862. Set AQ strength, reduce blocking and blurring in flat and textured areas.
  1863. @item psy
  1864. Use psychovisual optimizations when set to 1. When set to 0, it has the
  1865. same effect as @command{x264}'s @option{--no-psy} option.
  1866. @item psy-rd (@emph{psy-rd})
  1867. Set strength of psychovisual optimization, in
  1868. @var{psy-rd}:@var{psy-trellis} format.
  1869. @item rc-lookahead (@emph{rc-lookahead})
  1870. Set number of frames to look ahead for frametype and ratecontrol.
  1871. @item weightb
  1872. Enable weighted prediction for B-frames when set to 1. When set to 0,
  1873. it has the same effect as @command{x264}'s @option{--no-weightb} option.
  1874. @item weightp (@emph{weightp})
  1875. Set weighted prediction method for P-frames. Possible values:
  1876. @table @samp
  1877. @item none (@emph{0})
  1878. Disabled
  1879. @item simple (@emph{1})
  1880. Enable only weighted refs
  1881. @item smart (@emph{2})
  1882. Enable both weighted refs and duplicates
  1883. @end table
  1884. @item ssim (@emph{ssim})
  1885. Enable calculation and printing SSIM stats after the encoding.
  1886. @item intra-refresh (@emph{intra-refresh})
  1887. Enable the use of Periodic Intra Refresh instead of IDR frames when set
  1888. to 1.
  1889. @item avcintra-class (@emph{class})
  1890. Configure the encoder to generate AVC-Intra.
  1891. Valid values are 50,100 and 200
  1892. @item bluray-compat (@emph{bluray-compat})
  1893. Configure the encoder to be compatible with the bluray standard.
  1894. It is a shorthand for setting "bluray-compat=1 force-cfr=1".
  1895. @item b-bias (@emph{b-bias})
  1896. Set the influence on how often B-frames are used.
  1897. @item b-pyramid (@emph{b-pyramid})
  1898. Set method for keeping of some B-frames as references. Possible values:
  1899. @table @samp
  1900. @item none (@emph{none})
  1901. Disabled.
  1902. @item strict (@emph{strict})
  1903. Strictly hierarchical pyramid.
  1904. @item normal (@emph{normal})
  1905. Non-strict (not Blu-ray compatible).
  1906. @end table
  1907. @item mixed-refs
  1908. Enable the use of one reference per partition, as opposed to one
  1909. reference per macroblock when set to 1. When set to 0, it has the
  1910. same effect as @command{x264}'s @option{--no-mixed-refs} option.
  1911. @item 8x8dct
  1912. Enable adaptive spatial transform (high profile 8x8 transform)
  1913. when set to 1. When set to 0, it has the same effect as
  1914. @command{x264}'s @option{--no-8x8dct} option.
  1915. @item fast-pskip
  1916. Enable early SKIP detection on P-frames when set to 1. When set
  1917. to 0, it has the same effect as @command{x264}'s
  1918. @option{--no-fast-pskip} option.
  1919. @item aud (@emph{aud})
  1920. Enable use of access unit delimiters when set to 1.
  1921. @item mbtree
  1922. Enable use macroblock tree ratecontrol when set to 1. When set
  1923. to 0, it has the same effect as @command{x264}'s
  1924. @option{--no-mbtree} option.
  1925. @item deblock (@emph{deblock})
  1926. Set loop filter parameters, in @var{alpha}:@var{beta} form.
  1927. @item cplxblur (@emph{cplxblur})
  1928. Set fluctuations reduction in QP (before curve compression).
  1929. @item partitions (@emph{partitions})
  1930. Set partitions to consider as a comma-separated list of. Possible
  1931. values in the list:
  1932. @table @samp
  1933. @item p8x8
  1934. 8x8 P-frame partition.
  1935. @item p4x4
  1936. 4x4 P-frame partition.
  1937. @item b8x8
  1938. 4x4 B-frame partition.
  1939. @item i8x8
  1940. 8x8 I-frame partition.
  1941. @item i4x4
  1942. 4x4 I-frame partition.
  1943. (Enabling @samp{p4x4} requires @samp{p8x8} to be enabled. Enabling
  1944. @samp{i8x8} requires adaptive spatial transform (@option{8x8dct}
  1945. option) to be enabled.)
  1946. @item none (@emph{none})
  1947. Do not consider any partitions.
  1948. @item all (@emph{all})
  1949. Consider every partition.
  1950. @end table
  1951. @item direct-pred (@emph{direct})
  1952. Set direct MV prediction mode. Possible values:
  1953. @table @samp
  1954. @item none (@emph{none})
  1955. Disable MV prediction.
  1956. @item spatial (@emph{spatial})
  1957. Enable spatial predicting.
  1958. @item temporal (@emph{temporal})
  1959. Enable temporal predicting.
  1960. @item auto (@emph{auto})
  1961. Automatically decided.
  1962. @end table
  1963. @item slice-max-size (@emph{slice-max-size})
  1964. Set the limit of the size of each slice in bytes. If not specified
  1965. but RTP payload size (@option{ps}) is specified, that is used.
  1966. @item stats (@emph{stats})
  1967. Set the file name for multi-pass stats.
  1968. @item nal-hrd (@emph{nal-hrd})
  1969. Set signal HRD information (requires @option{vbv-bufsize} to be set).
  1970. Possible values:
  1971. @table @samp
  1972. @item none (@emph{none})
  1973. Disable HRD information signaling.
  1974. @item vbr (@emph{vbr})
  1975. Variable bit rate.
  1976. @item cbr (@emph{cbr})
  1977. Constant bit rate (not allowed in MP4 container).
  1978. @end table
  1979. @item x264opts (N.A.)
  1980. Set any x264 option, see @command{x264 --fullhelp} for a list.
  1981. Argument is a list of @var{key}=@var{value} couples separated by
  1982. ":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
  1983. themselves, use "," instead. They accept it as well since long ago but this
  1984. is kept undocumented for some reason.
  1985. For example to specify libx264 encoding options with @command{ffmpeg}:
  1986. @example
  1987. ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
  1988. @end example
  1989. @item a53cc @var{boolean}
  1990. Import closed captions (which must be ATSC compatible format) into output.
  1991. Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
  1992. @item x264-params (N.A.)
  1993. Override the x264 configuration using a :-separated list of key=value
  1994. parameters.
  1995. This option is functionally the same as the @option{x264opts}, but is
  1996. duplicated for compatibility with the Libav fork.
  1997. For example to specify libx264 encoding options with @command{ffmpeg}:
  1998. @example
  1999. ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
  2000. cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
  2001. no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
  2002. @end example
  2003. @end table
  2004. Encoding ffpresets for common usages are provided so they can be used with the
  2005. general presets system (e.g. passing the @option{pre} option).
  2006. @section libx265
  2007. x265 H.265/HEVC encoder wrapper.
  2008. This encoder requires the presence of the libx265 headers and library
  2009. during configuration. You need to explicitly configure the build with
  2010. @option{--enable-libx265}.
  2011. @subsection Options
  2012. @table @option
  2013. @item b
  2014. Sets target video bitrate.
  2015. @item bf
  2016. @item g
  2017. Set the GOP size.
  2018. @item keyint_min
  2019. Minimum GOP size.
  2020. @item refs
  2021. Number of reference frames each P-frame can use. The range is from @var{1-16}.
  2022. @item preset
  2023. Set the x265 preset.
  2024. @item tune
  2025. Set the x265 tune parameter.
  2026. @item profile
  2027. Set profile restrictions.
  2028. @item crf
  2029. Set the quality for constant quality mode.
  2030. @item qp
  2031. Set constant quantization rate control method parameter.
  2032. @item qmin
  2033. Minimum quantizer scale.
  2034. @item qmax
  2035. Maximum quantizer scale.
  2036. @item qdiff
  2037. Maximum difference between quantizer scales.
  2038. @item qblur
  2039. Quantizer curve blur
  2040. @item qcomp
  2041. Quantizer curve compression factor
  2042. @item i_qfactor
  2043. @item b_qfactor
  2044. @item forced-idr
  2045. Normally, when forcing a I-frame type, the encoder can select any type
  2046. of I-frame. This option forces it to choose an IDR-frame.
  2047. @item x265-params
  2048. Set x265 options using a list of @var{key}=@var{value} couples separated
  2049. by ":". See @command{x265 --help} for a list of options.
  2050. For example to specify libx265 encoding options with @option{-x265-params}:
  2051. @example
  2052. ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
  2053. @end example
  2054. @end table
  2055. @section libxavs2
  2056. xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
  2057. This encoder requires the presence of the libxavs2 headers and library
  2058. during configuration. You need to explicitly configure the build with
  2059. @option{--enable-libxavs2}.
  2060. The following standard libavcodec options are used:
  2061. @itemize
  2062. @item
  2063. @option{b} / @option{bit_rate}
  2064. @item
  2065. @option{g} / @option{gop_size}
  2066. @item
  2067. @option{bf} / @option{max_b_frames}
  2068. @end itemize
  2069. The encoder also has its own specific options:
  2070. @subsection Options
  2071. @table @option
  2072. @item lcu_row_threads
  2073. Set the number of parallel threads for rows from 1 to 8 (default 5).
  2074. @item initial_qp
  2075. Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  2076. used to set the initial qp for the first frame.
  2077. @item qp
  2078. Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  2079. used to set the qp value under constant-QP mode.
  2080. @item max_qp
  2081. Set the max qp for rate control from 1 to 63 (default 55).
  2082. @item min_qp
  2083. Set the min qp for rate control from 1 to 63 (default 20).
  2084. @item speed_level
  2085. Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
  2086. @item log_level
  2087. Set the log level from -1 to 3 (default 0). -1: none, 0: error,
  2088. 1: warning, 2: info, 3: debug.
  2089. @item xavs2-params
  2090. Set xavs2 options using a list of @var{key}=@var{value} couples separated
  2091. by ":".
  2092. For example to specify libxavs2 encoding options with @option{-xavs2-params}:
  2093. @example
  2094. ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
  2095. @end example
  2096. @end table
  2097. @section libxvid
  2098. Xvid MPEG-4 Part 2 encoder wrapper.
  2099. This encoder requires the presence of the libxvidcore headers and library
  2100. during configuration. You need to explicitly configure the build with
  2101. @code{--enable-libxvid --enable-gpl}.
  2102. The native @code{mpeg4} encoder supports the MPEG-4 Part 2 format, so
  2103. users can encode to this format without this library.
  2104. @subsection Options
  2105. The following options are supported by the libxvid wrapper. Some of
  2106. the following options are listed but are not documented, and
  2107. correspond to shared codec options. See @ref{codec-options,,the Codec
  2108. Options chapter} for their documentation. The other shared options
  2109. which are not listed have no effect for the libxvid encoder.
  2110. @table @option
  2111. @item b
  2112. @item g
  2113. @item qmin
  2114. @item qmax
  2115. @item mpeg_quant
  2116. @item threads
  2117. @item bf
  2118. @item b_qfactor
  2119. @item b_qoffset
  2120. @item flags
  2121. Set specific encoding flags. Possible values:
  2122. @table @samp
  2123. @item mv4
  2124. Use four motion vector by macroblock.
  2125. @item aic
  2126. Enable high quality AC prediction.
  2127. @item gray
  2128. Only encode grayscale.
  2129. @item gmc
  2130. Enable the use of global motion compensation (GMC).
  2131. @item qpel
  2132. Enable quarter-pixel motion compensation.
  2133. @item cgop
  2134. Enable closed GOP.
  2135. @item global_header
  2136. Place global headers in extradata instead of every keyframe.
  2137. @end table
  2138. @item trellis
  2139. @item me_method
  2140. Set motion estimation method. Possible values in decreasing order of
  2141. speed and increasing order of quality:
  2142. @table @samp
  2143. @item zero
  2144. Use no motion estimation (default).
  2145. @item phods
  2146. @item x1
  2147. @item log
  2148. Enable advanced diamond zonal search for 16x16 blocks and half-pixel
  2149. refinement for 16x16 blocks. @samp{x1} and @samp{log} are aliases for
  2150. @samp{phods}.
  2151. @item epzs
  2152. Enable all of the things described above, plus advanced diamond zonal
  2153. search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
  2154. estimation on chroma planes.
  2155. @item full
  2156. Enable all of the things described above, plus extended 16x16 and 8x8
  2157. blocks search.
  2158. @end table
  2159. @item mbd
  2160. Set macroblock decision algorithm. Possible values in the increasing
  2161. order of quality:
  2162. @table @samp
  2163. @item simple
  2164. Use macroblock comparing function algorithm (default).
  2165. @item bits
  2166. Enable rate distortion-based half pixel and quarter pixel refinement for
  2167. 16x16 blocks.
  2168. @item rd
  2169. Enable all of the things described above, plus rate distortion-based
  2170. half pixel and quarter pixel refinement for 8x8 blocks, and rate
  2171. distortion-based search using square pattern.
  2172. @end table
  2173. @item lumi_aq
  2174. Enable lumi masking adaptive quantization when set to 1. Default is 0
  2175. (disabled).
  2176. @item variance_aq
  2177. Enable variance adaptive quantization when set to 1. Default is 0
  2178. (disabled).
  2179. When combined with @option{lumi_aq}, the resulting quality will not
  2180. be better than any of the two specified individually. In other
  2181. words, the resulting quality will be the worse one of the two
  2182. effects.
  2183. @item ssim
  2184. Set structural similarity (SSIM) displaying method. Possible values:
  2185. @table @samp
  2186. @item off
  2187. Disable displaying of SSIM information.
  2188. @item avg
  2189. Output average SSIM at the end of encoding to stdout. The format of
  2190. showing the average SSIM is:
  2191. @example
  2192. Average SSIM: %f
  2193. @end example
  2194. For users who are not familiar with C, %f means a float number, or
  2195. a decimal (e.g. 0.939232).
  2196. @item frame
  2197. Output both per-frame SSIM data during encoding and average SSIM at
  2198. the end of encoding to stdout. The format of per-frame information
  2199. is:
  2200. @example
  2201. SSIM: avg: %1.3f min: %1.3f max: %1.3f
  2202. @end example
  2203. For users who are not familiar with C, %1.3f means a float number
  2204. rounded to 3 digits after the dot (e.g. 0.932).
  2205. @end table
  2206. @item ssim_acc
  2207. Set SSIM accuracy. Valid options are integers within the range of
  2208. 0-4, while 0 gives the most accurate result and 4 computes the
  2209. fastest.
  2210. @end table
  2211. @section MediaFoundation
  2212. This provides wrappers to encoders (both audio and video) in the
  2213. MediaFoundation framework. It can access both SW and HW encoders.
  2214. Video encoders can take input in either of nv12 or yuv420p form
  2215. (some encoders support both, some support only either - in practice,
  2216. nv12 is the safer choice, especially among HW encoders).
  2217. @section mpeg2
  2218. MPEG-2 video encoder.
  2219. @subsection Options
  2220. @table @option
  2221. @item profile
  2222. Select the mpeg2 profile to encode:
  2223. @table @samp
  2224. @item 422
  2225. @item high
  2226. @item ss
  2227. Spatially Scalable
  2228. @item snr
  2229. SNR Scalable
  2230. @item main
  2231. @item simple
  2232. @end table
  2233. @item level
  2234. Select the mpeg2 level to encode:
  2235. @table @samp
  2236. @item high
  2237. @item high1440
  2238. @item main
  2239. @item low
  2240. @end table
  2241. @item seq_disp_ext @var{integer}
  2242. Specifies if the encoder should write a sequence_display_extension to the
  2243. output.
  2244. @table @option
  2245. @item -1
  2246. @itemx auto
  2247. Decide automatically to write it or not (this is the default) by checking if
  2248. the data to be written is different from the default or unspecified values.
  2249. @item 0
  2250. @itemx never
  2251. Never write it.
  2252. @item 1
  2253. @itemx always
  2254. Always write it.
  2255. @end table
  2256. @item video_format @var{integer}
  2257. Specifies the video_format written into the sequence display extension
  2258. indicating the source of the video pictures. The default is @samp{unspecified},
  2259. can be @samp{component}, @samp{pal}, @samp{ntsc}, @samp{secam} or @samp{mac}.
  2260. For maximum compatibility, use @samp{component}.
  2261. @item a53cc @var{boolean}
  2262. Import closed captions (which must be ATSC compatible format) into output.
  2263. Default is 1 (on).
  2264. @end table
  2265. @section png
  2266. PNG image encoder.
  2267. @subsection Private options
  2268. @table @option
  2269. @item dpi @var{integer}
  2270. Set physical density of pixels, in dots per inch, unset by default
  2271. @item dpm @var{integer}
  2272. Set physical density of pixels, in dots per meter, unset by default
  2273. @end table
  2274. @section ProRes
  2275. Apple ProRes encoder.
  2276. FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
  2277. The used encoder can be chosen with the @code{-vcodec} option.
  2278. @subsection Private Options for prores-ks
  2279. @table @option
  2280. @item profile @var{integer}
  2281. Select the ProRes profile to encode
  2282. @table @samp
  2283. @item proxy
  2284. @item lt
  2285. @item standard
  2286. @item hq
  2287. @item 4444
  2288. @item 4444xq
  2289. @end table
  2290. @item quant_mat @var{integer}
  2291. Select quantization matrix.
  2292. @table @samp
  2293. @item auto
  2294. @item default
  2295. @item proxy
  2296. @item lt
  2297. @item standard
  2298. @item hq
  2299. @end table
  2300. If set to @var{auto}, the matrix matching the profile will be picked.
  2301. If not set, the matrix providing the highest quality, @var{default}, will be
  2302. picked.
  2303. @item bits_per_mb @var{integer}
  2304. How many bits to allot for coding one macroblock. Different profiles use
  2305. between 200 and 2400 bits per macroblock, the maximum is 8000.
  2306. @item mbs_per_slice @var{integer}
  2307. Number of macroblocks in each slice (1-8); the default value (8)
  2308. should be good in almost all situations.
  2309. @item vendor @var{string}
  2310. Override the 4-byte vendor ID.
  2311. A custom vendor ID like @var{apl0} would claim the stream was produced by
  2312. the Apple encoder.
  2313. @item alpha_bits @var{integer}
  2314. Specify number of bits for alpha component.
  2315. Possible values are @var{0}, @var{8} and @var{16}.
  2316. Use @var{0} to disable alpha plane coding.
  2317. @end table
  2318. @subsection Speed considerations
  2319. In the default mode of operation the encoder has to honor frame constraints
  2320. (i.e. not produce frames with size bigger than requested) while still making
  2321. output picture as good as possible.
  2322. A frame containing a lot of small details is harder to compress and the encoder
  2323. would spend more time searching for appropriate quantizers for each slice.
  2324. Setting a higher @option{bits_per_mb} limit will improve the speed.
  2325. For the fastest encoding speed set the @option{qscale} parameter (4 is the
  2326. recommended value) and do not set a size constraint.
  2327. @section QSV encoders
  2328. The family of Intel QuickSync Video encoders (MPEG-2, H.264, HEVC, JPEG/MJPEG and VP9)
  2329. The ratecontrol method is selected as follows:
  2330. @itemize @bullet
  2331. @item
  2332. When @option{global_quality} is specified, a quality-based mode is used.
  2333. Specifically this means either
  2334. @itemize @minus
  2335. @item
  2336. @var{CQP} - constant quantizer scale, when the @option{qscale} codec flag is
  2337. also set (the @option{-qscale} ffmpeg option).
  2338. @item
  2339. @var{LA_ICQ} - intelligent constant quality with lookahead, when the
  2340. @option{look_ahead} option is also set.
  2341. @item
  2342. @var{ICQ} -- intelligent constant quality otherwise.
  2343. @end itemize
  2344. @item
  2345. Otherwise, a bitrate-based mode is used. For all of those, you should specify at
  2346. least the desired average bitrate with the @option{b} option.
  2347. @itemize @minus
  2348. @item
  2349. @var{LA} - VBR with lookahead, when the @option{look_ahead} option is specified.
  2350. @item
  2351. @var{VCM} - video conferencing mode, when the @option{vcm} option is set.
  2352. @item
  2353. @var{CBR} - constant bitrate, when @option{maxrate} is specified and equal to
  2354. the average bitrate.
  2355. @item
  2356. @var{VBR} - variable bitrate, when @option{maxrate} is specified, but is higher
  2357. than the average bitrate.
  2358. @item
  2359. @var{AVBR} - average VBR mode, when @option{maxrate} is not specified. This mode
  2360. is further configured by the @option{avbr_accuracy} and
  2361. @option{avbr_convergence} options.
  2362. @end itemize
  2363. @end itemize
  2364. Note that depending on your system, a different mode than the one you specified
  2365. may be selected by the encoder. Set the verbosity level to @var{verbose} or
  2366. higher to see the actual settings used by the QSV runtime.
  2367. Additional libavcodec global options are mapped to MSDK options as follows:
  2368. @itemize
  2369. @item
  2370. @option{g/gop_size} -> @option{GopPicSize}
  2371. @item
  2372. @option{bf/max_b_frames}+1 -> @option{GopRefDist}
  2373. @item
  2374. @option{rc_init_occupancy/rc_initial_buffer_occupancy} ->
  2375. @option{InitialDelayInKB}
  2376. @item
  2377. @option{slices} -> @option{NumSlice}
  2378. @item
  2379. @option{refs} -> @option{NumRefFrame}
  2380. @item
  2381. @option{b_strategy/b_frame_strategy} -> @option{BRefType}
  2382. @item
  2383. @option{cgop/CLOSED_GOP} codec flag -> @option{GopOptFlag}
  2384. @item
  2385. For the @var{CQP} mode, the @option{i_qfactor/i_qoffset} and
  2386. @option{b_qfactor/b_qoffset} set the difference between @var{QPP} and @var{QPI},
  2387. and @var{QPP} and @var{QPB} respectively.
  2388. @item
  2389. Setting the @option{coder} option to the value @var{vlc} will make the H.264
  2390. encoder use CAVLC instead of CABAC.
  2391. @end itemize
  2392. @section snow
  2393. @subsection Options
  2394. @table @option
  2395. @item iterative_dia_size
  2396. dia size for the iterative motion estimation
  2397. @end table
  2398. @section VAAPI encoders
  2399. Wrappers for hardware encoders accessible via VAAPI.
  2400. These encoders only accept input in VAAPI hardware surfaces. If you have input
  2401. in software frames, use the @option{hwupload} filter to upload them to the GPU.
  2402. The following standard libavcodec options are used:
  2403. @itemize
  2404. @item
  2405. @option{g} / @option{gop_size}
  2406. @item
  2407. @option{bf} / @option{max_b_frames}
  2408. @item
  2409. @option{profile}
  2410. If not set, this will be determined automatically from the format of the input
  2411. frames and the profiles supported by the driver.
  2412. @item
  2413. @option{level}
  2414. @item
  2415. @option{b} / @option{bit_rate}
  2416. @item
  2417. @option{maxrate} / @option{rc_max_rate}
  2418. @item
  2419. @option{bufsize} / @option{rc_buffer_size}
  2420. @item
  2421. @option{rc_init_occupancy} / @option{rc_initial_buffer_occupancy}
  2422. @item
  2423. @option{compression_level}
  2424. Speed / quality tradeoff: higher values are faster / worse quality.
  2425. @item
  2426. @option{q} / @option{global_quality}
  2427. Size / quality tradeoff: higher values are smaller / worse quality.
  2428. @item
  2429. @option{qmin}
  2430. @item
  2431. @option{qmax}
  2432. @item
  2433. @option{i_qfactor} / @option{i_quant_factor}
  2434. @item
  2435. @option{i_qoffset} / @option{i_quant_offset}
  2436. @item
  2437. @option{b_qfactor} / @option{b_quant_factor}
  2438. @item
  2439. @option{b_qoffset} / @option{b_quant_offset}
  2440. @item
  2441. @option{slices}
  2442. @end itemize
  2443. All encoders support the following options:
  2444. @table @option
  2445. @item low_power
  2446. Some drivers/platforms offer a second encoder for some codecs intended to use
  2447. less power than the default encoder; setting this option will attempt to use
  2448. that encoder. Note that it may support a reduced feature set, so some other
  2449. options may not be available in this mode.
  2450. @item idr_interval
  2451. Set the number of normal intra frames between full-refresh (IDR) frames in
  2452. open-GOP mode. The intra frames are still IRAPs, but will not include global
  2453. headers and may have non-decodable leading pictures.
  2454. @item b_depth
  2455. Set the B-frame reference depth. When set to one (the default), all B-frames
  2456. will refer only to P- or I-frames. When set to greater values multiple layers
  2457. of B-frames will be present, frames in each layer only referring to frames in
  2458. higher layers.
  2459. @item rc_mode
  2460. Set the rate control mode to use. A given driver may only support a subset of
  2461. modes.
  2462. Possible modes:
  2463. @table @option
  2464. @item auto
  2465. Choose the mode automatically based on driver support and the other options.
  2466. This is the default.
  2467. @item CQP
  2468. Constant-quality.
  2469. @item CBR
  2470. Constant-bitrate.
  2471. @item VBR
  2472. Variable-bitrate.
  2473. @item ICQ
  2474. Intelligent constant-quality.
  2475. @item QVBR
  2476. Quality-defined variable-bitrate.
  2477. @item AVBR
  2478. Average variable bitrate.
  2479. @end table
  2480. @end table
  2481. Each encoder also has its own specific options:
  2482. @table @option
  2483. @item h264_vaapi
  2484. @option{profile} sets the value of @emph{profile_idc} and the @emph{constraint_set*_flag}s.
  2485. @option{level} sets the value of @emph{level_idc}.
  2486. @table @option
  2487. @item coder
  2488. Set entropy encoder (default is @emph{cabac}). Possible values:
  2489. @table @samp
  2490. @item ac
  2491. @item cabac
  2492. Use CABAC.
  2493. @item vlc
  2494. @item cavlc
  2495. Use CAVLC.
  2496. @end table
  2497. @item aud
  2498. Include access unit delimiters in the stream (not included by default).
  2499. @item sei
  2500. Set SEI message types to include.
  2501. Some combination of the following values:
  2502. @table @samp
  2503. @item identifier
  2504. Include a @emph{user_data_unregistered} message containing information about
  2505. the encoder.
  2506. @item timing
  2507. Include picture timing parameters (@emph{buffering_period} and
  2508. @emph{pic_timing} messages).
  2509. @item recovery_point
  2510. Include recovery points where appropriate (@emph{recovery_point} messages).
  2511. @end table
  2512. @end table
  2513. @item hevc_vaapi
  2514. @option{profile} and @option{level} set the values of
  2515. @emph{general_profile_idc} and @emph{general_level_idc} respectively.
  2516. @table @option
  2517. @item aud
  2518. Include access unit delimiters in the stream (not included by default).
  2519. @item tier
  2520. Set @emph{general_tier_flag}. This may affect the level chosen for the stream
  2521. if it is not explicitly specified.
  2522. @item sei
  2523. Set SEI message types to include.
  2524. Some combination of the following values:
  2525. @table @samp
  2526. @item hdr
  2527. Include HDR metadata if the input frames have it
  2528. (@emph{mastering_display_colour_volume} and @emph{content_light_level}
  2529. messages).
  2530. @end table
  2531. @item tiles
  2532. Set the number of tiles to encode the input video with, as columns x rows.
  2533. Larger numbers allow greater parallelism in both encoding and decoding, but
  2534. may decrease coding efficiency.
  2535. @end table
  2536. @item mjpeg_vaapi
  2537. Only baseline DCT encoding is supported. The encoder always uses the standard
  2538. quantisation and huffman tables - @option{global_quality} scales the standard
  2539. quantisation table (range 1-100).
  2540. For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported. RGB is also
  2541. supported, and will create an RGB JPEG.
  2542. @table @option
  2543. @item jfif
  2544. Include JFIF header in each frame (not included by default).
  2545. @item huffman
  2546. Include standard huffman tables (on by default). Turning this off will save
  2547. a few hundred bytes in each output frame, but may lose compatibility with some
  2548. JPEG decoders which don't fully handle MJPEG.
  2549. @end table
  2550. @item mpeg2_vaapi
  2551. @option{profile} and @option{level} set the value of @emph{profile_and_level_indication}.
  2552. @item vp8_vaapi
  2553. B-frames are not supported.
  2554. @option{global_quality} sets the @emph{q_idx} used for non-key frames (range 0-127).
  2555. @table @option
  2556. @item loop_filter_level
  2557. @item loop_filter_sharpness
  2558. Manually set the loop filter parameters.
  2559. @end table
  2560. @item vp9_vaapi
  2561. @option{global_quality} sets the @emph{q_idx} used for P-frames (range 0-255).
  2562. @table @option
  2563. @item loop_filter_level
  2564. @item loop_filter_sharpness
  2565. Manually set the loop filter parameters.
  2566. @end table
  2567. B-frames are supported, but the output stream is always in encode order rather than display
  2568. order. If B-frames are enabled, it may be necessary to use the @option{vp9_raw_reorder}
  2569. bitstream filter to modify the output stream to display frames in the correct order.
  2570. Only normal frames are produced - the @option{vp9_superframe} bitstream filter may be
  2571. required to produce a stream usable with all decoders.
  2572. @end table
  2573. @section vc2
  2574. SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
  2575. professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
  2576. 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
  2577. other tasks which require low overhead and low compression (like screen
  2578. recording).
  2579. @subsection Options
  2580. @table @option
  2581. @item b
  2582. Sets target video bitrate. Usually that's around 1:6 of the uncompressed
  2583. video bitrate (e.g. for 1920x1080 50fps yuv422p10 that's around 400Mbps). Higher
  2584. values (close to the uncompressed bitrate) turn on lossless compression mode.
  2585. @item field_order
  2586. Enables field coding when set (e.g. to tt - top field first) for interlaced
  2587. inputs. Should increase compression with interlaced content as it splits the
  2588. fields and encodes each separately.
  2589. @item wavelet_depth
  2590. Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
  2591. Lower values reduce compression and quality. Less capable decoders may not be
  2592. able to handle values of @option{wavelet_depth} over 3.
  2593. @item wavelet_type
  2594. Sets the transform type. Currently only @var{5_3} (LeGall) and @var{9_7}
  2595. (Deslauriers-Dubuc)
  2596. are implemented, with 9_7 being the one with better compression and thus
  2597. is the default.
  2598. @item slice_width
  2599. @item slice_height
  2600. Sets the slice size for each slice. Larger values result in better compression.
  2601. For compatibility with other more limited decoders use @option{slice_width} of
  2602. 32 and @option{slice_height} of 8.
  2603. @item tolerance
  2604. Sets the undershoot tolerance of the rate control system in percent. This is
  2605. to prevent an expensive search from being run.
  2606. @item qm
  2607. Sets the quantization matrix preset to use by default or when @option{wavelet_depth}
  2608. is set to 5
  2609. @itemize @minus
  2610. @item
  2611. @var{default}
  2612. Uses the default quantization matrix from the specifications, extended with
  2613. values for the fifth level. This provides a good balance between keeping detail
  2614. and omitting artifacts.
  2615. @item
  2616. @var{flat}
  2617. Use a completely zeroed out quantization matrix. This increases PSNR but might
  2618. reduce perception. Use in bogus benchmarks.
  2619. @item
  2620. @var{color}
  2621. Reduces detail but attempts to preserve color at extremely low bitrates.
  2622. @end itemize
  2623. @end table
  2624. @c man end VIDEO ENCODERS
  2625. @chapter Subtitles Encoders
  2626. @c man begin SUBTITLES ENCODERS
  2627. @section dvdsub
  2628. This codec encodes the bitmap subtitle format that is used in DVDs.
  2629. Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
  2630. and they can also be used in Matroska files.
  2631. @subsection Options
  2632. @table @option
  2633. @item palette
  2634. Specify the global palette used by the bitmaps.
  2635. The format for this option is a string containing 16 24-bits hexadecimal
  2636. numbers (without 0x prefix) separated by commas, for example @code{0d00ee,
  2637. ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
  2638. 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b}.
  2639. @item even_rows_fix
  2640. When set to 1, enable a work-around that makes the number of pixel rows
  2641. even in all subtitles. This fixes a problem with some players that
  2642. cut off the bottom row if the number is odd. The work-around just adds
  2643. a fully transparent row if needed. The overhead is low, typically
  2644. one byte per subtitle on average.
  2645. By default, this work-around is disabled.
  2646. @end table
  2647. @c man end SUBTITLES ENCODERS