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.

2501 lines
94KB

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