git.sesse.net Git - ffmpeg/blob - doc/decoders.texi

   1 @chapter Decoders
   2 @c man begin DECODERS
   3
   4 Decoders are configured elements in FFmpeg which allow the decoding of
   5 multimedia streams.
   6
   7 When you configure your FFmpeg build, all the supported native decoders
   8 are enabled by default. Decoders requiring an external library must be enabled
   9 manually via the corresponding @code{--enable-lib} option. You can list all
  10 available decoders using the configure option @code{--list-decoders}.
  11
  12 You can disable all the decoders with the configure option
  13 @code{--disable-decoders} and selectively enable / disable single decoders
  14 with the options @code{--enable-decoder=@var{DECODER}} /
  15 @code{--disable-decoder=@var{DECODER}}.
  16
  17 The option @code{-decoders} of the ff* tools will display the list of
  18 enabled decoders.
  19
  20 @c man end DECODERS
  21
  22 @chapter Video Decoders
  23 @c man begin VIDEO DECODERS
  24
  25 A description of some of the currently available video decoders
  26 follows.
  27
  28 @section rawvideo
  29
  30 Raw video decoder.
  31
  32 This decoder decodes rawvideo streams.
  33
  34 @subsection Options
  35
  36 @table @option
  37 @item top @var{top_field_first}
  38 Specify the assumed field type of the input video.
  39 @table @option
  40 @item -1
  41 the video is assumed to be progressive (default)
  42 @item 0
  43 bottom-field-first is assumed
  44 @item 1
  45 top-field-first is assumed
  46 @end table
  47
  48 @end table
  49
  50 @section libdav1d
  51
  52 dav1d AV1 decoder.
  53
  54 libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec.
  55 Requires the presence of the libdav1d headers and library during configuration.
  56 You need to explicitly configure the build with @code{--enable-libdav1d}.
  57
  58 @subsection Options
  59
  60 The following options are supported by the libdav1d wrapper.
  61
  62 @table @option
  63
  64 @item framethreads
  65 Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
  66
  67 @item tilethreads
  68 Set amount of tile threads to use during decoding. The default value is 0 (autodetect).
  69
  70 @item filmgrain
  71 Apply film grain to the decoded video if present in the bitstream. Defaults to the
  72 internal default of the library.
  73
  74 @end table
  75
  76 @section libdavs2
  77
  78 AVS2-P2/IEEE1857.4 video decoder wrapper.
  79
  80 This decoder allows libavcodec to decode AVS2 streams with davs2 library.
  81
  82 @c man end VIDEO DECODERS
  83
  84 @chapter Audio Decoders
  85 @c man begin AUDIO DECODERS
  86
  87 A description of some of the currently available audio decoders
  88 follows.
  89
  90 @section ac3
  91
  92 AC-3 audio decoder.
  93
  94 This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  95 the undocumented RealAudio 3 (a.k.a. dnet).
  96
  97 @subsection AC-3 Decoder Options
  98
  99 @table @option
 100
 101 @item -drc_scale @var{value}
 102 Dynamic Range Scale Factor. The factor to apply to dynamic range values
 103 from the AC-3 stream. This factor is applied exponentially.
 104 There are 3 notable scale factor ranges:
 105 @table @option
 106 @item drc_scale == 0
 107 DRC disabled. Produces full range audio.
 108 @item 0 < drc_scale <= 1
 109 DRC enabled.  Applies a fraction of the stream DRC value.
 110 Audio reproduction is between full range and full compression.
 111 @item drc_scale > 1
 112 DRC enabled. Applies drc_scale asymmetrically.
 113 Loud sounds are fully compressed.  Soft sounds are enhanced.
 114 @end table
 115
 116 @end table
 117
 118 @section flac
 119
 120 FLAC audio decoder.
 121
 122 This decoder aims to implement the complete FLAC specification from Xiph.
 123
 124 @subsection FLAC Decoder options
 125
 126 @table @option
 127
 128 @item -use_buggy_lpc
 129 The lavc FLAC encoder used to produce buggy streams with high lpc values
 130 (like the default value). This option makes it possible to decode such streams
 131 correctly by using lavc's old buggy lpc logic for decoding.
 132
 133 @end table
 134
 135 @section ffwavesynth
 136
 137 Internal wave synthesizer.
 138
 139 This decoder generates wave patterns according to predefined sequences. Its
 140 use is purely internal and the format of the data it accepts is not publicly
 141 documented.
 142
 143 @section libcelt
 144
 145 libcelt decoder wrapper.
 146
 147 libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec.
 148 Requires the presence of the libcelt headers and library during configuration.
 149 You need to explicitly configure the build with @code{--enable-libcelt}.
 150
 151 @section libgsm
 152
 153 libgsm decoder wrapper.
 154
 155 libgsm allows libavcodec to decode the GSM full rate audio codec. Requires
 156 the presence of the libgsm headers and library during configuration. You need
 157 to explicitly configure the build with @code{--enable-libgsm}.
 158
 159 This decoder supports both the ordinary GSM and the Microsoft variant.
 160
 161 @section libilbc
 162
 163 libilbc decoder wrapper.
 164
 165 libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC)
 166 audio codec. Requires the presence of the libilbc headers and library during
 167 configuration. You need to explicitly configure the build with
 168 @code{--enable-libilbc}.
 169
 170 @subsection Options
 171
 172 The following option is supported by the libilbc wrapper.
 173
 174 @table @option
 175 @item enhance
 176
 177 Enable the enhancement of the decoded audio when set to 1. The default
 178 value is 0 (disabled).
 179
 180 @end table
 181
 182 @section libopencore-amrnb
 183
 184 libopencore-amrnb decoder wrapper.
 185
 186 libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate
 187 Narrowband audio codec. Using it requires the presence of the
 188 libopencore-amrnb headers and library during configuration. You need to
 189 explicitly configure the build with @code{--enable-libopencore-amrnb}.
 190
 191 An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB
 192 without this library.
 193
 194 @section libopencore-amrwb
 195
 196 libopencore-amrwb decoder wrapper.
 197
 198 libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate
 199 Wideband audio codec. Using it requires the presence of the
 200 libopencore-amrwb headers and library during configuration. You need to
 201 explicitly configure the build with @code{--enable-libopencore-amrwb}.
 202
 203 An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB
 204 without this library.
 205
 206 @section libopus
 207
 208 libopus decoder wrapper.
 209
 210 libopus allows libavcodec to decode the Opus Interactive Audio Codec.
 211 Requires the presence of the libopus headers and library during
 212 configuration. You need to explicitly configure the build with
 213 @code{--enable-libopus}.
 214
 215 An FFmpeg native decoder for Opus exists, so users can decode Opus
 216 without this library.
 217
 218 @c man end AUDIO DECODERS
 219
 220 @chapter Subtitles Decoders
 221 @c man begin SUBTILES DECODERS
 222
 223 @section libaribb24
 224
 225 ARIB STD-B24 caption decoder.
 226
 227 Implements profiles A and C of the ARIB STD-B24 standard.
 228
 229 @subsection libaribb24 Decoder Options
 230
 231 @table @option
 232
 233 @item -aribb24-base-path @var{path}
 234 Sets the base path for the libaribb24 library. This is utilized for reading of
 235 configuration files (for custom unicode conversions), and for dumping of
 236 non-text symbols as images under that location.
 237
 238 Unset by default.
 239
 240 @item -aribb24-skip-ruby-text @var{boolean}
 241 Tells the decoder wrapper to skip text blocks that contain half-height ruby
 242 text.
 243
 244 Enabled by default.
 245
 246 @end table
 247
 248 @section dvbsub
 249
 250 @subsection Options
 251
 252 @table @option
 253 @item compute_clut
 254 @table @option
 255 @item -1
 256 Compute clut if no matching CLUT is in the stream.
 257 @item 0
 258 Never compute CLUT
 259 @item 1
 260 Always compute CLUT and override the one provided in the stream.
 261 @end table
 262 @item dvb_substream
 263 Selects the dvb substream, or all substreams if -1 which is default.
 264
 265 @end table
 266
 267 @section dvdsub
 268
 269 This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
 270 also be found in VobSub file pairs and in some Matroska files.
 271
 272 @subsection Options
 273
 274 @table @option
 275 @item palette
 276 Specify the global palette used by the bitmaps. When stored in VobSub, the
 277 palette is normally specified in the index file; in Matroska, the palette is
 278 stored in the codec extra-data in the same format as in VobSub. In DVDs, the
 279 palette is stored in the IFO file, and therefore not available when reading
 280 from dumped VOB files.
 281
 282 The format for this option is a string containing 16 24-bits hexadecimal
 283 numbers (without 0x prefix) separated by comas, for example @code{0d00ee,
 284 ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
 285 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b}.
 286
 287 @item ifo_palette
 288 Specify the IFO file from which the global palette is obtained.
 289 (experimental)
 290
 291 @item forced_subs_only
 292 Only decode subtitle entries marked as forced. Some titles have forced
 293 and non-forced subtitles in the same track. Setting this flag to @code{1}
 294 will only keep the forced subtitles. Default value is @code{0}.
 295 @end table
 296
 297 @section libzvbi-teletext
 298
 299 Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext
 300 subtitles. Requires the presence of the libzvbi headers and library during
 301 configuration. You need to explicitly configure the build with
 302 @code{--enable-libzvbi}.
 303
 304 @subsection Options
 305
 306 @table @option
 307 @item txt_page
 308 List of teletext page numbers to decode. Pages that do not match the specified
 309 list are dropped. You may use the special @code{*} string to match all pages,
 310 or @code{subtitle} to match all subtitle pages.
 311 Default value is *.
 312 @item txt_chop_top
 313 Discards the top teletext line. Default value is 1.
 314 @item txt_format
 315 Specifies the format of the decoded subtitles.
 316 @table @option
 317 @item bitmap
 318 The default format, you should use this for teletext pages, because certain
 319 graphics and colors cannot be expressed in simple text or even ASS.
 320 @item text
 321 Simple text based output without formatting.
 322 @item ass
 323 Formatted ASS output, subtitle pages and teletext pages are returned in
 324 different styles, subtitle pages are stripped down to text, but an effort is
 325 made to keep the text alignment and the formatting.
 326 @end table
 327 @item txt_left
 328 X offset of generated bitmaps, default is 0.
 329 @item txt_top
 330 Y offset of generated bitmaps, default is 0.
 331 @item txt_chop_spaces
 332 Chops leading and trailing spaces and removes empty lines from the generated
 333 text. This option is useful for teletext based subtitles where empty spaces may
 334 be present at the start or at the end of the lines or empty lines may be
 335 present between the subtitle lines because of double-sized teletext characters.
 336 Default value is 1.
 337 @item txt_duration
 338 Sets the display duration of the decoded teletext pages or subtitles in
 339 milliseconds. Default value is -1 which means infinity or until the next
 340 subtitle event comes.
 341 @item txt_transparent
 342 Force transparent background of the generated teletext bitmaps. Default value
 343 is 0 which means an opaque background.
 344 @item txt_opacity
 345 Sets the opacity (0-255) of the teletext background. If
 346 @option{txt_transparent} is not set, it only affects characters between a start
 347 box and an end box, typically subtitles. Default value is 0 if
 348 @option{txt_transparent} is set, 255 otherwise.
 349
 350 @end table
 351
 352 @c man end SUBTILES DECODERS