muxers.texi 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779
  1. @chapter Muxers
  2. @c man begin MUXERS
  3. Muxers are configured elements in FFmpeg which allow writing
  4. multimedia streams to a particular type of file.
  5. When you configure your FFmpeg build, all the supported muxers
  6. are enabled by default. You can list all available muxers using the
  7. configure option @code{--list-muxers}.
  8. You can disable all the muxers with the configure option
  9. @code{--disable-muxers} and selectively enable / disable single muxers
  10. with the options @code{--enable-muxer=@var{MUXER}} /
  11. @code{--disable-muxer=@var{MUXER}}.
  12. The option @code{-formats} of the ff* tools will display the list of
  13. enabled muxers.
  14. A description of some of the currently available muxers follows.
  15. @anchor{aiff}
  16. @section aiff
  17. Audio Interchange File Format muxer.
  18. @subsection Options
  19. It accepts the following options:
  20. @table @option
  21. @item write_id3v2
  22. Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
  23. @item id3v2_version
  24. Select ID3v2 version to write. Currently only version 3 and 4 (aka.
  25. ID3v2.3 and ID3v2.4) are supported. The default is version 4.
  26. @end table
  27. @anchor{asf}
  28. @section asf
  29. Advanced Systems Format muxer.
  30. Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
  31. muxer too.
  32. @subsection Options
  33. It accepts the following options:
  34. @table @option
  35. @item packet_size
  36. Set the muxer packet size. By tuning this setting you may reduce data
  37. fragmentation or muxer overhead depending on your source. Default value is
  38. 3200, minimum is 100, maximum is 64k.
  39. @end table
  40. @anchor{chromaprint}
  41. @section chromaprint
  42. Chromaprint fingerprinter
  43. This muxer feeds audio data to the Chromaprint library, which generates
  44. a fingerprint for the provided audio data. It takes a single signed
  45. native-endian 16-bit raw audio stream.
  46. @subsection Options
  47. @table @option
  48. @item silence_threshold
  49. Threshold for detecting silence, ranges from 0 to 32767. -1 for default
  50. (required for use with the AcoustID service).
  51. @item algorithm
  52. Algorithm index to fingerprint with.
  53. @item fp_format
  54. Format to output the fingerprint as. Accepts the following options:
  55. @table @samp
  56. @item raw
  57. Binary raw fingerprint
  58. @item compressed
  59. Binary compressed fingerprint
  60. @item base64
  61. Base64 compressed fingerprint
  62. @end table
  63. @end table
  64. @anchor{crc}
  65. @section crc
  66. CRC (Cyclic Redundancy Check) testing format.
  67. This muxer computes and prints the Adler-32 CRC of all the input audio
  68. and video frames. By default audio frames are converted to signed
  69. 16-bit raw audio and video frames to raw video before computing the
  70. CRC.
  71. The output of the muxer consists of a single line of the form:
  72. CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
  73. 8 digits containing the CRC for all the decoded input frames.
  74. See also the @ref{framecrc} muxer.
  75. @subsection Examples
  76. For example to compute the CRC of the input, and store it in the file
  77. @file{out.crc}:
  78. @example
  79. ffmpeg -i INPUT -f crc out.crc
  80. @end example
  81. You can print the CRC to stdout with the command:
  82. @example
  83. ffmpeg -i INPUT -f crc -
  84. @end example
  85. You can select the output format of each frame with @command{ffmpeg} by
  86. specifying the audio and video codec and format. For example to
  87. compute the CRC of the input audio converted to PCM unsigned 8-bit
  88. and the input video converted to MPEG-2 video, use the command:
  89. @example
  90. ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
  91. @end example
  92. @section flv
  93. Adobe Flash Video Format muxer.
  94. This muxer accepts the following options:
  95. @table @option
  96. @item flvflags @var{flags}
  97. Possible values:
  98. @table @samp
  99. @item aac_seq_header_detect
  100. Place AAC sequence header based on audio stream data.
  101. @item no_sequence_end
  102. Disable sequence end tag.
  103. @end table
  104. @end table
  105. @anchor{framecrc}
  106. @section framecrc
  107. Per-packet CRC (Cyclic Redundancy Check) testing format.
  108. This muxer computes and prints the Adler-32 CRC for each audio
  109. and video packet. By default audio frames are converted to signed
  110. 16-bit raw audio and video frames to raw video before computing the
  111. CRC.
  112. The output of the muxer consists of a line for each audio and video
  113. packet of the form:
  114. @example
  115. @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
  116. @end example
  117. @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
  118. CRC of the packet.
  119. @subsection Examples
  120. For example to compute the CRC of the audio and video frames in
  121. @file{INPUT}, converted to raw audio and video packets, and store it
  122. in the file @file{out.crc}:
  123. @example
  124. ffmpeg -i INPUT -f framecrc out.crc
  125. @end example
  126. To print the information to stdout, use the command:
  127. @example
  128. ffmpeg -i INPUT -f framecrc -
  129. @end example
  130. With @command{ffmpeg}, you can select the output format to which the
  131. audio and video frames are encoded before computing the CRC for each
  132. packet by specifying the audio and video codec. For example, to
  133. compute the CRC of each decoded input audio frame converted to PCM
  134. unsigned 8-bit and of each decoded input video frame converted to
  135. MPEG-2 video, use the command:
  136. @example
  137. ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
  138. @end example
  139. See also the @ref{crc} muxer.
  140. @anchor{framehash}
  141. @section framehash
  142. Per-packet hash testing format.
  143. This muxer computes and prints a cryptographic hash for each audio
  144. and video packet. This can be used for packet-by-packet equality
  145. checks without having to individually do a binary comparison on each.
  146. By default audio frames are converted to signed 16-bit raw audio and
  147. video frames to raw video before computing the hash, but the output
  148. of explicit conversions to other codecs can also be used. It uses the
  149. SHA-256 cryptographic hash function by default, but supports several
  150. other algorithms.
  151. The output of the muxer consists of a line for each audio and video
  152. packet of the form:
  153. @example
  154. @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
  155. @end example
  156. @var{hash} is a hexadecimal number representing the computed hash
  157. for the packet.
  158. @table @option
  159. @item hash @var{algorithm}
  160. Use the cryptographic hash function specified by the string @var{algorithm}.
  161. Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
  162. @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
  163. @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
  164. @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
  165. @end table
  166. @subsection Examples
  167. To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
  168. converted to raw audio and video packets, and store it in the file
  169. @file{out.sha256}:
  170. @example
  171. ffmpeg -i INPUT -f framehash out.sha256
  172. @end example
  173. To print the information to stdout, using the MD5 hash function, use
  174. the command:
  175. @example
  176. ffmpeg -i INPUT -f framehash -hash md5 -
  177. @end example
  178. See also the @ref{hash} muxer.
  179. @anchor{framemd5}
  180. @section framemd5
  181. Per-packet MD5 testing format.
  182. This is a variant of the @ref{framehash} muxer. Unlike that muxer,
  183. it defaults to using the MD5 hash function.
  184. @subsection Examples
  185. To compute the MD5 hash of the audio and video frames in @file{INPUT},
  186. converted to raw audio and video packets, and store it in the file
  187. @file{out.md5}:
  188. @example
  189. ffmpeg -i INPUT -f framemd5 out.md5
  190. @end example
  191. To print the information to stdout, use the command:
  192. @example
  193. ffmpeg -i INPUT -f framemd5 -
  194. @end example
  195. See also the @ref{framehash} and @ref{md5} muxers.
  196. @anchor{gif}
  197. @section gif
  198. Animated GIF muxer.
  199. It accepts the following options:
  200. @table @option
  201. @item loop
  202. Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
  203. for looping indefinitely (default).
  204. @item final_delay
  205. Force the delay (expressed in centiseconds) after the last frame. Each frame
  206. ends with a delay until the next frame. The default is @code{-1}, which is a
  207. special value to tell the muxer to re-use the previous delay. In case of a
  208. loop, you might want to customize this value to mark a pause for instance.
  209. @end table
  210. For example, to encode a gif looping 10 times, with a 5 seconds delay between
  211. the loops:
  212. @example
  213. ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
  214. @end example
  215. Note 1: if you wish to extract the frames into separate GIF files, you need to
  216. force the @ref{image2} muxer:
  217. @example
  218. ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
  219. @end example
  220. Note 2: the GIF format has a very large time base: the delay between two frames
  221. can therefore not be smaller than one centi second.
  222. @anchor{hash}
  223. @section hash
  224. Hash testing format.
  225. This muxer computes and prints a cryptographic hash of all the input
  226. audio and video frames. This can be used for equality checks without
  227. having to do a complete binary comparison.
  228. By default audio frames are converted to signed 16-bit raw audio and
  229. video frames to raw video before computing the hash, but the output
  230. of explicit conversions to other codecs can also be used. Timestamps
  231. are ignored. It uses the SHA-256 cryptographic hash function by default,
  232. but supports several other algorithms.
  233. The output of the muxer consists of a single line of the form:
  234. @var{algo}=@var{hash}, where @var{algo} is a short string representing
  235. the hash function used, and @var{hash} is a hexadecimal number
  236. representing the computed hash.
  237. @table @option
  238. @item hash @var{algorithm}
  239. Use the cryptographic hash function specified by the string @var{algorithm}.
  240. Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
  241. @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
  242. @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
  243. @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
  244. @end table
  245. @subsection Examples
  246. To compute the SHA-256 hash of the input converted to raw audio and
  247. video, and store it in the file @file{out.sha256}:
  248. @example
  249. ffmpeg -i INPUT -f hash out.sha256
  250. @end example
  251. To print an MD5 hash to stdout use the command:
  252. @example
  253. ffmpeg -i INPUT -f hash -hash md5 -
  254. @end example
  255. See also the @ref{framehash} muxer.
  256. @anchor{hls}
  257. @section hls
  258. Apple HTTP Live Streaming muxer that segments MPEG-TS according to
  259. the HTTP Live Streaming (HLS) specification.
  260. It creates a playlist file, and one or more segment files. The output filename
  261. specifies the playlist filename.
  262. By default, the muxer creates a file for each segment produced. These files
  263. have the same name as the playlist, followed by a sequential number and a
  264. .ts extension.
  265. For example, to convert an input file with @command{ffmpeg}:
  266. @example
  267. ffmpeg -i in.nut out.m3u8
  268. @end example
  269. This example will produce the playlist, @file{out.m3u8}, and segment files:
  270. @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
  271. See also the @ref{segment} muxer, which provides a more generic and
  272. flexible implementation of a segmenter, and can be used to perform HLS
  273. segmentation.
  274. @subsection Options
  275. This muxer supports the following options:
  276. @table @option
  277. @item hls_init_time @var{seconds}
  278. Set the initial target segment length in seconds. Default value is @var{0}.
  279. Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
  280. After the initial playlist is filled @command{ffmpeg} will cut segments
  281. at duration equal to @code{hls_time}
  282. @item hls_time @var{seconds}
  283. Set the target segment length in seconds. Default value is 2.
  284. Segment will be cut on the next key frame after this time has passed.
  285. @item hls_list_size @var{size}
  286. Set the maximum number of playlist entries. If set to 0 the list file
  287. will contain all the segments. Default value is 5.
  288. @item hls_ts_options @var{options_list}
  289. Set output format options using a :-separated list of key=value
  290. parameters. Values containing @code{:} special characters must be
  291. escaped.
  292. @item hls_wrap @var{wrap}
  293. Set the number after which the segment filename number (the number
  294. specified in each segment file) wraps. If set to 0 the number will be
  295. never wrapped. Default value is 0.
  296. This option is useful to avoid to fill the disk with many segment
  297. files, and limits the maximum number of segment files written to disk
  298. to @var{wrap}.
  299. @item start_number @var{number}
  300. Start the playlist sequence number from @var{number}. Default value is
  301. 0.
  302. @item hls_allow_cache @var{allowcache}
  303. Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
  304. @item hls_base_url @var{baseurl}
  305. Append @var{baseurl} to every entry in the playlist.
  306. Useful to generate playlists with absolute paths.
  307. Note that the playlist sequence number must be unique for each segment
  308. and it is not to be confused with the segment filename sequence number
  309. which can be cyclic, for example if the @option{wrap} option is
  310. specified.
  311. @item hls_segment_filename @var{filename}
  312. Set the segment filename. Unless @code{hls_flags single_file} is set,
  313. @var{filename} is used as a string format with the segment number:
  314. @example
  315. ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
  316. @end example
  317. This example will produce the playlist, @file{out.m3u8}, and segment files:
  318. @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
  319. @item use_localtime
  320. Use strftime on @var{filename} to expand the segment filename with localtime.
  321. The segment number (%d) is not available in this mode.
  322. @example
  323. ffmpeg -i in.nut -use_localtime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
  324. @end example
  325. This example will produce the playlist, @file{out.m3u8}, and segment files:
  326. @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
  327. @item use_localtime_mkdir
  328. Used together with -use_localtime, it will create up to one subdirectory which
  329. is expanded in @var{filename}.
  330. @example
  331. ffmpeg -i in.nut -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
  332. @end example
  333. This example will create a directory 201560215 (if it does not exist), and then
  334. produce the playlist, @file{out.m3u8}, and segment files:
  335. @file{201560215/file-20160215-1455569023.ts}, @file{201560215/file-20160215-1455569024.ts}, etc.
  336. @item hls_key_info_file @var{key_info_file}
  337. Use the information in @var{key_info_file} for segment encryption. The first
  338. line of @var{key_info_file} specifies the key URI written to the playlist. The
  339. key URL is used to access the encryption key during playback. The second line
  340. specifies the path to the key file used to obtain the key during the encryption
  341. process. The key file is read as a single packed array of 16 octets in binary
  342. format. The optional third line specifies the initialization vector (IV) as a
  343. hexadecimal string to be used instead of the segment sequence number (default)
  344. for encryption. Changes to @var{key_info_file} will result in segment
  345. encryption with the new key/IV and an entry in the playlist for the new key
  346. URI/IV.
  347. Key info file format:
  348. @example
  349. @var{key URI}
  350. @var{key file path}
  351. @var{IV} (optional)
  352. @end example
  353. Example key URIs:
  354. @example
  355. http://server/file.key
  356. /path/to/file.key
  357. file.key
  358. @end example
  359. Example key file paths:
  360. @example
  361. file.key
  362. /path/to/file.key
  363. @end example
  364. Example IV:
  365. @example
  366. 0123456789ABCDEF0123456789ABCDEF
  367. @end example
  368. Key info file example:
  369. @example
  370. http://server/file.key
  371. /path/to/file.key
  372. 0123456789ABCDEF0123456789ABCDEF
  373. @end example
  374. Example shell script:
  375. @example
  376. #!/bin/sh
  377. BASE_URL=$@{1:-'.'@}
  378. openssl rand 16 > file.key
  379. echo $BASE_URL/file.key > file.keyinfo
  380. echo file.key >> file.keyinfo
  381. echo $(openssl rand -hex 16) >> file.keyinfo
  382. ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
  383. -hls_key_info_file file.keyinfo out.m3u8
  384. @end example
  385. @item hls_flags single_file
  386. If this flag is set, the muxer will store all segments in a single MPEG-TS
  387. file, and will use byte ranges in the playlist. HLS playlists generated with
  388. this way will have the version number 4.
  389. For example:
  390. @example
  391. ffmpeg -i in.nut -hls_flags single_file out.m3u8
  392. @end example
  393. Will produce the playlist, @file{out.m3u8}, and a single segment file,
  394. @file{out.ts}.
  395. @item hls_flags delete_segments
  396. Segment files removed from the playlist are deleted after a period of time
  397. equal to the duration of the segment plus the duration of the playlist.
  398. @item hls_flags append_list
  399. Append new segments into the end of old segment list,
  400. and remove the @code{#EXT-X-ENDLIST} from the old segment list.
  401. @item hls_flags round_durations
  402. Round the duration info in the playlist file segment info to integer
  403. values, instead of using floating point.
  404. @item hls_flags discont_starts
  405. Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
  406. first segment's information.
  407. @item hls_flags omit_endlist
  408. Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
  409. @item hls_flags split_by_time
  410. Allow segments to start on frames other than keyframes. This improves
  411. behavior on some players when the time between keyframes is inconsistent,
  412. but may make things worse on others, and can cause some oddities during
  413. seeking. This flag should be used with the @code{hls_time} option.
  414. @item hls_flags program_date_time
  415. Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
  416. @item hls_playlist_type event
  417. Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
  418. @option{hls_list_size} to 0; the playlist can only be appended to.
  419. @item hls_playlist_type vod
  420. Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
  421. @option{hls_list_size} to 0; the playlist must not change.
  422. @item method
  423. Use the given HTTP method to create the hls files.
  424. @example
  425. ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
  426. @end example
  427. This example will upload all the mpegts segment files to the HTTP
  428. server using the HTTP PUT method, and update the m3u8 files every
  429. @code{refresh} times using the same method.
  430. Note that the HTTP server must support the given method for uploading
  431. files.
  432. @end table
  433. @anchor{ico}
  434. @section ico
  435. ICO file muxer.
  436. Microsoft's icon file format (ICO) has some strict limitations that should be noted:
  437. @itemize
  438. @item
  439. Size cannot exceed 256 pixels in any dimension
  440. @item
  441. Only BMP and PNG images can be stored
  442. @item
  443. If a BMP image is used, it must be one of the following pixel formats:
  444. @example
  445. BMP Bit Depth FFmpeg Pixel Format
  446. 1bit pal8
  447. 4bit pal8
  448. 8bit pal8
  449. 16bit rgb555le
  450. 24bit bgr24
  451. 32bit bgra
  452. @end example
  453. @item
  454. If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
  455. @item
  456. If a PNG image is used, it must use the rgba pixel format
  457. @end itemize
  458. @anchor{image2}
  459. @section image2
  460. Image file muxer.
  461. The image file muxer writes video frames to image files.
  462. The output filenames are specified by a pattern, which can be used to
  463. produce sequentially numbered series of files.
  464. The pattern may contain the string "%d" or "%0@var{N}d", this string
  465. specifies the position of the characters representing a numbering in
  466. the filenames. If the form "%0@var{N}d" is used, the string
  467. representing the number in each filename is 0-padded to @var{N}
  468. digits. The literal character '%' can be specified in the pattern with
  469. the string "%%".
  470. If the pattern contains "%d" or "%0@var{N}d", the first filename of
  471. the file list specified will contain the number 1, all the following
  472. numbers will be sequential.
  473. The pattern may contain a suffix which is used to automatically
  474. determine the format of the image files to write.
  475. For example the pattern "img-%03d.bmp" will specify a sequence of
  476. filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
  477. @file{img-010.bmp}, etc.
  478. The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
  479. form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
  480. etc.
  481. @subsection Examples
  482. The following example shows how to use @command{ffmpeg} for creating a
  483. sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
  484. taking one image every second from the input video:
  485. @example
  486. ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
  487. @end example
  488. Note that with @command{ffmpeg}, if the format is not specified with the
  489. @code{-f} option and the output filename specifies an image file
  490. format, the image2 muxer is automatically selected, so the previous
  491. command can be written as:
  492. @example
  493. ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
  494. @end example
  495. Note also that the pattern must not necessarily contain "%d" or
  496. "%0@var{N}d", for example to create a single image file
  497. @file{img.jpeg} from the input video you can employ the command:
  498. @example
  499. ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
  500. @end example
  501. The @option{strftime} option allows you to expand the filename with
  502. date and time information. Check the documentation of
  503. the @code{strftime()} function for the syntax.
  504. For example to generate image files from the @code{strftime()}
  505. "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
  506. can be used:
  507. @example
  508. ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
  509. @end example
  510. @subsection Options
  511. @table @option
  512. @item start_number
  513. Start the sequence from the specified number. Default value is 0.
  514. @item update
  515. If set to 1, the filename will always be interpreted as just a
  516. filename, not a pattern, and the corresponding file will be continuously
  517. overwritten with new images. Default value is 0.
  518. @item strftime
  519. If set to 1, expand the filename with date and time information from
  520. @code{strftime()}. Default value is 0.
  521. @end table
  522. The image muxer supports the .Y.U.V image file format. This format is
  523. special in that that each image frame consists of three files, for
  524. each of the YUV420P components. To read or write this image file format,
  525. specify the name of the '.Y' file. The muxer will automatically open the
  526. '.U' and '.V' files as required.
  527. @section matroska
  528. Matroska container muxer.
  529. This muxer implements the matroska and webm container specs.
  530. @subsection Metadata
  531. The recognized metadata settings in this muxer are:
  532. @table @option
  533. @item title
  534. Set title name provided to a single track.
  535. @item language
  536. Specify the language of the track in the Matroska languages form.
  537. The language can be either the 3 letters bibliographic ISO-639-2 (ISO
  538. 639-2/B) form (like "fre" for French), or a language code mixed with a
  539. country code for specialities in languages (like "fre-ca" for Canadian
  540. French).
  541. @item stereo_mode
  542. Set stereo 3D video layout of two views in a single video track.
  543. The following values are recognized:
  544. @table @samp
  545. @item mono
  546. video is not stereo
  547. @item left_right
  548. Both views are arranged side by side, Left-eye view is on the left
  549. @item bottom_top
  550. Both views are arranged in top-bottom orientation, Left-eye view is at bottom
  551. @item top_bottom
  552. Both views are arranged in top-bottom orientation, Left-eye view is on top
  553. @item checkerboard_rl
  554. Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
  555. @item checkerboard_lr
  556. Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
  557. @item row_interleaved_rl
  558. Each view is constituted by a row based interleaving, Right-eye view is first row
  559. @item row_interleaved_lr
  560. Each view is constituted by a row based interleaving, Left-eye view is first row
  561. @item col_interleaved_rl
  562. Both views are arranged in a column based interleaving manner, Right-eye view is first column
  563. @item col_interleaved_lr
  564. Both views are arranged in a column based interleaving manner, Left-eye view is first column
  565. @item anaglyph_cyan_red
  566. All frames are in anaglyph format viewable through red-cyan filters
  567. @item right_left
  568. Both views are arranged side by side, Right-eye view is on the left
  569. @item anaglyph_green_magenta
  570. All frames are in anaglyph format viewable through green-magenta filters
  571. @item block_lr
  572. Both eyes laced in one Block, Left-eye view is first
  573. @item block_rl
  574. Both eyes laced in one Block, Right-eye view is first
  575. @end table
  576. @end table
  577. For example a 3D WebM clip can be created using the following command line:
  578. @example
  579. ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
  580. @end example
  581. @subsection Options
  582. This muxer supports the following options:
  583. @table @option
  584. @item reserve_index_space
  585. By default, this muxer writes the index for seeking (called cues in Matroska
  586. terms) at the end of the file, because it cannot know in advance how much space
  587. to leave for the index at the beginning of the file. However for some use cases
  588. -- e.g. streaming where seeking is possible but slow -- it is useful to put the
  589. index at the beginning of the file.
  590. If this option is set to a non-zero value, the muxer will reserve a given amount
  591. of space in the file header and then try to write the cues there when the muxing
  592. finishes. If the available space does not suffice, muxing will fail. A safe size
  593. for most use cases should be about 50kB per hour of video.
  594. Note that cues are only written if the output is seekable and this option will
  595. have no effect if it is not.
  596. @end table
  597. @anchor{md5}
  598. @section md5
  599. MD5 testing format.
  600. This is a variant of the @ref{hash} muxer. Unlike that muxer, it
  601. defaults to using the MD5 hash function.
  602. @subsection Examples
  603. To compute the MD5 hash of the input converted to raw
  604. audio and video, and store it in the file @file{out.md5}:
  605. @example
  606. ffmpeg -i INPUT -f md5 out.md5
  607. @end example
  608. You can print the MD5 to stdout with the command:
  609. @example
  610. ffmpeg -i INPUT -f md5 -
  611. @end example
  612. See also the @ref{hash} and @ref{framemd5} muxers.
  613. @section mov, mp4, ismv
  614. MOV/MP4/ISMV (Smooth Streaming) muxer.
  615. The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
  616. file has all the metadata about all packets stored in one location
  617. (written at the end of the file, it can be moved to the start for
  618. better playback by adding @var{faststart} to the @var{movflags}, or
  619. using the @command{qt-faststart} tool). A fragmented
  620. file consists of a number of fragments, where packets and metadata
  621. about these packets are stored together. Writing a fragmented
  622. file has the advantage that the file is decodable even if the
  623. writing is interrupted (while a normal MOV/MP4 is undecodable if
  624. it is not properly finished), and it requires less memory when writing
  625. very long files (since writing normal MOV/MP4 files stores info about
  626. every single packet in memory until the file is closed). The downside
  627. is that it is less compatible with other applications.
  628. @subsection Options
  629. Fragmentation is enabled by setting one of the AVOptions that define
  630. how to cut the file into fragments:
  631. @table @option
  632. @item -moov_size @var{bytes}
  633. Reserves space for the moov atom at the beginning of the file instead of placing the
  634. moov atom at the end. If the space reserved is insufficient, muxing will fail.
  635. @item -movflags frag_keyframe
  636. Start a new fragment at each video keyframe.
  637. @item -frag_duration @var{duration}
  638. Create fragments that are @var{duration} microseconds long.
  639. @item -frag_size @var{size}
  640. Create fragments that contain up to @var{size} bytes of payload data.
  641. @item -movflags frag_custom
  642. Allow the caller to manually choose when to cut fragments, by
  643. calling @code{av_write_frame(ctx, NULL)} to write a fragment with
  644. the packets written so far. (This is only useful with other
  645. applications integrating libavformat, not from @command{ffmpeg}.)
  646. @item -min_frag_duration @var{duration}
  647. Don't create fragments that are shorter than @var{duration} microseconds long.
  648. @end table
  649. If more than one condition is specified, fragments are cut when
  650. one of the specified conditions is fulfilled. The exception to this is
  651. @code{-min_frag_duration}, which has to be fulfilled for any of the other
  652. conditions to apply.
  653. Additionally, the way the output file is written can be adjusted
  654. through a few other options:
  655. @table @option
  656. @item -movflags empty_moov
  657. Write an initial moov atom directly at the start of the file, without
  658. describing any samples in it. Generally, an mdat/moov pair is written
  659. at the start of the file, as a normal MOV/MP4 file, containing only
  660. a short portion of the file. With this option set, there is no initial
  661. mdat atom, and the moov atom only describes the tracks but has
  662. a zero duration.
  663. This option is implicitly set when writing ismv (Smooth Streaming) files.
  664. @item -movflags separate_moof
  665. Write a separate moof (movie fragment) atom for each track. Normally,
  666. packets for all tracks are written in a moof atom (which is slightly
  667. more efficient), but with this option set, the muxer writes one moof/mdat
  668. pair for each track, making it easier to separate tracks.
  669. This option is implicitly set when writing ismv (Smooth Streaming) files.
  670. @item -movflags faststart
  671. Run a second pass moving the index (moov atom) to the beginning of the file.
  672. This operation can take a while, and will not work in various situations such
  673. as fragmented output, thus it is not enabled by default.
  674. @item -movflags rtphint
  675. Add RTP hinting tracks to the output file.
  676. @item -movflags disable_chpl
  677. Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
  678. and a QuickTime chapter track are written to the file. With this option
  679. set, only the QuickTime chapter track will be written. Nero chapters can
  680. cause failures when the file is reprocessed with certain tagging programs, like
  681. mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
  682. @item -movflags omit_tfhd_offset
  683. Do not write any absolute base_data_offset in tfhd atoms. This avoids
  684. tying fragments to absolute byte positions in the file/streams.
  685. @item -movflags default_base_moof
  686. Similarly to the omit_tfhd_offset, this flag avoids writing the
  687. absolute base_data_offset field in tfhd atoms, but does so by using
  688. the new default-base-is-moof flag instead. This flag is new from
  689. 14496-12:2012. This may make the fragments easier to parse in certain
  690. circumstances (avoiding basing track fragment location calculations
  691. on the implicit end of the previous track fragment).
  692. @item -write_tmcd
  693. Specify @code{on} to force writing a timecode track, @code{off} to disable it
  694. and @code{auto} to write a timecode track only for mov and mp4 output (default).
  695. @end table
  696. @subsection Example
  697. Smooth Streaming content can be pushed in real time to a publishing
  698. point on IIS with this muxer. Example:
  699. @example
  700. ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
  701. @end example
  702. @subsection Audible AAX
  703. Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
  704. @example
  705. ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
  706. @end example
  707. @section mp3
  708. The MP3 muxer writes a raw MP3 stream with the following optional features:
  709. @itemize @bullet
  710. @item
  711. An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
  712. 2.4 are supported, the @code{id3v2_version} private option controls which one is
  713. used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
  714. completely.
  715. The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
  716. The pictures are supplied to the muxer in form of a video stream with a single
  717. packet. There can be any number of those streams, each will correspond to a
  718. single APIC frame. The stream metadata tags @var{title} and @var{comment} map
  719. to APIC @var{description} and @var{picture type} respectively. See
  720. @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
  721. Note that the APIC frames must be written at the beginning, so the muxer will
  722. buffer the audio frames until it gets all the pictures. It is therefore advised
  723. to provide the pictures as soon as possible to avoid excessive buffering.
  724. @item
  725. A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
  726. default, but will be written only if the output is seekable. The
  727. @code{write_xing} private option can be used to disable it. The frame contains
  728. various information that may be useful to the decoder, like the audio duration
  729. or encoder delay.
  730. @item
  731. A legacy ID3v1 tag at the end of the file (disabled by default). It may be
  732. enabled with the @code{write_id3v1} private option, but as its capabilities are
  733. very limited, its usage is not recommended.
  734. @end itemize
  735. Examples:
  736. Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
  737. @example
  738. ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
  739. @end example
  740. To attach a picture to an mp3 file select both the audio and the picture stream
  741. with @code{map}:
  742. @example
  743. ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
  744. -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
  745. @end example
  746. Write a "clean" MP3 without any extra features:
  747. @example
  748. ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
  749. @end example
  750. @section mpegts
  751. MPEG transport stream muxer.
  752. This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
  753. The recognized metadata settings in mpegts muxer are @code{service_provider}
  754. and @code{service_name}. If they are not set the default for
  755. @code{service_provider} is "FFmpeg" and the default for
  756. @code{service_name} is "Service01".
  757. @subsection Options
  758. The muxer options are:
  759. @table @option
  760. @item mpegts_original_network_id @var{number}
  761. Set the original_network_id (default 0x0001). This is unique identifier
  762. of a network in DVB. Its main use is in the unique identification of a
  763. service through the path Original_Network_ID, Transport_Stream_ID.
  764. @item mpegts_transport_stream_id @var{number}
  765. Set the transport_stream_id (default 0x0001). This identifies a
  766. transponder in DVB.
  767. @item mpegts_service_id @var{number}
  768. Set the service_id (default 0x0001) also known as program in DVB.
  769. @item mpegts_service_type @var{number}
  770. Set the program service_type (default @var{digital_tv}), see below
  771. a list of pre defined values.
  772. @item mpegts_pmt_start_pid @var{number}
  773. Set the first PID for PMT (default 0x1000, max 0x1f00).
  774. @item mpegts_start_pid @var{number}
  775. Set the first PID for data packets (default 0x0100, max 0x0f00).
  776. @item mpegts_m2ts_mode @var{number}
  777. Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
  778. @item muxrate @var{number}
  779. Set a constant muxrate (default VBR).
  780. @item pcr_period @var{numer}
  781. Override the default PCR retransmission time (default 20ms), ignored
  782. if variable muxrate is selected.
  783. @item pat_period @var{number}
  784. Maximal time in seconds between PAT/PMT tables.
  785. @item sdt_period @var{number}
  786. Maximal time in seconds between SDT tables.
  787. @item pes_payload_size @var{number}
  788. Set minimum PES packet payload in bytes.
  789. @item mpegts_flags @var{flags}
  790. Set flags (see below).
  791. @item mpegts_copyts @var{number}
  792. Preserve original timestamps, if value is set to 1. Default value is -1, which
  793. results in shifting timestamps so that they start from 0.
  794. @item tables_version @var{number}
  795. Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
  796. This option allows updating stream structure so that standard consumer may
  797. detect the change. To do so, reopen output AVFormatContext (in case of API
  798. usage) or restart ffmpeg instance, cyclically changing tables_version value:
  799. @example
  800. ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
  801. ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
  802. ...
  803. ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
  804. ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
  805. ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
  806. ...
  807. @end example
  808. @end table
  809. Option @option{mpegts_service_type} accepts the following values:
  810. @table @option
  811. @item hex_value
  812. Any hexdecimal value between 0x01 to 0xff as defined in ETSI 300 468.
  813. @item digital_tv
  814. Digital TV service.
  815. @item digital_radio
  816. Digital Radio service.
  817. @item teletext
  818. Teletext service.
  819. @item advanced_codec_digital_radio
  820. Advanced Codec Digital Radio service.
  821. @item mpeg2_digital_hdtv
  822. MPEG2 Digital HDTV service.
  823. @item advanced_codec_digital_sdtv
  824. Advanced Codec Digital SDTV service.
  825. @item advanced_codec_digital_hdtv
  826. Advanced Codec Digital HDTV service.
  827. @end table
  828. Option @option{mpegts_flags} may take a set of such flags:
  829. @table @option
  830. @item resend_headers
  831. Reemit PAT/PMT before writing the next packet.
  832. @item latm
  833. Use LATM packetization for AAC.
  834. @item pat_pmt_at_frames
  835. Reemit PAT and PMT at each video frame.
  836. @item system_b
  837. Conform to System B (DVB) instead of System A (ATSC).
  838. @end table
  839. @subsection Example
  840. @example
  841. ffmpeg -i file.mpg -c copy \
  842. -mpegts_original_network_id 0x1122 \
  843. -mpegts_transport_stream_id 0x3344 \
  844. -mpegts_service_id 0x5566 \
  845. -mpegts_pmt_start_pid 0x1500 \
  846. -mpegts_start_pid 0x150 \
  847. -metadata service_provider="Some provider" \
  848. -metadata service_name="Some Channel" \
  849. -y out.ts
  850. @end example
  851. @section mxf, mxf_d10
  852. MXF muxer.
  853. @subsection Options
  854. The muxer options are:
  855. @table @option
  856. @item store_user_comments @var{bool}
  857. Set if user comments should be stored if available or never.
  858. IRT D-10 does not allow user comments. The default is thus to write them for
  859. mxf but not for mxf_d10
  860. @end table
  861. @section null
  862. Null muxer.
  863. This muxer does not generate any output file, it is mainly useful for
  864. testing or benchmarking purposes.
  865. For example to benchmark decoding with @command{ffmpeg} you can use the
  866. command:
  867. @example
  868. ffmpeg -benchmark -i INPUT -f null out.null
  869. @end example
  870. Note that the above command does not read or write the @file{out.null}
  871. file, but specifying the output file is required by the @command{ffmpeg}
  872. syntax.
  873. Alternatively you can write the command as:
  874. @example
  875. ffmpeg -benchmark -i INPUT -f null -
  876. @end example
  877. @section nut
  878. @table @option
  879. @item -syncpoints @var{flags}
  880. Change the syncpoint usage in nut:
  881. @table @option
  882. @item @var{default} use the normal low-overhead seeking aids.
  883. @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
  884. Use of this option is not recommended, as the resulting files are very damage
  885. sensitive and seeking is not possible. Also in general the overhead from
  886. syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
  887. all growing data tables, allowing to mux endless streams with limited memory
  888. and without these disadvantages.
  889. @item @var{timestamped} extend the syncpoint with a wallclock field.
  890. @end table
  891. The @var{none} and @var{timestamped} flags are experimental.
  892. @item -write_index @var{bool}
  893. Write index at the end, the default is to write an index.
  894. @end table
  895. @example
  896. ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
  897. @end example
  898. @section ogg
  899. Ogg container muxer.
  900. @table @option
  901. @item -page_duration @var{duration}
  902. Preferred page duration, in microseconds. The muxer will attempt to create
  903. pages that are approximately @var{duration} microseconds long. This allows the
  904. user to compromise between seek granularity and container overhead. The default
  905. is 1 second. A value of 0 will fill all segments, making pages as large as
  906. possible. A value of 1 will effectively use 1 packet-per-page in most
  907. situations, giving a small seek granularity at the cost of additional container
  908. overhead.
  909. @item -serial_offset @var{value}
  910. Serial value from which to set the streams serial number.
  911. Setting it to different and sufficiently large values ensures that the produced
  912. ogg files can be safely chained.
  913. @end table
  914. @anchor{segment}
  915. @section segment, stream_segment, ssegment
  916. Basic stream segmenter.
  917. This muxer outputs streams to a number of separate files of nearly
  918. fixed duration. Output filename pattern can be set in a fashion
  919. similar to @ref{image2}, or by using a @code{strftime} template if
  920. the @option{strftime} option is enabled.
  921. @code{stream_segment} is a variant of the muxer used to write to
  922. streaming output formats, i.e. which do not require global headers,
  923. and is recommended for outputting e.g. to MPEG transport stream segments.
  924. @code{ssegment} is a shorter alias for @code{stream_segment}.
  925. Every segment starts with a keyframe of the selected reference stream,
  926. which is set through the @option{reference_stream} option.
  927. Note that if you want accurate splitting for a video file, you need to
  928. make the input key frames correspond to the exact splitting times
  929. expected by the segmenter, or the segment muxer will start the new
  930. segment with the key frame found next after the specified start
  931. time.
  932. The segment muxer works best with a single constant frame rate video.
  933. Optionally it can generate a list of the created segments, by setting
  934. the option @var{segment_list}. The list type is specified by the
  935. @var{segment_list_type} option. The entry filenames in the segment
  936. list are set by default to the basename of the corresponding segment
  937. files.
  938. See also the @ref{hls} muxer, which provides a more specific
  939. implementation for HLS segmentation.
  940. @subsection Options
  941. The segment muxer supports the following options:
  942. @table @option
  943. @item increment_tc @var{1|0}
  944. if set to @code{1}, increment timecode between each segment
  945. If this is selected, the input need to have
  946. a timecode in the first video stream. Default value is
  947. @code{0}.
  948. @item reference_stream @var{specifier}
  949. Set the reference stream, as specified by the string @var{specifier}.
  950. If @var{specifier} is set to @code{auto}, the reference is chosen
  951. automatically. Otherwise it must be a stream specifier (see the ``Stream
  952. specifiers'' chapter in the ffmpeg manual) which specifies the
  953. reference stream. The default value is @code{auto}.
  954. @item segment_format @var{format}
  955. Override the inner container format, by default it is guessed by the filename
  956. extension.
  957. @item segment_format_options @var{options_list}
  958. Set output format options using a :-separated list of key=value
  959. parameters. Values containing the @code{:} special character must be
  960. escaped.
  961. @item segment_list @var{name}
  962. Generate also a listfile named @var{name}. If not specified no
  963. listfile is generated.
  964. @item segment_list_flags @var{flags}
  965. Set flags affecting the segment list generation.
  966. It currently supports the following flags:
  967. @table @samp
  968. @item cache
  969. Allow caching (only affects M3U8 list files).
  970. @item live
  971. Allow live-friendly file generation.
  972. @end table
  973. @item segment_list_size @var{size}
  974. Update the list file so that it contains at most @var{size}
  975. segments. If 0 the list file will contain all the segments. Default
  976. value is 0.
  977. @item segment_list_entry_prefix @var{prefix}
  978. Prepend @var{prefix} to each entry. Useful to generate absolute paths.
  979. By default no prefix is applied.
  980. @item segment_list_type @var{type}
  981. Select the listing format.
  982. The following values are recognized:
  983. @table @samp
  984. @item flat
  985. Generate a flat list for the created segments, one segment per line.
  986. @item csv, ext
  987. Generate a list for the created segments, one segment per line,
  988. each line matching the format (comma-separated values):
  989. @example
  990. @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
  991. @end example
  992. @var{segment_filename} is the name of the output file generated by the
  993. muxer according to the provided pattern. CSV escaping (according to
  994. RFC4180) is applied if required.
  995. @var{segment_start_time} and @var{segment_end_time} specify
  996. the segment start and end time expressed in seconds.
  997. A list file with the suffix @code{".csv"} or @code{".ext"} will
  998. auto-select this format.
  999. @samp{ext} is deprecated in favor or @samp{csv}.
  1000. @item ffconcat
  1001. Generate an ffconcat file for the created segments. The resulting file
  1002. can be read using the FFmpeg @ref{concat} demuxer.
  1003. A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
  1004. auto-select this format.
  1005. @item m3u8
  1006. Generate an extended M3U8 file, version 3, compliant with
  1007. @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
  1008. A list file with the suffix @code{".m3u8"} will auto-select this format.
  1009. @end table
  1010. If not specified the type is guessed from the list file name suffix.
  1011. @item segment_time @var{time}
  1012. Set segment duration to @var{time}, the value must be a duration
  1013. specification. Default value is "2". See also the
  1014. @option{segment_times} option.
  1015. Note that splitting may not be accurate, unless you force the
  1016. reference stream key-frames at the given time. See the introductory
  1017. notice and the examples below.
  1018. @item segment_atclocktime @var{1|0}
  1019. If set to "1" split at regular clock time intervals starting from 00:00
  1020. o'clock. The @var{time} value specified in @option{segment_time} is
  1021. used for setting the length of the splitting interval.
  1022. For example with @option{segment_time} set to "900" this makes it possible
  1023. to create files at 12:00 o'clock, 12:15, 12:30, etc.
  1024. Default value is "0".
  1025. @item segment_clocktime_offset @var{duration}
  1026. Delay the segment splitting times with the specified duration when using
  1027. @option{segment_atclocktime}.
  1028. For example with @option{segment_time} set to "900" and
  1029. @option{segment_clocktime_offset} set to "300" this makes it possible to
  1030. create files at 12:05, 12:20, 12:35, etc.
  1031. Default value is "0".
  1032. @item segment_clocktime_wrap_duration @var{duration}
  1033. Force the segmenter to only start a new segment if a packet reaches the muxer
  1034. within the specified duration after the segmenting clock time. This way you
  1035. can make the segmenter more resilient to backward local time jumps, such as
  1036. leap seconds or transition to standard time from daylight savings time.
  1037. Assuming that the delay between the packets of your source is less than 0.5
  1038. second you can detect a leap second by specifying 0.5 as the duration.
  1039. Default is the maximum possible duration which means starting a new segment
  1040. regardless of the elapsed time since the last clock time.
  1041. @item segment_time_delta @var{delta}
  1042. Specify the accuracy time when selecting the start time for a
  1043. segment, expressed as a duration specification. Default value is "0".
  1044. When delta is specified a key-frame will start a new segment if its
  1045. PTS satisfies the relation:
  1046. @example
  1047. PTS >= start_time - time_delta
  1048. @end example
  1049. This option is useful when splitting video content, which is always
  1050. split at GOP boundaries, in case a key frame is found just before the
  1051. specified split time.
  1052. In particular may be used in combination with the @file{ffmpeg} option
  1053. @var{force_key_frames}. The key frame times specified by
  1054. @var{force_key_frames} may not be set accurately because of rounding
  1055. issues, with the consequence that a key frame time may result set just
  1056. before the specified time. For constant frame rate videos a value of
  1057. 1/(2*@var{frame_rate}) should address the worst case mismatch between
  1058. the specified time and the time set by @var{force_key_frames}.
  1059. @item segment_times @var{times}
  1060. Specify a list of split points. @var{times} contains a list of comma
  1061. separated duration specifications, in increasing order. See also
  1062. the @option{segment_time} option.
  1063. @item segment_frames @var{frames}
  1064. Specify a list of split video frame numbers. @var{frames} contains a
  1065. list of comma separated integer numbers, in increasing order.
  1066. This option specifies to start a new segment whenever a reference
  1067. stream key frame is found and the sequential number (starting from 0)
  1068. of the frame is greater or equal to the next value in the list.
  1069. @item segment_wrap @var{limit}
  1070. Wrap around segment index once it reaches @var{limit}.
  1071. @item segment_start_number @var{number}
  1072. Set the sequence number of the first segment. Defaults to @code{0}.
  1073. @item strftime @var{1|0}
  1074. Use the @code{strftime} function to define the name of the new
  1075. segments to write. If this is selected, the output segment name must
  1076. contain a @code{strftime} function template. Default value is
  1077. @code{0}.
  1078. @item break_non_keyframes @var{1|0}
  1079. If enabled, allow segments to start on frames other than keyframes. This
  1080. improves behavior on some players when the time between keyframes is
  1081. inconsistent, but may make things worse on others, and can cause some oddities
  1082. during seeking. Defaults to @code{0}.
  1083. @item reset_timestamps @var{1|0}
  1084. Reset timestamps at the begin of each segment, so that each segment
  1085. will start with near-zero timestamps. It is meant to ease the playback
  1086. of the generated segments. May not work with some combinations of
  1087. muxers/codecs. It is set to @code{0} by default.
  1088. @item initial_offset @var{offset}
  1089. Specify timestamp offset to apply to the output packet timestamps. The
  1090. argument must be a time duration specification, and defaults to 0.
  1091. @item write_empty_segments @var{1|0}
  1092. If enabled, write an empty segment if there are no packets during the period a
  1093. segment would usually span. Otherwise, the segment will be filled with the next
  1094. packet written. Defaults to @code{0}.
  1095. @end table
  1096. @subsection Examples
  1097. @itemize
  1098. @item
  1099. Remux the content of file @file{in.mkv} to a list of segments
  1100. @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
  1101. generated segments to @file{out.list}:
  1102. @example
  1103. ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
  1104. @end example
  1105. @item
  1106. Segment input and set output format options for the output segments:
  1107. @example
  1108. ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
  1109. @end example
  1110. @item
  1111. Segment the input file according to the split points specified by the
  1112. @var{segment_times} option:
  1113. @example
  1114. ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 out%03d.nut
  1115. @end example
  1116. @item
  1117. Use the @command{ffmpeg} @option{force_key_frames}
  1118. option to force key frames in the input at the specified location, together
  1119. with the segment option @option{segment_time_delta} to account for
  1120. possible roundings operated when setting key frame times.
  1121. @example
  1122. ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
  1123. -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
  1124. @end example
  1125. In order to force key frames on the input file, transcoding is
  1126. required.
  1127. @item
  1128. Segment the input file by splitting the input file according to the
  1129. frame numbers sequence specified with the @option{segment_frames} option:
  1130. @example
  1131. ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
  1132. @end example
  1133. @item
  1134. Convert the @file{in.mkv} to TS segments using the @code{libx264}
  1135. and @code{aac} encoders:
  1136. @example
  1137. ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
  1138. @end example
  1139. @item
  1140. Segment the input file, and create an M3U8 live playlist (can be used
  1141. as live HLS source):
  1142. @example
  1143. ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
  1144. -segment_list_flags +live -segment_time 10 out%03d.mkv
  1145. @end example
  1146. @end itemize
  1147. @section smoothstreaming
  1148. Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
  1149. @table @option
  1150. @item window_size
  1151. Specify the number of fragments kept in the manifest. Default 0 (keep all).
  1152. @item extra_window_size
  1153. Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
  1154. @item lookahead_count
  1155. Specify the number of lookahead fragments. Default 2.
  1156. @item min_frag_duration
  1157. Specify the minimum fragment duration (in microseconds). Default 5000000.
  1158. @item remove_at_exit
  1159. Specify whether to remove all fragments when finished. Default 0 (do not remove).
  1160. @end table
  1161. @section fifo
  1162. The fifo pseudo-muxer allows the separation of encoding and muxing by using
  1163. first-in-first-out queue and running the actual muxer in a separate thread. This
  1164. is especially useful in combination with the @ref{tee} muxer and can be used to
  1165. send data to several destinations with different reliability/writing speed/latency.
  1166. API users should be aware that callback functions (interrupt_callback,
  1167. io_open and io_close) used within its AVFormatContext must be thread-safe.
  1168. The behavior of the fifo muxer if the queue fills up or if the output fails is
  1169. selectable,
  1170. @itemize @bullet
  1171. @item
  1172. output can be transparently restarted with configurable delay between retries
  1173. based on real time or time of the processed stream.
  1174. @item
  1175. encoding can be blocked during temporary failure, or continue transparently
  1176. dropping packets in case fifo queue fills up.
  1177. @end itemize
  1178. @table @option
  1179. @item fifo_format
  1180. Specify the format name. Useful if it cannot be guessed from the
  1181. output name suffix.
  1182. @item queue_size
  1183. Specify size of the queue (number of packets). Default value is 60.
  1184. @item format_opts
  1185. Specify format options for the underlying muxer. Muxer options can be specified
  1186. as a list of @var{key}=@var{value} pairs separated by ':'.
  1187. @item drop_pkts_on_overflow @var{bool}
  1188. If set to 1 (true), in case the fifo queue fills up, packets will be dropped
  1189. rather than blocking the encoder. This makes it possible to continue streaming without
  1190. delaying the input, at the cost of omitting part of the stream. By default
  1191. this option is set to 0 (false), so in such cases the encoder will be blocked
  1192. until the muxer processes some of the packets and none of them is lost.
  1193. @item attempt_recovery @var{bool}
  1194. If failure occurs, attempt to recover the output. This is especially useful
  1195. when used with network output, since it makes it possible to restart streaming transparently.
  1196. By default this option is set to 0 (false).
  1197. @item max_recovery_attempts
  1198. Sets maximum number of successive unsuccessful recovery attempts after which
  1199. the output fails permanently. By default this option is set to 0 (unlimited).
  1200. @item recovery_wait_time @var{duration}
  1201. Waiting time before the next recovery attempt after previous unsuccessful
  1202. recovery attempt. Default value is 5 seconds.
  1203. @item recovery_wait_streamtime @var{bool}
  1204. If set to 0 (false), the real time is used when waiting for the recovery
  1205. attempt (i.e. the recovery will be attempted after at least
  1206. recovery_wait_time seconds).
  1207. If set to 1 (true), the time of the processed stream is taken into account
  1208. instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
  1209. seconds of the stream is omitted).
  1210. By default, this option is set to 0 (false).
  1211. @item recover_any_error @var{bool}
  1212. If set to 1 (true), recovery will be attempted regardless of type of the error
  1213. causing the failure. By default this option is set to 0 (false) and in case of
  1214. certain (usually permanent) errors the recovery is not attempted even when
  1215. @var{attempt_recovery} is set to 1.
  1216. @item restart_with_keyframe @var{bool}
  1217. Specify whether to wait for the keyframe after recovering from
  1218. queue overflow or failure. This option is set to 0 (false) by default.
  1219. @end table
  1220. @subsection Examples
  1221. @itemize
  1222. @item
  1223. Stream something to rtmp server, continue processing the stream at real-time
  1224. rate even in case of temporary failure (network outage) and attempt to recover
  1225. streaming every second indefinitely.
  1226. @example
  1227. ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
  1228. -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
  1229. @end example
  1230. @end itemize
  1231. @anchor{tee}
  1232. @section tee
  1233. The tee muxer can be used to write the same data to several files or any
  1234. other kind of muxer. It can be used, for example, to both stream a video to
  1235. the network and save it to disk at the same time.
  1236. It is different from specifying several outputs to the @command{ffmpeg}
  1237. command-line tool because the audio and video data will be encoded only once
  1238. with the tee muxer; encoding can be a very expensive process. It is not
  1239. useful when using the libavformat API directly because it is then possible
  1240. to feed the same packets to several muxers directly.
  1241. The slave outputs are specified in the file name given to the muxer,
  1242. separated by '|'. If any of the slave name contains the '|' separator,
  1243. leading or trailing spaces or any special character, it must be
  1244. escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
  1245. section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
  1246. Muxer options can be specified for each slave by prepending them as a list of
  1247. @var{key}=@var{value} pairs separated by ':', between square brackets. If
  1248. the options values contain a special character or the ':' separator, they
  1249. must be escaped; note that this is a second level escaping.
  1250. The following special options are also recognized:
  1251. @table @option
  1252. @item f
  1253. Specify the format name. Useful if it cannot be guessed from the
  1254. output name suffix.
  1255. @item bsfs[/@var{spec}]
  1256. Specify a list of bitstream filters to apply to the specified
  1257. output.
  1258. It is possible to specify to which streams a given bitstream filter
  1259. applies, by appending a stream specifier to the option separated by
  1260. @code{/}. @var{spec} must be a stream specifier (see @ref{Format
  1261. stream specifiers}). If the stream specifier is not specified, the
  1262. bitstream filters will be applied to all streams in the output.
  1263. Several bitstream filters can be specified, separated by ",".
  1264. @item select
  1265. Select the streams that should be mapped to the slave output,
  1266. specified by a stream specifier. If not specified, this defaults to
  1267. all the input streams. You may use multiple stream specifiers
  1268. separated by commas (@code{,}) e.g.: @code{a:0,v}
  1269. @item onfail
  1270. Specify behaviour on output failure. This can be set to either @code{abort} (which is
  1271. default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
  1272. on this slave output. @code{ignore} will ignore failure on this output, so other outputs
  1273. will continue without being affected.
  1274. @end table
  1275. @subsection Examples
  1276. @itemize
  1277. @item
  1278. Encode something and both archive it in a WebM file and stream it
  1279. as MPEG-TS over UDP (the streams need to be explicitly mapped):
  1280. @example
  1281. ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
  1282. "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
  1283. @end example
  1284. @item
  1285. As above, but continue streaming even if output to local file fails
  1286. (for example local drive fills up):
  1287. @example
  1288. ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
  1289. "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
  1290. @end example
  1291. @item
  1292. Use @command{ffmpeg} to encode the input, and send the output
  1293. to three different destinations. The @code{dump_extra} bitstream
  1294. filter is used to add extradata information to all the output video
  1295. keyframes packets, as requested by the MPEG-TS format. The select
  1296. option is applied to @file{out.aac} in order to make it contain only
  1297. audio packets.
  1298. @example
  1299. ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
  1300. -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
  1301. @end example
  1302. @item
  1303. As below, but select only stream @code{a:1} for the audio output. Note
  1304. that a second level escaping must be performed, as ":" is a special
  1305. character used to separate options.
  1306. @example
  1307. ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
  1308. -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
  1309. @end example
  1310. @end itemize
  1311. Note: some codecs may need different options depending on the output format;
  1312. the auto-detection of this can not work with the tee muxer. The main example
  1313. is the @option{global_header} flag.
  1314. @section webm_dash_manifest
  1315. WebM DASH Manifest muxer.
  1316. This muxer implements the WebM DASH Manifest specification to generate the DASH
  1317. manifest XML. It also supports manifest generation for DASH live streams.
  1318. For more information see:
  1319. @itemize @bullet
  1320. @item
  1321. WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
  1322. @item
  1323. ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
  1324. @end itemize
  1325. @subsection Options
  1326. This muxer supports the following options:
  1327. @table @option
  1328. @item adaptation_sets
  1329. This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
  1330. unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
  1331. audio and video streams. Any number of adaptation sets can be added using this option.
  1332. @item live
  1333. Set this to 1 to create a live stream DASH Manifest. Default: 0.
  1334. @item chunk_start_index
  1335. Start index of the first chunk. This will go in the @samp{startNumber} attribute
  1336. of the @samp{SegmentTemplate} element in the manifest. Default: 0.
  1337. @item chunk_duration_ms
  1338. Duration of each chunk in milliseconds. This will go in the @samp{duration}
  1339. attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
  1340. @item utc_timing_url
  1341. URL of the page that will return the UTC timestamp in ISO format. This will go
  1342. in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
  1343. Default: None.
  1344. @item time_shift_buffer_depth
  1345. Smallest time (in seconds) shifting buffer for which any Representation is
  1346. guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
  1347. attribute of the @samp{MPD} element. Default: 60.
  1348. @item minimum_update_period
  1349. Minimum update period (in seconds) of the manifest. This will go in the
  1350. @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
  1351. @end table
  1352. @subsection Example
  1353. @example
  1354. ffmpeg -f webm_dash_manifest -i video1.webm \
  1355. -f webm_dash_manifest -i video2.webm \
  1356. -f webm_dash_manifest -i audio1.webm \
  1357. -f webm_dash_manifest -i audio2.webm \
  1358. -map 0 -map 1 -map 2 -map 3 \
  1359. -c copy \
  1360. -f webm_dash_manifest \
  1361. -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
  1362. manifest.xml
  1363. @end example
  1364. @section webm_chunk
  1365. WebM Live Chunk Muxer.
  1366. This muxer writes out WebM headers and chunks as separate files which can be
  1367. consumed by clients that support WebM Live streams via DASH.
  1368. @subsection Options
  1369. This muxer supports the following options:
  1370. @table @option
  1371. @item chunk_start_index
  1372. Index of the first chunk (defaults to 0).
  1373. @item header
  1374. Filename of the header where the initialization data will be written.
  1375. @item audio_chunk_duration
  1376. Duration of each audio chunk in milliseconds (defaults to 5000).
  1377. @end table
  1378. @subsection Example
  1379. @example
  1380. ffmpeg -f v4l2 -i /dev/video0 \
  1381. -f alsa -i hw:0 \
  1382. -map 0:0 \
  1383. -c:v libvpx-vp9 \
  1384. -s 640x360 -keyint_min 30 -g 30 \
  1385. -f webm_chunk \
  1386. -header webm_live_video_360.hdr \
  1387. -chunk_start_index 1 \
  1388. webm_live_video_360_%d.chk \
  1389. -map 1:0 \
  1390. -c:a libvorbis \
  1391. -b:a 128k \
  1392. -f webm_chunk \
  1393. -header webm_live_audio_128.hdr \
  1394. -chunk_start_index 1 \
  1395. -audio_chunk_duration 1000 \
  1396. webm_live_audio_128_%d.chk
  1397. @end example
  1398. @c man end MUXERS