muxers.texi 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  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. It accepts the following options:
  19. @table @option
  20. @item write_id3v2
  21. Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
  22. @item id3v2_version
  23. Select ID3v2 version to write. Currently only version 3 and 4 (aka.
  24. ID3v2.3 and ID3v2.4) are supported. The default is version 4.
  25. @end table
  26. @anchor{crc}
  27. @section crc
  28. CRC (Cyclic Redundancy Check) testing format.
  29. This muxer computes and prints the Adler-32 CRC of all the input audio
  30. and video frames. By default audio frames are converted to signed
  31. 16-bit raw audio and video frames to raw video before computing the
  32. CRC.
  33. The output of the muxer consists of a single line of the form:
  34. CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
  35. 8 digits containing the CRC for all the decoded input frames.
  36. For example to compute the CRC of the input, and store it in the file
  37. @file{out.crc}:
  38. @example
  39. ffmpeg -i INPUT -f crc out.crc
  40. @end example
  41. You can print the CRC to stdout with the command:
  42. @example
  43. ffmpeg -i INPUT -f crc -
  44. @end example
  45. You can select the output format of each frame with @command{ffmpeg} by
  46. specifying the audio and video codec and format. For example to
  47. compute the CRC of the input audio converted to PCM unsigned 8-bit
  48. and the input video converted to MPEG-2 video, use the command:
  49. @example
  50. ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
  51. @end example
  52. See also the @ref{framecrc} muxer.
  53. @anchor{framecrc}
  54. @section framecrc
  55. Per-packet CRC (Cyclic Redundancy Check) testing format.
  56. This muxer computes and prints the Adler-32 CRC for each audio
  57. and video packet. By default audio frames are converted to signed
  58. 16-bit raw audio and video frames to raw video before computing the
  59. CRC.
  60. The output of the muxer consists of a line for each audio and video
  61. packet of the form:
  62. @example
  63. @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
  64. @end example
  65. @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
  66. CRC of the packet.
  67. For example to compute the CRC of the audio and video frames in
  68. @file{INPUT}, converted to raw audio and video packets, and store it
  69. in the file @file{out.crc}:
  70. @example
  71. ffmpeg -i INPUT -f framecrc out.crc
  72. @end example
  73. To print the information to stdout, use the command:
  74. @example
  75. ffmpeg -i INPUT -f framecrc -
  76. @end example
  77. With @command{ffmpeg}, you can select the output format to which the
  78. audio and video frames are encoded before computing the CRC for each
  79. packet by specifying the audio and video codec. For example, to
  80. compute the CRC of each decoded input audio frame converted to PCM
  81. unsigned 8-bit and of each decoded input video frame converted to
  82. MPEG-2 video, use the command:
  83. @example
  84. ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
  85. @end example
  86. See also the @ref{crc} muxer.
  87. @anchor{framemd5}
  88. @section framemd5
  89. Per-packet MD5 testing format.
  90. This muxer computes and prints the MD5 hash for each audio
  91. and video packet. By default audio frames are converted to signed
  92. 16-bit raw audio and video frames to raw video before computing the
  93. hash.
  94. The output of the muxer consists of a line for each audio and video
  95. packet of the form:
  96. @example
  97. @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
  98. @end example
  99. @var{MD5} is a hexadecimal number representing the computed MD5 hash
  100. for the packet.
  101. For example to compute the MD5 of the audio and video frames in
  102. @file{INPUT}, converted to raw audio and video packets, and store it
  103. in the file @file{out.md5}:
  104. @example
  105. ffmpeg -i INPUT -f framemd5 out.md5
  106. @end example
  107. To print the information to stdout, use the command:
  108. @example
  109. ffmpeg -i INPUT -f framemd5 -
  110. @end example
  111. See also the @ref{md5} muxer.
  112. @anchor{hls}
  113. @section hls
  114. Apple HTTP Live Streaming muxer that segments MPEG-TS according to
  115. the HTTP Live Streaming specification.
  116. It creates a playlist file and numbered segment files. The output
  117. filename specifies the playlist filename; the segment filenames
  118. receive the same basename as the playlist, a sequential number and
  119. a .ts extension.
  120. @example
  121. ffmpeg -i in.nut out.m3u8
  122. @end example
  123. @table @option
  124. @item -hls_time @var{seconds}
  125. Set the segment length in seconds.
  126. @item -hls_list_size @var{size}
  127. Set the maximum number of playlist entries.
  128. @item -hls_wrap @var{wrap}
  129. Set the number after which index wraps.
  130. @item -start_number @var{number}
  131. Start the sequence from @var{number}.
  132. @end table
  133. @anchor{ico}
  134. @section ico
  135. ICO file muxer.
  136. Microsoft's icon file format (ICO) has some strict limitations that should be noted:
  137. @itemize
  138. @item
  139. Size cannot exceed 256 pixels in any dimension
  140. @item
  141. Only BMP and PNG images can be stored
  142. @item
  143. If a BMP image is used, it must be one of the following pixel formats:
  144. @example
  145. BMP Bit Depth FFmpeg Pixel Format
  146. 1bit pal8
  147. 4bit pal8
  148. 8bit pal8
  149. 16bit rgb555le
  150. 24bit bgr24
  151. 32bit bgra
  152. @end example
  153. @item
  154. If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
  155. @item
  156. If a PNG image is used, it must use the rgba pixel format
  157. @end itemize
  158. @anchor{image2}
  159. @section image2
  160. Image file muxer.
  161. The image file muxer writes video frames to image files.
  162. The output filenames are specified by a pattern, which can be used to
  163. produce sequentially numbered series of files.
  164. The pattern may contain the string "%d" or "%0@var{N}d", this string
  165. specifies the position of the characters representing a numbering in
  166. the filenames. If the form "%0@var{N}d" is used, the string
  167. representing the number in each filename is 0-padded to @var{N}
  168. digits. The literal character '%' can be specified in the pattern with
  169. the string "%%".
  170. If the pattern contains "%d" or "%0@var{N}d", the first filename of
  171. the file list specified will contain the number 1, all the following
  172. numbers will be sequential.
  173. The pattern may contain a suffix which is used to automatically
  174. determine the format of the image files to write.
  175. For example the pattern "img-%03d.bmp" will specify a sequence of
  176. filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
  177. @file{img-010.bmp}, etc.
  178. The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
  179. form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
  180. etc.
  181. The following example shows how to use @command{ffmpeg} for creating a
  182. sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
  183. taking one image every second from the input video:
  184. @example
  185. ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
  186. @end example
  187. Note that with @command{ffmpeg}, if the format is not specified with the
  188. @code{-f} option and the output filename specifies an image file
  189. format, the image2 muxer is automatically selected, so the previous
  190. command can be written as:
  191. @example
  192. ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
  193. @end example
  194. Note also that the pattern must not necessarily contain "%d" or
  195. "%0@var{N}d", for example to create a single image file
  196. @file{img.jpeg} from the input video you can employ the command:
  197. @example
  198. ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
  199. @end example
  200. @table @option
  201. @item start_number @var{number}
  202. Start the sequence from @var{number}. Default value is 1. Must be a
  203. positive number.
  204. @item -update @var{number}
  205. If @var{number} is nonzero, the filename will always be interpreted as just a
  206. filename, not a pattern, and this file will be continuously overwritten with new
  207. images.
  208. @end table
  209. The image muxer supports the .Y.U.V image file format. This format is
  210. special in that that each image frame consists of three files, for
  211. each of the YUV420P components. To read or write this image file format,
  212. specify the name of the '.Y' file. The muxer will automatically open the
  213. '.U' and '.V' files as required.
  214. @section matroska
  215. Matroska container muxer.
  216. This muxer implements the matroska and webm container specs.
  217. The recognized metadata settings in this muxer are:
  218. @table @option
  219. @item title=@var{title name}
  220. Name provided to a single track
  221. @end table
  222. @table @option
  223. @item language=@var{language name}
  224. Specifies the language of the track in the Matroska languages form
  225. @end table
  226. @table @option
  227. @item stereo_mode=@var{mode}
  228. Stereo 3D video layout of two views in a single video track
  229. @table @option
  230. @item mono
  231. video is not stereo
  232. @item left_right
  233. Both views are arranged side by side, Left-eye view is on the left
  234. @item bottom_top
  235. Both views are arranged in top-bottom orientation, Left-eye view is at bottom
  236. @item top_bottom
  237. Both views are arranged in top-bottom orientation, Left-eye view is on top
  238. @item checkerboard_rl
  239. Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
  240. @item checkerboard_lr
  241. Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
  242. @item row_interleaved_rl
  243. Each view is constituted by a row based interleaving, Right-eye view is first row
  244. @item row_interleaved_lr
  245. Each view is constituted by a row based interleaving, Left-eye view is first row
  246. @item col_interleaved_rl
  247. Both views are arranged in a column based interleaving manner, Right-eye view is first column
  248. @item col_interleaved_lr
  249. Both views are arranged in a column based interleaving manner, Left-eye view is first column
  250. @item anaglyph_cyan_red
  251. All frames are in anaglyph format viewable through red-cyan filters
  252. @item right_left
  253. Both views are arranged side by side, Right-eye view is on the left
  254. @item anaglyph_green_magenta
  255. All frames are in anaglyph format viewable through green-magenta filters
  256. @item block_lr
  257. Both eyes laced in one Block, Left-eye view is first
  258. @item block_rl
  259. Both eyes laced in one Block, Right-eye view is first
  260. @end table
  261. @end table
  262. For example a 3D WebM clip can be created using the following command line:
  263. @example
  264. ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
  265. @end example
  266. This muxer supports the following options:
  267. @table @option
  268. @item reserve_index_space
  269. By default, this muxer writes the index for seeking (called cues in Matroska
  270. terms) at the end of the file, because it cannot know in advance how much space
  271. to leave for the index at the beginning of the file. However for some use cases
  272. -- e.g. streaming where seeking is possible but slow -- it is useful to put the
  273. index at the beginning of the file.
  274. If this option is set to a non-zero value, the muxer will reserve a given amount
  275. of space in the file header and then try to write the cues there when the muxing
  276. finishes. If the available space does not suffice, muxing will fail. A safe size
  277. for most use cases should be about 50kB per hour of video.
  278. Note that cues are only written if the output is seekable and this option will
  279. have no effect if it is not.
  280. @end table
  281. @anchor{md5}
  282. @section md5
  283. MD5 testing format.
  284. This muxer computes and prints the MD5 hash of all the input audio
  285. and video frames. By default audio frames are converted to signed
  286. 16-bit raw audio and video frames to raw video before computing the
  287. hash.
  288. The output of the muxer consists of a single line of the form:
  289. MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
  290. the computed MD5 hash.
  291. For example to compute the MD5 hash of the input converted to raw
  292. audio and video, and store it in the file @file{out.md5}:
  293. @example
  294. ffmpeg -i INPUT -f md5 out.md5
  295. @end example
  296. You can print the MD5 to stdout with the command:
  297. @example
  298. ffmpeg -i INPUT -f md5 -
  299. @end example
  300. See also the @ref{framemd5} muxer.
  301. @section MOV/MP4/ISMV
  302. The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
  303. file has all the metadata about all packets stored in one location
  304. (written at the end of the file, it can be moved to the start for
  305. better playback by adding @var{faststart} to the @var{movflags}, or
  306. using the @command{qt-faststart} tool). A fragmented
  307. file consists of a number of fragments, where packets and metadata
  308. about these packets are stored together. Writing a fragmented
  309. file has the advantage that the file is decodable even if the
  310. writing is interrupted (while a normal MOV/MP4 is undecodable if
  311. it is not properly finished), and it requires less memory when writing
  312. very long files (since writing normal MOV/MP4 files stores info about
  313. every single packet in memory until the file is closed). The downside
  314. is that it is less compatible with other applications.
  315. Fragmentation is enabled by setting one of the AVOptions that define
  316. how to cut the file into fragments:
  317. @table @option
  318. @item -moov_size @var{bytes}
  319. Reserves space for the moov atom at the beginning of the file instead of placing the
  320. moov atom at the end. If the space reserved is insufficient, muxing will fail.
  321. @item -movflags frag_keyframe
  322. Start a new fragment at each video keyframe.
  323. @item -frag_duration @var{duration}
  324. Create fragments that are @var{duration} microseconds long.
  325. @item -frag_size @var{size}
  326. Create fragments that contain up to @var{size} bytes of payload data.
  327. @item -movflags frag_custom
  328. Allow the caller to manually choose when to cut fragments, by
  329. calling @code{av_write_frame(ctx, NULL)} to write a fragment with
  330. the packets written so far. (This is only useful with other
  331. applications integrating libavformat, not from @command{ffmpeg}.)
  332. @item -min_frag_duration @var{duration}
  333. Don't create fragments that are shorter than @var{duration} microseconds long.
  334. @end table
  335. If more than one condition is specified, fragments are cut when
  336. one of the specified conditions is fulfilled. The exception to this is
  337. @code{-min_frag_duration}, which has to be fulfilled for any of the other
  338. conditions to apply.
  339. Additionally, the way the output file is written can be adjusted
  340. through a few other options:
  341. @table @option
  342. @item -movflags empty_moov
  343. Write an initial moov atom directly at the start of the file, without
  344. describing any samples in it. Generally, an mdat/moov pair is written
  345. at the start of the file, as a normal MOV/MP4 file, containing only
  346. a short portion of the file. With this option set, there is no initial
  347. mdat atom, and the moov atom only describes the tracks but has
  348. a zero duration.
  349. Files written with this option set do not work in QuickTime.
  350. This option is implicitly set when writing ismv (Smooth Streaming) files.
  351. @item -movflags separate_moof
  352. Write a separate moof (movie fragment) atom for each track. Normally,
  353. packets for all tracks are written in a moof atom (which is slightly
  354. more efficient), but with this option set, the muxer writes one moof/mdat
  355. pair for each track, making it easier to separate tracks.
  356. This option is implicitly set when writing ismv (Smooth Streaming) files.
  357. @item -movflags faststart
  358. Run a second pass moving the moov atom on top of the file. This
  359. operation can take a while, and will not work in various situations such
  360. as fragmented output, thus it is not enabled by default.
  361. @item -movflags rtphint
  362. Add RTP hinting tracks to the output file.
  363. @end table
  364. Smooth Streaming content can be pushed in real time to a publishing
  365. point on IIS with this muxer. Example:
  366. @example
  367. ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
  368. @end example
  369. @section mp3
  370. The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
  371. optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
  372. @code{id3v2_version} option controls which one is used. The legacy ID3v1 tag is
  373. not written by default, but may be enabled with the @code{write_id3v1} option.
  374. For seekable output the muxer also writes a Xing frame at the beginning, which
  375. contains the number of frames in the file. It is useful for computing duration
  376. of VBR files.
  377. The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
  378. are supplied to the muxer in form of a video stream with a single packet. There
  379. can be any number of those streams, each will correspond to a single APIC frame.
  380. The stream metadata tags @var{title} and @var{comment} map to APIC
  381. @var{description} and @var{picture type} respectively. See
  382. @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
  383. Note that the APIC frames must be written at the beginning, so the muxer will
  384. buffer the audio frames until it gets all the pictures. It is therefore advised
  385. to provide the pictures as soon as possible to avoid excessive buffering.
  386. Examples:
  387. Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
  388. @example
  389. ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
  390. @end example
  391. To attach a picture to an mp3 file select both the audio and the picture stream
  392. with @code{map}:
  393. @example
  394. ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
  395. -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
  396. @end example
  397. @section mpegts
  398. MPEG transport stream muxer.
  399. This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
  400. The muxer options are:
  401. @table @option
  402. @item -mpegts_original_network_id @var{number}
  403. Set the original_network_id (default 0x0001). This is unique identifier
  404. of a network in DVB. Its main use is in the unique identification of a
  405. service through the path Original_Network_ID, Transport_Stream_ID.
  406. @item -mpegts_transport_stream_id @var{number}
  407. Set the transport_stream_id (default 0x0001). This identifies a
  408. transponder in DVB.
  409. @item -mpegts_service_id @var{number}
  410. Set the service_id (default 0x0001) also known as program in DVB.
  411. @item -mpegts_pmt_start_pid @var{number}
  412. Set the first PID for PMT (default 0x1000, max 0x1f00).
  413. @item -mpegts_start_pid @var{number}
  414. Set the first PID for data packets (default 0x0100, max 0x0f00).
  415. @end table
  416. The recognized metadata settings in mpegts muxer are @code{service_provider}
  417. and @code{service_name}. If they are not set the default for
  418. @code{service_provider} is "FFmpeg" and the default for
  419. @code{service_name} is "Service01".
  420. @example
  421. ffmpeg -i file.mpg -c copy \
  422. -mpegts_original_network_id 0x1122 \
  423. -mpegts_transport_stream_id 0x3344 \
  424. -mpegts_service_id 0x5566 \
  425. -mpegts_pmt_start_pid 0x1500 \
  426. -mpegts_start_pid 0x150 \
  427. -metadata service_provider="Some provider" \
  428. -metadata service_name="Some Channel" \
  429. -y out.ts
  430. @end example
  431. @section null
  432. Null muxer.
  433. This muxer does not generate any output file, it is mainly useful for
  434. testing or benchmarking purposes.
  435. For example to benchmark decoding with @command{ffmpeg} you can use the
  436. command:
  437. @example
  438. ffmpeg -benchmark -i INPUT -f null out.null
  439. @end example
  440. Note that the above command does not read or write the @file{out.null}
  441. file, but specifying the output file is required by the @command{ffmpeg}
  442. syntax.
  443. Alternatively you can write the command as:
  444. @example
  445. ffmpeg -benchmark -i INPUT -f null -
  446. @end example
  447. @section ogg
  448. Ogg container muxer.
  449. @table @option
  450. @item -page_duration @var{duration}
  451. Preferred page duration, in microseconds. The muxer will attempt to create
  452. pages that are approximately @var{duration} microseconds long. This allows the
  453. user to compromise between seek granularity and container overhead. The default
  454. is 1 second. A value of 0 will fill all segments, making pages as large as
  455. possible. A value of 1 will effectively use 1 packet-per-page in most
  456. situations, giving a small seek granularity at the cost of additional container
  457. overhead.
  458. @end table
  459. @section segment, stream_segment, ssegment
  460. Basic stream segmenter.
  461. The segmenter muxer outputs streams to a number of separate files of nearly
  462. fixed duration. Output filename pattern can be set in a fashion similar to
  463. @ref{image2}.
  464. @code{stream_segment} is a variant of the muxer used to write to
  465. streaming output formats, i.e. which do not require global headers,
  466. and is recommended for outputting e.g. to MPEG transport stream segments.
  467. @code{ssegment} is a shorter alias for @code{stream_segment}.
  468. Every segment starts with a keyframe of the selected reference stream,
  469. which is set through the @option{reference_stream} option.
  470. Note that if you want accurate splitting for a video file, you need to
  471. make the input key frames correspond to the exact splitting times
  472. expected by the segmenter, or the segment muxer will start the new
  473. segment with the key frame found next after the specified start
  474. time.
  475. The segment muxer works best with a single constant frame rate video.
  476. Optionally it can generate a list of the created segments, by setting
  477. the option @var{segment_list}. The list type is specified by the
  478. @var{segment_list_type} option.
  479. The segment muxer supports the following options:
  480. @table @option
  481. @item reference_stream @var{specifier}
  482. Set the reference stream, as specified by the string @var{specifier}.
  483. If @var{specifier} is set to @code{auto}, the reference is choosen
  484. automatically. Otherwise it must be a stream specifier (see the ``Stream
  485. specifiers'' chapter in the ffmpeg manual) which specifies the
  486. reference stream. The default value is @code{auto}.
  487. @item segment_format @var{format}
  488. Override the inner container format, by default it is guessed by the filename
  489. extension.
  490. @item segment_list @var{name}
  491. Generate also a listfile named @var{name}. If not specified no
  492. listfile is generated.
  493. @item segment_list_flags @var{flags}
  494. Set flags affecting the segment list generation.
  495. It currently supports the following flags:
  496. @table @samp
  497. @item cache
  498. Allow caching (only affects M3U8 list files).
  499. @item live
  500. Allow live-friendly file generation.
  501. @end table
  502. Default value is @code{samp}.
  503. @item segment_list_size @var{size}
  504. Update the list file so that it contains at most the last @var{size}
  505. segments. If 0 the list file will contain all the segments. Default
  506. value is 0.
  507. @item segment_list_type @var{type}
  508. Specify the format for the segment list file.
  509. The following values are recognized:
  510. @table @samp
  511. @item flat
  512. Generate a flat list for the created segments, one segment per line.
  513. @item csv, ext
  514. Generate a list for the created segments, one segment per line,
  515. each line matching the format (comma-separated values):
  516. @example
  517. @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
  518. @end example
  519. @var{segment_filename} is the name of the output file generated by the
  520. muxer according to the provided pattern. CSV escaping (according to
  521. RFC4180) is applied if required.
  522. @var{segment_start_time} and @var{segment_end_time} specify
  523. the segment start and end time expressed in seconds.
  524. A list file with the suffix @code{".csv"} or @code{".ext"} will
  525. auto-select this format.
  526. @samp{ext} is deprecated in favor or @samp{csv}.
  527. @item ffconcat
  528. Generate an ffconcat file for the created segments. The resulting file
  529. can be read using the FFmpeg @ref{concat} demuxer.
  530. A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
  531. auto-select this format.
  532. @item m3u8
  533. Generate an extended M3U8 file, version 3, compliant with
  534. @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
  535. A list file with the suffix @code{".m3u8"} will auto-select this format.
  536. @end table
  537. If not specified the type is guessed from the list file name suffix.
  538. @item segment_time @var{time}
  539. Set segment duration to @var{time}, the value must be a duration
  540. specification. Default value is "2". See also the
  541. @option{segment_times} option.
  542. Note that splitting may not be accurate, unless you force the
  543. reference stream key-frames at the given time. See the introductory
  544. notice and the examples below.
  545. @item segment_time_delta @var{delta}
  546. Specify the accuracy time when selecting the start time for a
  547. segment, expressed as a duration specification. Default value is "0".
  548. When delta is specified a key-frame will start a new segment if its
  549. PTS satisfies the relation:
  550. @example
  551. PTS >= start_time - time_delta
  552. @end example
  553. This option is useful when splitting video content, which is always
  554. split at GOP boundaries, in case a key frame is found just before the
  555. specified split time.
  556. In particular may be used in combination with the @file{ffmpeg} option
  557. @var{force_key_frames}. The key frame times specified by
  558. @var{force_key_frames} may not be set accurately because of rounding
  559. issues, with the consequence that a key frame time may result set just
  560. before the specified time. For constant frame rate videos a value of
  561. 1/2*@var{frame_rate} should address the worst case mismatch between
  562. the specified time and the time set by @var{force_key_frames}.
  563. @item segment_times @var{times}
  564. Specify a list of split points. @var{times} contains a list of comma
  565. separated duration specifications, in increasing order. See also
  566. the @option{segment_time} option.
  567. @item segment_frames @var{frames}
  568. Specify a list of split video frame numbers. @var{frames} contains a
  569. list of comma separated integer numbers, in increasing order.
  570. This option specifies to start a new segment whenever a reference
  571. stream key frame is found and the sequential number (starting from 0)
  572. of the frame is greater or equal to the next value in the list.
  573. @item segment_wrap @var{limit}
  574. Wrap around segment index once it reaches @var{limit}.
  575. @item segment_start_number @var{number}
  576. Set the sequence number of the first segment. Defaults to @code{0}.
  577. @item reset_timestamps @var{1|0}
  578. Reset timestamps at the begin of each segment, so that each segment
  579. will start with near-zero timestamps. It is meant to ease the playback
  580. of the generated segments. May not work with some combinations of
  581. muxers/codecs. It is set to @code{0} by default.
  582. @end table
  583. @subsection Examples
  584. @itemize
  585. @item
  586. To remux the content of file @file{in.mkv} to a list of segments
  587. @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
  588. generated segments to @file{out.list}:
  589. @example
  590. ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
  591. @end example
  592. @item
  593. As the example above, but segment the input file according to the split
  594. points specified by the @var{segment_times} option:
  595. @example
  596. 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
  597. @end example
  598. @item
  599. As the example above, but use the @command{ffmpeg} @option{force_key_frames}
  600. option to force key frames in the input at the specified location, together
  601. with the segment option @option{segment_time_delta} to account for
  602. possible roundings operated when setting key frame times.
  603. @example
  604. ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
  605. -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
  606. @end example
  607. In order to force key frames on the input file, transcoding is
  608. required.
  609. @item
  610. Segment the input file by splitting the input file according to the
  611. frame numbers sequence specified with the @option{segment_frames} option:
  612. @example
  613. ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
  614. @end example
  615. @item
  616. To convert the @file{in.mkv} to TS segments using the @code{libx264}
  617. and @code{libfaac} encoders:
  618. @example
  619. ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
  620. @end example
  621. @item
  622. Segment the input file, and create an M3U8 live playlist (can be used
  623. as live HLS source):
  624. @example
  625. ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
  626. -segment_list_flags +live -segment_time 10 out%03d.mkv
  627. @end example
  628. @end itemize
  629. @section tee
  630. The tee muxer can be used to write the same data to several files or any
  631. other kind of muxer. It can be used, for example, to both stream a video to
  632. the network and save it to disk at the same time.
  633. It is different from specifying several outputs to the @command{ffmpeg}
  634. command-line tool because the audio and video data will be encoded only once
  635. with the tee muxer; encoding can be a very expensive process. It is not
  636. useful when using the libavformat API directly because it is then possible
  637. to feed the same packets to several muxers directly.
  638. The slave outputs are specified in the file name given to the muxer,
  639. separated by '|'. If any of the slave name contains the '|' separator,
  640. leading or trailing spaces or any special character, it must be
  641. escaped (see the ``Quoting and escaping'' section in the ffmpeg-utils
  642. manual).
  643. Options can be specified for each slave by prepending them as a list of
  644. @var{key}=@var{value} pairs separated by ':', between square brackets. If
  645. the options values contain a special character or the ':' separator, they
  646. must be escaped; note that this is a second level escaping.
  647. Example: encode something and both archive it in a WebM file and stream it
  648. as MPEG-TS over UDP (the streams need to be explicitly mapped):
  649. @example
  650. ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
  651. "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
  652. @end example
  653. Note: some codecs may need different options depending on the output format;
  654. the auto-detection of this can not work with the tee muxer. The main example
  655. is the @option{global_header} flag.
  656. @c man end MUXERS