muxers.texi 81 KB

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