demuxers.texi 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161
  1. @chapter Demuxers
  2. @c man begin DEMUXERS
  3. Demuxers are configured elements in FFmpeg that can read the
  4. multimedia streams from a particular type of file.
  5. When you configure your FFmpeg build, all the supported demuxers
  6. are enabled by default. You can list all available ones using the
  7. configure option @code{--list-demuxers}.
  8. You can disable all the demuxers using the configure option
  9. @code{--disable-demuxers}, and selectively enable a single demuxer with
  10. the option @code{--enable-demuxer=@var{DEMUXER}}, or disable it
  11. with the option @code{--disable-demuxer=@var{DEMUXER}}.
  12. The option @code{-demuxers} of the ff* tools will display the list of
  13. enabled demuxers. Use @code{-formats} to view a combined list of
  14. enabled demuxers and muxers.
  15. The description of some of the currently available demuxers follows.
  16. @section aa
  17. Audible Format 2, 3, and 4 demuxer.
  18. This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.
  19. @section aac
  20. Raw Audio Data Transport Stream AAC demuxer.
  21. This demuxer is used to demux an ADTS input containing a single AAC stream
  22. alongwith any ID3v1/2 or APE tags in it.
  23. @section apng
  24. Animated Portable Network Graphics demuxer.
  25. This demuxer is used to demux APNG files.
  26. All headers, but the PNG signature, up to (but not including) the first
  27. fcTL chunk are transmitted as extradata.
  28. Frames are then split as being all the chunks between two fcTL ones, or
  29. between the last fcTL and IEND chunks.
  30. @table @option
  31. @item -ignore_loop @var{bool}
  32. Ignore the loop variable in the file if set. Default is enabled.
  33. @item -max_fps @var{int}
  34. Maximum framerate in frames per second. Default of 0 imposes no limit.
  35. @item -default_fps @var{int}
  36. Default framerate in frames per second when none is specified in the file
  37. (0 meaning as fast as possible). Default is 15.
  38. @end table
  39. @section asf
  40. Advanced Systems Format demuxer.
  41. This demuxer is used to demux ASF files and MMS network streams.
  42. @table @option
  43. @item -no_resync_search @var{bool}
  44. Do not try to resynchronize by looking for a certain optional start code.
  45. @end table
  46. @anchor{concat}
  47. @section concat
  48. Virtual concatenation script demuxer.
  49. This demuxer reads a list of files and other directives from a text file and
  50. demuxes them one after the other, as if all their packets had been muxed
  51. together.
  52. The timestamps in the files are adjusted so that the first file starts at 0
  53. and each next file starts where the previous one finishes. Note that it is
  54. done globally and may cause gaps if all streams do not have exactly the same
  55. length.
  56. All files must have the same streams (same codecs, same time base, etc.).
  57. The duration of each file is used to adjust the timestamps of the next file:
  58. if the duration is incorrect (because it was computed using the bit-rate or
  59. because the file is truncated, for example), it can cause artifacts. The
  60. @code{duration} directive can be used to override the duration stored in
  61. each file.
  62. @subsection Syntax
  63. The script is a text file in extended-ASCII, with one directive per line.
  64. Empty lines, leading spaces and lines starting with '#' are ignored. The
  65. following directive is recognized:
  66. @table @option
  67. @item @code{file @var{path}}
  68. Path to a file to read; special characters and spaces must be escaped with
  69. backslash or single quotes.
  70. All subsequent file-related directives apply to that file.
  71. @item @code{ffconcat version 1.0}
  72. Identify the script type and version.
  73. To make FFmpeg recognize the format automatically, this directive must
  74. appear exactly as is (no extra space or byte-order-mark) on the very first
  75. line of the script.
  76. @item @code{duration @var{dur}}
  77. Duration of the file. This information can be specified from the file;
  78. specifying it here may be more efficient or help if the information from the
  79. file is not available or accurate.
  80. If the duration is set for all files, then it is possible to seek in the
  81. whole concatenated video.
  82. @item @code{inpoint @var{timestamp}}
  83. In point of the file. When the demuxer opens the file it instantly seeks to the
  84. specified timestamp. Seeking is done so that all streams can be presented
  85. successfully at In point.
  86. This directive works best with intra frame codecs, because for non-intra frame
  87. ones you will usually get extra packets before the actual In point and the
  88. decoded content will most likely contain frames before In point too.
  89. For each file, packets before the file In point will have timestamps less than
  90. the calculated start timestamp of the file (negative in case of the first
  91. file), and the duration of the files (if not specified by the @code{duration}
  92. directive) will be reduced based on their specified In point.
  93. Because of potential packets before the specified In point, packet timestamps
  94. may overlap between two concatenated files.
  95. @item @code{outpoint @var{timestamp}}
  96. Out point of the file. When the demuxer reaches the specified decoding
  97. timestamp in any of the streams, it handles it as an end of file condition and
  98. skips the current and all the remaining packets from all streams.
  99. Out point is exclusive, which means that the demuxer will not output packets
  100. with a decoding timestamp greater or equal to Out point.
  101. This directive works best with intra frame codecs and formats where all streams
  102. are tightly interleaved. For non-intra frame codecs you will usually get
  103. additional packets with presentation timestamp after Out point therefore the
  104. decoded content will most likely contain frames after Out point too. If your
  105. streams are not tightly interleaved you may not get all the packets from all
  106. streams before Out point and you may only will be able to decode the earliest
  107. stream until Out point.
  108. The duration of the files (if not specified by the @code{duration}
  109. directive) will be reduced based on their specified Out point.
  110. @item @code{file_packet_metadata @var{key=value}}
  111. Metadata of the packets of the file. The specified metadata will be set for
  112. each file packet. You can specify this directive multiple times to add multiple
  113. metadata entries.
  114. This directive is deprecated, use @code{file_packet_meta} instead.
  115. @item @code{file_packet_meta @var{key} @var{value}}
  116. Metadata of the packets of the file. The specified metadata will be set for
  117. each file packet. You can specify this directive multiple times to add multiple
  118. metadata entries.
  119. @item @code{option @var{key} @var{value}}
  120. Option to access, open and probe the file.
  121. Can be present multiple times.
  122. @item @code{stream}
  123. Introduce a stream in the virtual file.
  124. All subsequent stream-related directives apply to the last introduced
  125. stream.
  126. Some streams properties must be set in order to allow identifying the
  127. matching streams in the subfiles.
  128. If no streams are defined in the script, the streams from the first file are
  129. copied.
  130. @item @code{exact_stream_id @var{id}}
  131. Set the id of the stream.
  132. If this directive is given, the string with the corresponding id in the
  133. subfiles will be used.
  134. This is especially useful for MPEG-PS (VOB) files, where the order of the
  135. streams is not reliable.
  136. @item @code{stream_meta @var{key} @var{value}}
  137. Metadata for the stream.
  138. Can be present multiple times.
  139. @item @code{stream_codec @var{value}}
  140. Codec for the stream.
  141. @item @code{stream_extradata @var{hex_string}}
  142. Extradata for the string, encoded in hexadecimal.
  143. @item @code{chapter @var{id} @var{start} @var{end}}
  144. Add a chapter. @var{id} is an unique identifier, possibly small and
  145. consecutive.
  146. @end table
  147. @subsection Options
  148. This demuxer accepts the following option:
  149. @table @option
  150. @item safe
  151. If set to 1, reject unsafe file paths and directives.
  152. A file path is considered safe if it
  153. does not contain a protocol specification and is relative and all components
  154. only contain characters from the portable character set (letters, digits,
  155. period, underscore and hyphen) and have no period at the beginning of a
  156. component.
  157. If set to 0, any file name is accepted.
  158. The default is 1.
  159. @item auto_convert
  160. If set to 1, try to perform automatic conversions on packet data to make the
  161. streams concatenable.
  162. The default is 1.
  163. Currently, the only conversion is adding the h264_mp4toannexb bitstream
  164. filter to H.264 streams in MP4 format. This is necessary in particular if
  165. there are resolution changes.
  166. @item segment_time_metadata
  167. If set to 1, every packet will contain the @var{lavf.concat.start_time} and the
  168. @var{lavf.concat.duration} packet metadata values which are the start_time and
  169. the duration of the respective file segments in the concatenated output
  170. expressed in microseconds. The duration metadata is only set if it is known
  171. based on the concat file.
  172. The default is 0.
  173. @end table
  174. @subsection Examples
  175. @itemize
  176. @item
  177. Use absolute filenames and include some comments:
  178. @example
  179. # my first filename
  180. file /mnt/share/file-1.wav
  181. # my second filename including whitespace
  182. file '/mnt/share/file 2.wav'
  183. # my third filename including whitespace plus single quote
  184. file '/mnt/share/file 3'\''.wav'
  185. @end example
  186. @item
  187. Allow for input format auto-probing, use safe filenames and set the duration of
  188. the first file:
  189. @example
  190. ffconcat version 1.0
  191. file file-1.wav
  192. duration 20.0
  193. file subdir/file-2.wav
  194. @end example
  195. @end itemize
  196. @section dash
  197. Dynamic Adaptive Streaming over HTTP demuxer.
  198. This demuxer presents all AVStreams found in the manifest.
  199. By setting the discard flags on AVStreams the caller can decide
  200. which streams to actually receive.
  201. Each stream mirrors the @code{id} and @code{bandwidth} properties from the
  202. @code{<Representation>} as metadata keys named "id" and "variant_bitrate" respectively.
  203. @subsection Options
  204. This demuxer accepts the following option:
  205. @table @option
  206. @item cenc_decryption_key
  207. 16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
  208. @end table
  209. @section dvdvideo
  210. DVD-Video demuxer, powered by libdvdnav and libdvdread.
  211. Can directly ingest DVD titles, specifically sequential PGCs, into
  212. a conversion pipeline. Menu assets, such as background video or audio,
  213. can also be demuxed given the menu's coordinates (at best effort).
  214. Seeking is not supported at this time.
  215. Block devices (DVD drives), ISO files, and directory structures are accepted.
  216. Activate with @code{-f dvdvideo} in front of one of these inputs.
  217. This demuxer does NOT have decryption code of any kind. You are on your own
  218. working with encrypted DVDs, and should not expect support on the matter.
  219. Underlying playback is handled by libdvdnav, and structure parsing by libdvdread.
  220. FFmpeg must be built with GPL library support available as well as the
  221. configure switches @code{--enable-libdvdnav} and @code{--enable-libdvdread}.
  222. You will need to provide either the desired "title number" or exact PGC/PG coordinates.
  223. Many open-source DVD players and tools can aid in providing this information.
  224. If not specified, the demuxer will default to title 1 which works for many discs.
  225. However, due to the flexibility of the format, it is recommended to check manually.
  226. There are many discs that are authored strangely or with invalid headers.
  227. If the input is a real DVD drive, please note that there are some drives which may
  228. silently fail on reading bad sectors from the disc, returning random bits instead
  229. which is effectively corrupt data. This is especially prominent on aging or rotting discs.
  230. A second pass and integrity checks would be needed to detect the corruption.
  231. This is not an FFmpeg issue.
  232. @subsection Background
  233. DVD-Video is not a directly accessible, linear container format in the
  234. traditional sense. Instead, it allows for complex and programmatic playback of
  235. carefully muxed MPEG-PS streams that are stored in headerless VOB files.
  236. To the end-user, these streams are known simply as "titles", but the actual
  237. logical playback sequence is defined by one or more "PGCs", or Program Group Chains,
  238. within the title. The PGC is in turn comprised of multiple "PGs", or Programs",
  239. which are the actual video segments (and for a typical video feature, sequentially
  240. ordered). The PGC structure, along with stream layout and metadata, are stored in
  241. IFO files that need to be parsed. PGCs can be thought of as playlists in easier terms.
  242. An actual DVD player relies on user GUI interaction via menus and an internal VM
  243. to drive the direction of demuxing. Generally, the user would either navigate (via menus)
  244. or automatically be redirected to the PGC of their choice. During this process and
  245. the subsequent playback, the DVD player's internal VM also maintains a state and
  246. executes instructions that can create jumps to different sectors during playback.
  247. This is why libdvdnav is involved, as a linear read of the MPEG-PS blobs on the
  248. disc (VOBs) is not enough to produce the right sequence in many cases.
  249. There are many other DVD structures (a long subject) that will not be discussed here.
  250. NAV packets, in particular, are handled by this demuxer to build accurate timing
  251. but not emitted as a stream. For a good high-level understanding, refer to:
  252. @url{https://code.videolan.org/videolan/libdvdnav/-/blob/master/doc/dvd_structures}
  253. @subsection Options
  254. This demuxer accepts the following options:
  255. @table @option
  256. @item title @var{int}
  257. The title number to play. Must be set if @option{pgc} and @option{pg} are not set.
  258. Not applicable to menus.
  259. Default is 0 (auto), which currently only selects the first available title (title 1)
  260. and notifies the user about the implications.
  261. @item chapter_start @var{int}
  262. The chapter, or PTT (part-of-title), number to start at. Not applicable to menus.
  263. Default is 1.
  264. @item chapter_end @var{int}
  265. The chapter, or PTT (part-of-title), number to end at. Not applicable to menus.
  266. Default is 0, which is a special value to signal end at the last possible chapter.
  267. @item angle @var{int}
  268. The video angle number, referring to what is essentially an additional
  269. video stream that is composed from alternate frames interleaved in the VOBs.
  270. Not applicable to menus.
  271. Default is 1.
  272. @item region @var{int}
  273. The region code to use for playback. Some discs may use this to default playback
  274. at a particular angle in different regions. This option will not affect the region code
  275. of a real DVD drive, if used as an input. Not applicable to menus.
  276. Default is 0, "world".
  277. @item menu @var{bool}
  278. Demux menu assets instead of navigating a title. Requires exact coordinates
  279. of the menu (@option{menu_lu}, @option{menu_vts}, @option{pgc}, @option{pg}).
  280. Default is false.
  281. @item menu_lu @var{int}
  282. The menu language to demux. In DVD, menus are grouped by language.
  283. Default is 0, the first language unit.
  284. @item menu_vts @var{int}
  285. The VTS where the menu lives, or 0 if it is a VMG menu (root-level).
  286. Default is 0, VMG menu.
  287. @item pgc @var{int}
  288. The entry PGC to start playback, in conjunction with @option{pg}.
  289. Alternative to setting @option{title}.
  290. Chapter markers are not supported at this time.
  291. Must be explicitly set for menus.
  292. Default is 0, automatically resolve from value of @option{title}.
  293. @item pg @var{int}
  294. The entry PG to start playback, in conjunction with @option{pgc}.
  295. Alternative to setting @option{title}.
  296. Chapter markers are not supported at this time.
  297. Default is 0, automatically resolve from value of @option{title}, or
  298. start from the beginning (PG 1) of the menu.
  299. @item preindex @var{bool}
  300. Enable this to have accurate chapter (PTT) markers and duration measurement,
  301. which requires a slow second pass read in order to index the chapter marker
  302. timestamps from NAV packets. This is non-ideal extra work for real optical drives.
  303. It is recommended and faster to use this option with a backup of the DVD structure
  304. stored on a hard drive. Not compatible with @option{pgc} and @option{pg}.
  305. Not applicable to menus.
  306. Default is 0, false.
  307. @item trim @var{bool}
  308. Skip padding cells (i.e. cells shorter than 1 second) from the beginning.
  309. There exist many discs with filler segments at the beginning of the PGC,
  310. often with junk data intended for controlling a real DVD player's
  311. buffering speed and with no other material data value.
  312. Not applicable to menus.
  313. Default is 1, true.
  314. @end table
  315. @subsection Examples
  316. @itemize
  317. @item
  318. Open title 3 from a given DVD structure:
  319. @example
  320. ffmpeg -f dvdvideo -title 3 -i <path to DVD> ...
  321. @end example
  322. @item
  323. Open chapters 3-6 from title 1 from a given DVD structure:
  324. @example
  325. ffmpeg -f dvdvideo -chapter_start 3 -chapter_end 6 -title 1 -i <path to DVD> ...
  326. @end example
  327. @item
  328. Open only chapter 5 from title 1 from a given DVD structure:
  329. @example
  330. ffmpeg -f dvdvideo -chapter_start 5 -chapter_end 5 -title 1 -i <path to DVD> ...
  331. @end example
  332. @item
  333. Demux menu with language 1 from VTS 1, PGC 1, starting at PG 1:
  334. @example
  335. ffmpeg -f dvdvideo -menu 1 -menu_lu 1 -menu_vts 1 -pgc 1 -pg 1 -i <path to DVD> ...
  336. @end example
  337. @end itemize
  338. @section ea
  339. Electronic Arts Multimedia format demuxer.
  340. This format is used by various Electronic Arts games.
  341. @subsection Options
  342. @table @option
  343. @item merge_alpha @var{bool}
  344. Normally the VP6 alpha channel (if exists) is returned as a secondary video
  345. stream, by setting this option you can make the demuxer return a single video
  346. stream which contains the alpha channel in addition to the ordinary video.
  347. @end table
  348. @section imf
  349. Interoperable Master Format demuxer.
  350. This demuxer presents audio and video streams found in an IMF Composition, as
  351. specified in @url{https://doi.org/10.5594/SMPTE.ST2067-2.2020, SMPTE ST 2067-2}.
  352. @example
  353. ffmpeg [-assetmaps <path of ASSETMAP1>,<path of ASSETMAP2>,...] -i <path of CPL> ...
  354. @end example
  355. If @code{-assetmaps} is not specified, the demuxer looks for a file called
  356. @file{ASSETMAP.xml} in the same directory as the CPL.
  357. @section flv, live_flv, kux
  358. Adobe Flash Video Format demuxer.
  359. This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities.
  360. KUX is a flv variant used on the Youku platform.
  361. @example
  362. ffmpeg -f flv -i myfile.flv ...
  363. ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
  364. @end example
  365. @table @option
  366. @item -flv_metadata @var{bool}
  367. Allocate the streams according to the onMetaData array content.
  368. @item -flv_ignore_prevtag @var{bool}
  369. Ignore the size of previous tag value.
  370. @item -flv_full_metadata @var{bool}
  371. Output all context of the onMetadata.
  372. @end table
  373. @section gif
  374. Animated GIF demuxer.
  375. It accepts the following options:
  376. @table @option
  377. @item min_delay
  378. Set the minimum valid delay between frames in hundredths of seconds.
  379. Range is 0 to 6000. Default value is 2.
  380. @item max_gif_delay
  381. Set the maximum valid delay between frames in hundredth of seconds.
  382. Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
  383. the maximum value allowed by the specification.
  384. @item default_delay
  385. Set the default delay between frames in hundredths of seconds.
  386. Range is 0 to 6000. Default value is 10.
  387. @item ignore_loop
  388. GIF files can contain information to loop a certain number of times (or
  389. infinitely). If @option{ignore_loop} is set to 1, then the loop setting
  390. from the input will be ignored and looping will not occur. If set to 0,
  391. then looping will occur and will cycle the number of times according to
  392. the GIF. Default value is 1.
  393. @end table
  394. For example, with the overlay filter, place an infinitely looping GIF
  395. over another video:
  396. @example
  397. ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
  398. @end example
  399. Note that in the above example the shortest option for overlay filter is
  400. used to end the output video at the length of the shortest input file,
  401. which in this case is @file{input.mp4} as the GIF in this example loops
  402. infinitely.
  403. @section hls
  404. HLS demuxer
  405. Apple HTTP Live Streaming demuxer.
  406. This demuxer presents all AVStreams from all variant streams.
  407. The id field is set to the bitrate variant index number. By setting
  408. the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
  409. the caller can decide which variant streams to actually receive.
  410. The total bitrate of the variant that the stream belongs to is
  411. available in a metadata key named "variant_bitrate".
  412. It accepts the following options:
  413. @table @option
  414. @item live_start_index
  415. segment index to start live streams at (negative values are from the end).
  416. @item prefer_x_start
  417. prefer to use #EXT-X-START if it's in playlist instead of live_start_index.
  418. @item allowed_extensions
  419. ',' separated list of file extensions that hls is allowed to access.
  420. @item max_reload
  421. Maximum number of times a insufficient list is attempted to be reloaded.
  422. Default value is 1000.
  423. @item m3u8_hold_counters
  424. The maximum number of times to load m3u8 when it refreshes without new segments.
  425. Default value is 1000.
  426. @item http_persistent
  427. Use persistent HTTP connections. Applicable only for HTTP streams.
  428. Enabled by default.
  429. @item http_multiple
  430. Use multiple HTTP connections for downloading HTTP segments.
  431. Enabled by default for HTTP/1.1 servers.
  432. @item http_seekable
  433. Use HTTP partial requests for downloading HTTP segments.
  434. 0 = disable, 1 = enable, -1 = auto, Default is auto.
  435. @item seg_format_options
  436. Set options for the demuxer of media segments using a list of key=value pairs separated by @code{:}.
  437. @item seg_max_retry
  438. Maximum number of times to reload a segment on error, useful when segment skip on network error is not desired.
  439. Default value is 0.
  440. @end table
  441. @section image2
  442. Image file demuxer.
  443. This demuxer reads from a list of image files specified by a pattern.
  444. The syntax and meaning of the pattern is specified by the
  445. option @var{pattern_type}.
  446. The pattern may contain a suffix which is used to automatically
  447. determine the format of the images contained in the files.
  448. The size, the pixel format, and the format of each image must be the
  449. same for all the files in the sequence.
  450. This demuxer accepts the following options:
  451. @table @option
  452. @item framerate
  453. Set the frame rate for the video stream. It defaults to 25.
  454. @item loop
  455. If set to 1, loop over the input. Default value is 0.
  456. @item pattern_type
  457. Select the pattern type used to interpret the provided filename.
  458. @var{pattern_type} accepts one of the following values.
  459. @table @option
  460. @item none
  461. Disable pattern matching, therefore the video will only contain the specified
  462. image. You should use this option if you do not want to create sequences from
  463. multiple images and your filenames may contain special pattern characters.
  464. @item sequence
  465. Select a sequence pattern type, used to specify a sequence of files
  466. indexed by sequential numbers.
  467. A sequence pattern may contain the string "%d" or "%0@var{N}d", which
  468. specifies the position of the characters representing a sequential
  469. number in each filename matched by the pattern. If the form
  470. "%d0@var{N}d" is used, the string representing the number in each
  471. filename is 0-padded and @var{N} is the total number of 0-padded
  472. digits representing the number. The literal character '%' can be
  473. specified in the pattern with the string "%%".
  474. If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
  475. the file list specified by the pattern must contain a number
  476. inclusively contained between @var{start_number} and
  477. @var{start_number}+@var{start_number_range}-1, and all the following
  478. numbers must be sequential.
  479. For example the pattern "img-%03d.bmp" will match a sequence of
  480. filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
  481. @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
  482. sequence of filenames of the form @file{i%m%g-1.jpg},
  483. @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
  484. Note that the pattern must not necessarily contain "%d" or
  485. "%0@var{N}d", for example to convert a single image file
  486. @file{img.jpeg} you can employ the command:
  487. @example
  488. ffmpeg -i img.jpeg img.png
  489. @end example
  490. @item glob
  491. Select a glob wildcard pattern type.
  492. The pattern is interpreted like a @code{glob()} pattern. This is only
  493. selectable if libavformat was compiled with globbing support.
  494. @item glob_sequence @emph{(deprecated, will be removed)}
  495. Select a mixed glob wildcard/sequence pattern.
  496. If your version of libavformat was compiled with globbing support, and
  497. the provided pattern contains at least one glob meta character among
  498. @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
  499. interpreted like a @code{glob()} pattern, otherwise it is interpreted
  500. like a sequence pattern.
  501. All glob special characters @code{%*?[]@{@}} must be prefixed
  502. with "%". To escape a literal "%" you shall use "%%".
  503. For example the pattern @code{foo-%*.jpeg} will match all the
  504. filenames prefixed by "foo-" and terminating with ".jpeg", and
  505. @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
  506. "foo-", followed by a sequence of three characters, and terminating
  507. with ".jpeg".
  508. This pattern type is deprecated in favor of @var{glob} and
  509. @var{sequence}.
  510. @end table
  511. Default value is @var{glob_sequence}.
  512. @item pixel_format
  513. Set the pixel format of the images to read. If not specified the pixel
  514. format is guessed from the first image file in the sequence.
  515. @item start_number
  516. Set the index of the file matched by the image file pattern to start
  517. to read from. Default value is 0.
  518. @item start_number_range
  519. Set the index interval range to check when looking for the first image
  520. file in the sequence, starting from @var{start_number}. Default value
  521. is 5.
  522. @item ts_from_file
  523. If set to 1, will set frame timestamp to modification time of image file. Note
  524. that monotonity of timestamps is not provided: images go in the same order as
  525. without this option. Default value is 0.
  526. If set to 2, will set frame timestamp to the modification time of the image file in
  527. nanosecond precision.
  528. @item video_size
  529. Set the video size of the images to read. If not specified the video
  530. size is guessed from the first image file in the sequence.
  531. @item export_path_metadata
  532. If set to 1, will add two extra fields to the metadata found in input, making them
  533. also available for other filters (see @var{drawtext} filter for examples). Default
  534. value is 0. The extra fields are described below:
  535. @table @option
  536. @item lavf.image2dec.source_path
  537. Corresponds to the full path to the input file being read.
  538. @item lavf.image2dec.source_basename
  539. Corresponds to the name of the file being read.
  540. @end table
  541. @end table
  542. @subsection Examples
  543. @itemize
  544. @item
  545. Use @command{ffmpeg} for creating a video from the images in the file
  546. sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
  547. input frame rate of 10 frames per second:
  548. @example
  549. ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
  550. @end example
  551. @item
  552. As above, but start by reading from a file with index 100 in the sequence:
  553. @example
  554. ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
  555. @end example
  556. @item
  557. Read images matching the "*.png" glob pattern , that is all the files
  558. terminating with the ".png" suffix:
  559. @example
  560. ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
  561. @end example
  562. @end itemize
  563. @section libgme
  564. The Game Music Emu library is a collection of video game music file emulators.
  565. See @url{https://bitbucket.org/mpyne/game-music-emu/overview} for more information.
  566. It accepts the following options:
  567. @table @option
  568. @item track_index
  569. Set the index of which track to demux. The demuxer can only export one track.
  570. Track indexes start at 0. Default is to pick the first track. Number of tracks
  571. is exported as @var{tracks} metadata entry.
  572. @item sample_rate
  573. Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100.
  574. @item max_size @emph{(bytes)}
  575. The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
  576. which in turn, acts as a ceiling for the size of files that can be read.
  577. Default is 50 MiB.
  578. @end table
  579. @section libmodplug
  580. ModPlug based module demuxer
  581. See @url{https://github.com/Konstanty/libmodplug}
  582. It will export one 2-channel 16-bit 44.1 kHz audio stream.
  583. Optionally, a @code{pal8} 16-color video stream can be exported with or without printed metadata.
  584. It accepts the following options:
  585. @table @option
  586. @item noise_reduction
  587. Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0.
  588. @item reverb_depth
  589. Set amount of reverb. Range 0-100. Default is 0.
  590. @item reverb_delay
  591. Set delay in ms, clamped to 40-250 ms. Default is 0.
  592. @item bass_amount
  593. Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0.
  594. @item bass_range
  595. Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0.
  596. @item surround_depth
  597. Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0.
  598. @item surround_delay
  599. Set surround delay in ms, clamped to 5-40 ms. Default is 0.
  600. @item max_size
  601. The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
  602. which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB.
  603. 0 removes buffer size limit (not recommended). Default is 5 MiB.
  604. @item video_stream_expr
  605. String which is evaluated using the eval API to assign colors to the generated video stream.
  606. Variables which can be used are @code{x}, @code{y}, @code{w}, @code{h}, @code{t}, @code{speed},
  607. @code{tempo}, @code{order}, @code{pattern} and @code{row}.
  608. @item video_stream
  609. Generate video stream. Can be 1 (on) or 0 (off). Default is 0.
  610. @item video_stream_w
  611. Set video frame width in 'chars' where one char indicates 8 pixels. Range is 20-512. Default is 30.
  612. @item video_stream_h
  613. Set video frame height in 'chars' where one char indicates 8 pixels. Range is 20-512. Default is 30.
  614. @item video_stream_ptxt
  615. Print metadata on video stream. Includes @code{speed}, @code{tempo}, @code{order}, @code{pattern},
  616. @code{row} and @code{ts} (time in ms). Can be 1 (on) or 0 (off). Default is 1.
  617. @end table
  618. @section libopenmpt
  619. libopenmpt based module demuxer
  620. See @url{https://lib.openmpt.org/libopenmpt/} for more information.
  621. Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
  622. option.
  623. It accepts the following options:
  624. @table @option
  625. @item subsong
  626. Set the subsong index. This can be either 'all', 'auto', or the index of the
  627. subsong. Subsong indexes start at 0. The default is 'auto'.
  628. The default value is to let libopenmpt choose.
  629. @item layout
  630. Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
  631. The default value is STEREO.
  632. @item sample_rate
  633. Set the sample rate for libopenmpt to output.
  634. Range is from 1000 to INT_MAX. The value default is 48000.
  635. @end table
  636. @section mov/mp4/3gp
  637. Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12).
  638. Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v
  639. @subsection Options
  640. This demuxer accepts the following options:
  641. @table @option
  642. @item enable_drefs
  643. Enable loading of external tracks, disabled by default.
  644. Enabling this can theoretically leak information in some use cases.
  645. @item use_absolute_path
  646. Allows loading of external tracks via absolute paths, disabled by default.
  647. Enabling this poses a security risk. It should only be enabled if the source
  648. is known to be non-malicious.
  649. @item seek_streams_individually
  650. When seeking, identify the closest point in each stream individually and demux packets in
  651. that stream from identified point. This can lead to a different sequence of packets compared
  652. to demuxing linearly from the beginning. Default is true.
  653. @item ignore_editlist
  654. Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the
  655. timeline described by the edit list. Default is false.
  656. @item advanced_editlist
  657. Modify the stream index to reflect the timeline described by the edit list. @code{ignore_editlist}
  658. must be set to false for this option to be effective.
  659. If both @code{ignore_editlist} and this option are set to false, then only the
  660. start of the stream index is modified to reflect initial dwell time or starting timestamp
  661. described by the edit list. Default is true.
  662. @item ignore_chapters
  663. Don't parse chapters. This includes GoPro 'HiLight' tags/moments. Note that chapters are
  664. only parsed when input is seekable. Default is false.
  665. @item use_mfra_for
  666. For seekable fragmented input, set fragment's starting timestamp from media fragment random access box, if present.
  667. Following options are available:
  668. @table @samp
  669. @item auto
  670. Auto-detect whether to set mfra timestamps as PTS or DTS @emph{(default)}
  671. @item dts
  672. Set mfra timestamps as DTS
  673. @item pts
  674. Set mfra timestamps as PTS
  675. @item 0
  676. Don't use mfra box to set timestamps
  677. @end table
  678. @item use_tfdt
  679. For fragmented input, set fragment's starting timestamp to @code{baseMediaDecodeTime} from the @code{tfdt} box.
  680. Default is enabled, which will prefer to use the @code{tfdt} box to set DTS. Disable to use the @code{earliest_presentation_time} from the @code{sidx} box.
  681. In either case, the timestamp from the @code{mfra} box will be used if it's available and @code{use_mfra_for} is
  682. set to pts or dts.
  683. @item export_all
  684. Export unrecognized boxes within the @var{udta} box as metadata entries. The first four
  685. characters of the box type are set as the key. Default is false.
  686. @item export_xmp
  687. Export entire contents of @var{XMP_} box and @var{uuid} box as a string with key @code{xmp}. Note that
  688. if @code{export_all} is set and this option isn't, the contents of @var{XMP_} box are still exported
  689. but with key @code{XMP_}. Default is false.
  690. @item activation_bytes
  691. 4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below.
  692. @item audible_fixed_key
  693. Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to
  694. specify.
  695. @item decryption_key
  696. 16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
  697. @item max_stts_delta
  698. Very high sample deltas written in a trak's stts box may occasionally be intended but usually they are written in
  699. error or used to store a negative value for dts correction when treated as signed 32-bit integers. This option lets
  700. the user set an upper limit, beyond which the delta is clamped to 1. Values greater than the limit if negative when
  701. cast to int32 are used to adjust onward dts.
  702. Unit is the track time scale. Range is 0 to UINT_MAX. Default is @code{UINT_MAX - 48000*10} which allows up to
  703. a 10 second dts correction for 48 kHz audio streams while accommodating 99.9% of @code{uint32} range.
  704. @item interleaved_read
  705. Interleave packets from multiple tracks at demuxer level. For badly interleaved files, this prevents playback issues
  706. caused by large gaps between packets in different tracks, as MOV/MP4 do not have packet placement requirements.
  707. However, this can cause excessive seeking on very badly interleaved files, due to seeking between tracks, so disabling
  708. it may prevent I/O issues, at the expense of playback.
  709. @end table
  710. @subsection Audible AAX
  711. Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
  712. @example
  713. ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
  714. @end example
  715. @section mpegts
  716. MPEG-2 transport stream demuxer.
  717. This demuxer accepts the following options:
  718. @table @option
  719. @item resync_size
  720. Set size limit for looking up a new synchronization. Default value is
  721. 65536.
  722. @item skip_unknown_pmt
  723. Skip PMTs for programs not defined in the PAT. Default value is 0.
  724. @item fix_teletext_pts
  725. Override teletext packet PTS and DTS values with the timestamps calculated
  726. from the PCR of the first program which the teletext stream is part of and is
  727. not discarded. Default value is 1, set this option to 0 if you want your
  728. teletext packet PTS and DTS values untouched.
  729. @item ts_packetsize
  730. Output option carrying the raw packet size in bytes.
  731. Show the detected raw packet size, cannot be set by the user.
  732. @item scan_all_pmts
  733. Scan and combine all PMTs. The value is an integer with value from -1
  734. to 1 (-1 means automatic setting, 1 means enabled, 0 means
  735. disabled). Default value is -1.
  736. @item merge_pmt_versions
  737. Re-use existing streams when a PMT's version is updated and elementary
  738. streams move to different PIDs. Default value is 0.
  739. @item max_packet_size
  740. Set maximum size, in bytes, of packet emitted by the demuxer. Payloads above this size
  741. are split across multiple packets. Range is 1 to INT_MAX/2. Default is 204800 bytes.
  742. @end table
  743. @section mpjpeg
  744. MJPEG encapsulated in multi-part MIME demuxer.
  745. This demuxer allows reading of MJPEG, where each frame is represented as a part of
  746. multipart/x-mixed-replace stream.
  747. @table @option
  748. @item strict_mime_boundary
  749. Default implementation applies a relaxed standard to multi-part MIME boundary detection,
  750. to prevent regression with numerous existing endpoints not generating a proper MIME
  751. MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
  752. of the boundary value.
  753. @end table
  754. @section rawvideo
  755. Raw video demuxer.
  756. This demuxer allows one to read raw video data. Since there is no header
  757. specifying the assumed video parameters, the user must specify them
  758. in order to be able to decode the data correctly.
  759. This demuxer accepts the following options:
  760. @table @option
  761. @item framerate
  762. Set input video frame rate. Default value is 25.
  763. @item pixel_format
  764. Set the input video pixel format. Default value is @code{yuv420p}.
  765. @item video_size
  766. Set the input video size. This value must be specified explicitly.
  767. @end table
  768. For example to read a rawvideo file @file{input.raw} with
  769. @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
  770. size of @code{320x240}, and a frame rate of 10 images per second, use
  771. the command:
  772. @example
  773. ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
  774. @end example
  775. @anchor{rcwtdec}
  776. @section rcwt
  777. RCWT (Raw Captions With Time) is a format native to ccextractor, a commonly
  778. used open source tool for processing 608/708 Closed Captions (CC) sources.
  779. For more information on the format, see @ref{rcwtenc,,,ffmpeg-formats}.
  780. This demuxer implements the specification as of March 2024, which has
  781. been stable and unchanged since April 2014.
  782. @subsection Examples
  783. @itemize
  784. @item
  785. Render CC to ASS using the built-in decoder:
  786. @example
  787. ffmpeg -i CC.rcwt.bin CC.ass
  788. @end example
  789. Note that if your output appears to be empty, you may have to manually
  790. set the decoder's @option{data_field} option to pick the desired CC substream.
  791. @item
  792. Convert an RCWT backup to Scenarist (SCC) format:
  793. @example
  794. ffmpeg -i CC.rcwt.bin -c:s copy CC.scc
  795. @end example
  796. Note that the SCC format does not support all of the possible CC extensions
  797. that can be stored in RCWT (such as EIA-708).
  798. @end itemize
  799. @section sbg
  800. SBaGen script demuxer.
  801. This demuxer reads the script language used by SBaGen
  802. @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
  803. script looks like that:
  804. @example
  805. -SE
  806. a: 300-2.5/3 440+4.5/0
  807. b: 300-2.5/0 440+4.5/3
  808. off: -
  809. NOW == a
  810. +0:07:00 == b
  811. +0:14:00 == a
  812. +0:21:00 == b
  813. +0:30:00 off
  814. @end example
  815. A SBG script can mix absolute and relative timestamps. If the script uses
  816. either only absolute timestamps (including the script start time) or only
  817. relative ones, then its layout is fixed, and the conversion is
  818. straightforward. On the other hand, if the script mixes both kind of
  819. timestamps, then the @var{NOW} reference for relative timestamps will be
  820. taken from the current time of day at the time the script is read, and the
  821. script layout will be frozen according to that reference. That means that if
  822. the script is directly played, the actual times will match the absolute
  823. timestamps up to the sound controller's clock accuracy, but if the user
  824. somehow pauses the playback or seeks, all times will be shifted accordingly.
  825. @section tedcaptions
  826. JSON captions used for @url{http://www.ted.com/, TED Talks}.
  827. TED does not provide links to the captions, but they can be guessed from the
  828. page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
  829. contains a bookmarklet to expose them.
  830. This demuxer accepts the following option:
  831. @table @option
  832. @item start_time
  833. Set the start time of the TED talk, in milliseconds. The default is 15000
  834. (15s). It is used to sync the captions with the downloadable videos, because
  835. they include a 15s intro.
  836. @end table
  837. Example: convert the captions to a format most players understand:
  838. @example
  839. ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
  840. @end example
  841. @section vapoursynth
  842. Vapoursynth wrapper.
  843. Due to security concerns, Vapoursynth scripts will not
  844. be autodetected so the input format has to be forced. For ff* CLI tools,
  845. add @code{-f vapoursynth} before the input @code{-i yourscript.vpy}.
  846. This demuxer accepts the following option:
  847. @table @option
  848. @item max_script_size
  849. The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size,
  850. which in turn, acts as a ceiling for the size of scripts that can be read.
  851. Default is 1 MiB.
  852. @end table
  853. @section w64
  854. Sony Wave64 Audio demuxer.
  855. This demuxer accepts the following options:
  856. @table @option
  857. @item max_size
  858. See the same option for the @ref{wav} demuxer.
  859. @end table
  860. @anchor{wav}
  861. @section wav
  862. RIFF Wave Audio demuxer.
  863. This demuxer accepts the following options:
  864. @table @option
  865. @item max_size
  866. Specify the maximum packet size in bytes for the demuxed packets. By default
  867. this is set to 0, which means that a sensible value is chosen based on the
  868. input format.
  869. @end table
  870. @c man end DEMUXERS