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