doc/muxers.texi

   1 @chapter Muxers
   2 @c man begin MUXERS
   3
   4 Muxers are configured elements in Libav which allow writing
   5 multimedia streams to a particular type of file.
   6
   7 When you configure your Libav build, all the supported muxers
   8 are enabled by default. You can list all available muxers using the
   9 configure option @code{--list-muxers}.
  10
  11 You can disable all the muxers with the configure option
  12 @code{--disable-muxers} and selectively enable / disable single muxers
  13 with the options @code{--enable-muxer=@var{MUXER}} /
  14 @code{--disable-muxer=@var{MUXER}}.
  15
  16 The option @code{-formats} of the ff* tools will display the list of
  17 enabled muxers.
  18
  19 A description of some of the currently available muxers follows.
  20
  21 @anchor{crc}
  22 @section crc
  23
  24 CRC (Cyclic Redundancy Check) testing format.
  25
  26 This muxer computes and prints the Adler-32 CRC of all the input audio
  27 and video frames. By default audio frames are converted to signed
  28 16-bit raw audio and video frames to raw video before computing the
  29 CRC.
  30
  31 The output of the muxer consists of a single line of the form:
  32 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
  33 8 digits containing the CRC for all the decoded input frames.
  34
  35 For example to compute the CRC of the input, and store it in the file
  36 @file{out.crc}:
  37 @example
  38 avconv -i INPUT -f crc out.crc
  39 @end example
  40
  41 You can print the CRC to stdout with the command:
  42 @example
  43 avconv -i INPUT -f crc -
  44 @end example
  45
  46 You can select the output format of each frame with @command{avconv} by
  47 specifying the audio and video codec and format. For example to
  48 compute the CRC of the input audio converted to PCM unsigned 8-bit
  49 and the input video converted to MPEG-2 video, use the command:
  50 @example
  51 avconv -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
  52 @end example
  53
  54 See also the @ref{framecrc} muxer.
  55
  56 @anchor{framecrc}
  57 @section framecrc
  58
  59 Per-frame CRC (Cyclic Redundancy Check) testing format.
  60
  61 This muxer computes and prints the Adler-32 CRC for each decoded audio
  62 and video frame. By default audio frames are converted to signed
  63 16-bit raw audio and video frames to raw video before computing the
  64 CRC.
  65
  66 The output of the muxer consists of a line for each audio and video
  67 frame of the form: @var{stream_index}, @var{frame_dts},
  68 @var{frame_size}, 0x@var{CRC}, where @var{CRC} is a hexadecimal
  69 number 0-padded to 8 digits containing the CRC of the decoded frame.
  70
  71 For example to compute the CRC of each decoded frame in the input, and
  72 store it in the file @file{out.crc}:
  73 @example
  74 avconv -i INPUT -f framecrc out.crc
  75 @end example
  76
  77 You can print the CRC of each decoded frame to stdout with the command:
  78 @example
  79 avconv -i INPUT -f framecrc -
  80 @end example
  81
  82 You can select the output format of each frame with @command{avconv} by
  83 specifying the audio and video codec and format. For example, to
  84 compute the CRC of each decoded input audio frame converted to PCM
  85 unsigned 8-bit and of each decoded input video frame converted to
  86 MPEG-2 video, use the command:
  87 @example
  88 avconv -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
  89 @end example
  90
  91 See also the @ref{crc} muxer.
  92
  93 @anchor{hls}
  94 @section hls
  95
  96 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
  97 the HTTP Live Streaming specification.
  98
  99 It creates a playlist file and numbered segment files. The output
 100 filename specifies the playlist filename; the segment filenames
 101 receive the same basename as the playlist, a sequential number and
 102 a .ts extension.
 103
 104 @example
 105 avconv -i in.nut out.m3u8
 106 @end example
 107
 108 @table @option
 109 @item -hls_time @var{seconds}
 110 Set the segment length in seconds.
 111 @item -hls_list_size @var{size}
 112 Set the maximum number of playlist entries.
 113 @item -hls_wrap @var{wrap}
 114 Set the number after which index wraps.
 115 @item -start_number @var{number}
 116 Start the sequence from @var{number}.
 117 @end table
 118
 119 @anchor{image2}
 120 @section image2
 121
 122 Image file muxer.
 123
 124 The image file muxer writes video frames to image files.
 125
 126 The output filenames are specified by a pattern, which can be used to
 127 produce sequentially numbered series of files.
 128 The pattern may contain the string "%d" or "%0@var{N}d", this string
 129 specifies the position of the characters representing a numbering in
 130 the filenames. If the form "%0@var{N}d" is used, the string
 131 representing the number in each filename is 0-padded to @var{N}
 132 digits. The literal character '%' can be specified in the pattern with
 133 the string "%%".
 134
 135 If the pattern contains "%d" or "%0@var{N}d", the first filename of
 136 the file list specified will contain the number 1, all the following
 137 numbers will be sequential.
 138
 139 The pattern may contain a suffix which is used to automatically
 140 determine the format of the image files to write.
 141
 142 For example the pattern "img-%03d.bmp" will specify a sequence of
 143 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
 144 @file{img-010.bmp}, etc.
 145 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
 146 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
 147 etc.
 148
 149 The following example shows how to use @command{avconv} for creating a
 150 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
 151 taking one image every second from the input video:
 152 @example
 153 avconv -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
 154 @end example
 155
 156 Note that with @command{avconv}, if the format is not specified with the
 157 @code{-f} option and the output filename specifies an image file
 158 format, the image2 muxer is automatically selected, so the previous
 159 command can be written as:
 160 @example
 161 avconv -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
 162 @end example
 163
 164 Note also that the pattern must not necessarily contain "%d" or
 165 "%0@var{N}d", for example to create a single image file
 166 @file{img.jpeg} from the input video you can employ the command:
 167 @example
 168 avconv -i in.avi -f image2 -frames:v 1 img.jpeg
 169 @end example
 170
 171 @section MOV/MP4/ISMV
 172
 173 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
 174 file has all the metadata about all packets stored in one location
 175 (written at the end of the file, it can be moved to the start for
 176 better playback using the @command{qt-faststart} tool). A fragmented
 177 file consists of a number of fragments, where packets and metadata
 178 about these packets are stored together. Writing a fragmented
 179 file has the advantage that the file is decodable even if the
 180 writing is interrupted (while a normal MOV/MP4 is undecodable if
 181 it is not properly finished), and it requires less memory when writing
 182 very long files (since writing normal MOV/MP4 files stores info about
 183 every single packet in memory until the file is closed). The downside
 184 is that it is less compatible with other applications.
 185
 186 Fragmentation is enabled by setting one of the AVOptions that define
 187 how to cut the file into fragments:
 188
 189 @table @option
 190 @item -movflags frag_keyframe
 191 Start a new fragment at each video keyframe.
 192 @item -frag_duration @var{duration}
 193 Create fragments that are @var{duration} microseconds long.
 194 @item -frag_size @var{size}
 195 Create fragments that contain up to @var{size} bytes of payload data.
 196 @item -movflags frag_custom
 197 Allow the caller to manually choose when to cut fragments, by
 198 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
 199 the packets written so far. (This is only useful with other
 200 applications integrating libavformat, not from @command{avconv}.)
 201 @item -min_frag_duration @var{duration}
 202 Don't create fragments that are shorter than @var{duration} microseconds long.
 203 @end table
 204
 205 If more than one condition is specified, fragments are cut when
 206 one of the specified conditions is fulfilled. The exception to this is
 207 @code{-min_frag_duration}, which has to be fulfilled for any of the other
 208 conditions to apply.
 209
 210 Additionally, the way the output file is written can be adjusted
 211 through a few other options:
 212
 213 @table @option
 214 @item -movflags empty_moov
 215 Write an initial moov atom directly at the start of the file, without
 216 describing any samples in it. Generally, an mdat/moov pair is written
 217 at the start of the file, as a normal MOV/MP4 file, containing only
 218 a short portion of the file. With this option set, there is no initial
 219 mdat atom, and the moov atom only describes the tracks but has
 220 a zero duration.
 221
 222 Files written with this option set do not work in QuickTime.
 223 This option is implicitly set when writing ismv (Smooth Streaming) files.
 224 @item -movflags separate_moof
 225 Write a separate moof (movie fragment) atom for each track. Normally,
 226 packets for all tracks are written in a moof atom (which is slightly
 227 more efficient), but with this option set, the muxer writes one moof/mdat
 228 pair for each track, making it easier to separate tracks.
 229
 230 This option is implicitly set when writing ismv (Smooth Streaming) files.
 231 @end table
 232
 233 Smooth Streaming content can be pushed in real time to a publishing
 234 point on IIS with this muxer. Example:
 235 @example
 236 avconv -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
 237 @end example
 238
 239 @section mpegts
 240
 241 MPEG transport stream muxer.
 242
 243 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
 244
 245 The muxer options are:
 246
 247 @table @option
 248 @item -mpegts_original_network_id @var{number}
 249 Set the original_network_id (default 0x0001). This is unique identifier
 250 of a network in DVB. Its main use is in the unique identification of a
 251 service through the path Original_Network_ID, Transport_Stream_ID.
 252 @item -mpegts_transport_stream_id @var{number}
 253 Set the transport_stream_id (default 0x0001). This identifies a
 254 transponder in DVB.
 255 @item -mpegts_service_id @var{number}
 256 Set the service_id (default 0x0001) also known as program in DVB.
 257 @item -mpegts_pmt_start_pid @var{number}
 258 Set the first PID for PMT (default 0x1000, max 0x1f00).
 259 @item -mpegts_start_pid @var{number}
 260 Set the first PID for data packets (default 0x0100, max 0x0f00).
 261 @end table
 262
 263 The recognized metadata settings in mpegts muxer are @code{service_provider}
 264 and @code{service_name}. If they are not set the default for
 265 @code{service_provider} is "Libav" and the default for
 266 @code{service_name} is "Service01".
 267
 268 @example
 269 avconv -i file.mpg -c copy \
 270      -mpegts_original_network_id 0x1122 \
 271      -mpegts_transport_stream_id 0x3344 \
 272      -mpegts_service_id 0x5566 \
 273      -mpegts_pmt_start_pid 0x1500 \
 274      -mpegts_start_pid 0x150 \
 275      -metadata service_provider="Some provider" \
 276      -metadata service_name="Some Channel" \
 277      -y out.ts
 278 @end example
 279
 280 @section null
 281
 282 Null muxer.
 283
 284 This muxer does not generate any output file, it is mainly useful for
 285 testing or benchmarking purposes.
 286
 287 For example to benchmark decoding with @command{avconv} you can use the
 288 command:
 289 @example
 290 avconv -benchmark -i INPUT -f null out.null
 291 @end example
 292
 293 Note that the above command does not read or write the @file{out.null}
 294 file, but specifying the output file is required by the @command{avconv}
 295 syntax.
 296
 297 Alternatively you can write the command as:
 298 @example
 299 avconv -benchmark -i INPUT -f null -
 300 @end example
 301
 302 @section matroska
 303
 304 Matroska container muxer.
 305
 306 This muxer implements the matroska and webm container specs.
 307
 308 The recognized metadata settings in this muxer are:
 309
 310 @table @option
 311
 312 @item title=@var{title name}
 313 Name provided to a single track
 314 @end table
 315
 316 @table @option
 317
 318 @item language=@var{language name}
 319 Specifies the language of the track in the Matroska languages form
 320 @end table
 321
 322 @table @option
 323
 324 @item STEREO_MODE=@var{mode}
 325 Stereo 3D video layout of two views in a single video track
 326 @table @option
 327 @item mono
 328 video is not stereo
 329 @item left_right
 330 Both views are arranged side by side, Left-eye view is on the left
 331 @item bottom_top
 332 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
 333 @item top_bottom
 334 Both views are arranged in top-bottom orientation, Left-eye view is on top
 335 @item checkerboard_rl
 336 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
 337 @item checkerboard_lr
 338 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
 339 @item row_interleaved_rl
 340 Each view is constituted by a row based interleaving, Right-eye view is first row
 341 @item row_interleaved_lr
 342 Each view is constituted by a row based interleaving, Left-eye view is first row
 343 @item col_interleaved_rl
 344 Both views are arranged in a column based interleaving manner, Right-eye view is first column
 345 @item col_interleaved_lr
 346 Both views are arranged in a column based interleaving manner, Left-eye view is first column
 347 @item anaglyph_cyan_red
 348 All frames are in anaglyph format viewable through red-cyan filters
 349 @item right_left
 350 Both views are arranged side by side, Right-eye view is on the left
 351 @item anaglyph_green_magenta
 352 All frames are in anaglyph format viewable through green-magenta filters
 353 @item block_lr
 354 Both eyes laced in one Block, Left-eye view is first
 355 @item block_rl
 356 Both eyes laced in one Block, Right-eye view is first
 357 @end table
 358 @end table
 359
 360 For example a 3D WebM clip can be created using the following command line:
 361 @example
 362 avconv -i sample_left_right_clip.mpg -an -c:v libvpx -metadata STEREO_MODE=left_right -y stereo_clip.webm
 363 @end example
 364
 365 @section segment
 366
 367 Basic stream segmenter.
 368
 369 The segmenter muxer outputs streams to a number of separate files of nearly
 370 fixed duration. Output filename pattern can be set in a fashion similar to
 371 @ref{image2}.
 372
 373 Every segment starts with a video keyframe, if a video stream is present.
 374 The segment muxer works best with a single constant frame rate video.
 375
 376 Optionally it can generate a flat list of the created segments, one segment
 377 per line.
 378
 379 @table @option
 380 @item segment_format @var{format}
 381 Override the inner container format, by default it is guessed by the filename
 382 extension.
 383 @item segment_time @var{t}
 384 Set segment duration to @var{t} seconds.
 385 @item segment_list @var{name}
 386 Generate also a listfile named @var{name}.
 387 @item segment_list_size @var{size}
 388 Overwrite the listfile once it reaches @var{size} entries.
 389 @item segment_wrap @var{limit}
 390 Wrap around segment index once it reaches @var{limit}.
 391 @end table
 392
 393 @example
 394 avconv -i in.mkv -c copy -map 0 -f segment -list out.list out%03d.nut
 395 @end example
 396
 397 @section mp3
 398
 399 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
 400 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
 401 @code{id3v2_version} option controls which one is used. The legacy ID3v1 tag is
 402 not written by default, but may be enabled with the @code{write_id3v1} option.
 403
 404 For seekable output the muxer also writes a Xing frame at the beginning, which
 405 contains the number of frames in the file. It is useful for computing duration
 406 of VBR files.
 407
 408 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
 409 are supplied to the muxer in form of a video stream with a single packet. There
 410 can be any number of those streams, each will correspond to a single APIC frame.
 411 The stream metadata tags @var{title} and @var{comment} map to APIC
 412 @var{description} and @var{picture type} respectively. See
 413 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
 414
 415 Note that the APIC frames must be written at the beginning, so the muxer will
 416 buffer the audio frames until it gets all the pictures. It is therefore advised
 417 to provide the pictures as soon as possible to avoid excessive buffering.
 418
 419 Examples:
 420
 421 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
 422 @example
 423 avconv -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
 424 @end example
 425
 426 Attach a picture to an mp3:
 427 @example
 428 avconv -i input.mp3 -i cover.png -c copy -metadata:s:v title="Album cover"
 429 -metadata:s:v comment="Cover (Front)" out.mp3
 430 @end example
 431
 432 @c man end MUXERS