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

2242 lines
81KB

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