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.

1619 lines
55KB

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