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.

1792 lines
61KB

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