git.sesse.net Git - ffmpeg/blob - doc/muxers.texi

   1 @chapter Muxers
   2 @c man begin MUXERS
   3
   4 Muxers are configured elements in FFmpeg which allow writing
   5 multimedia streams to a particular type of file.
   6
   7 When you configure your FFmpeg 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 ffmpeg -i INPUT -f crc out.crc
  39 @end example
  40
  41 You can print the CRC to stdout with the command:
  42 @example
  43 ffmpeg -i INPUT -f crc -
  44 @end example
  45
  46 You can select the output format of each frame with @command{ffmpeg} 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 ffmpeg -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 ffmpeg -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 ffmpeg -i INPUT -f framecrc -
  80 @end example
  81
  82 You can select the output format of each frame with @command{ffmpeg} 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 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
  89 @end example
  90
  91 See also the @ref{crc} muxer.
  92
  93 @section image2
  94
  95 Image file muxer.
  96
  97 The image file muxer writes video frames to image files.
  98
  99 The output filenames are specified by a pattern, which can be used to
 100 produce sequentially numbered series of files.
 101 The pattern may contain the string "%d" or "%0@var{N}d", this string
 102 specifies the position of the characters representing a numbering in
 103 the filenames. If the form "%0@var{N}d" is used, the string
 104 representing the number in each filename is 0-padded to @var{N}
 105 digits. The literal character '%' can be specified in the pattern with
 106 the string "%%".
 107
 108 If the pattern contains "%d" or "%0@var{N}d", the first filename of
 109 the file list specified will contain the number 1, all the following
 110 numbers will be sequential.
 111
 112 The pattern may contain a suffix which is used to automatically
 113 determine the format of the image files to write.
 114
 115 For example the pattern "img-%03d.bmp" will specify a sequence of
 116 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
 117 @file{img-010.bmp}, etc.
 118 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
 119 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
 120 etc.
 121
 122 The following example shows how to use @command{ffmpeg} for creating a
 123 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
 124 taking one image every second from the input video:
 125 @example
 126 ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
 127 @end example
 128
 129 Note that with @command{ffmpeg}, if the format is not specified with the
 130 @code{-f} option and the output filename specifies an image file
 131 format, the image2 muxer is automatically selected, so the previous
 132 command can be written as:
 133 @example
 134 ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
 135 @end example
 136
 137 Note also that the pattern must not necessarily contain "%d" or
 138 "%0@var{N}d", for example to create a single image file
 139 @file{img.jpeg} from the input video you can employ the command:
 140 @example
 141 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
 142 @end example
 143
 144 The image muxer supports the .Y.U.V image file format. This format is
 145 special in that that each image frame consists of three files, for
 146 each of the YUV420P components. To read or write this image file format,
 147 specify the name of the '.Y' file. The muxer will automatically open the
 148 '.U' and '.V' files as required.
 149
 150 @section mov
 151
 152 MOV / MP4 muxer
 153
 154 The muxer options are:
 155
 156 @table @option
 157 @item -moov_size @var{bytes}
 158 Reserves space for the moov atom at the beginning of the file instead of placing the
 159 moov atom at the end. If the space reserved is insufficient, muxing will fail.
 160 @end table
 161
 162 @section mpegts
 163
 164 MPEG transport stream muxer.
 165
 166 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
 167
 168 The muxer options are:
 169
 170 @table @option
 171 @item -mpegts_original_network_id @var{number}
 172 Set the original_network_id (default 0x0001). This is unique identifier
 173 of a network in DVB. Its main use is in the unique identification of a
 174 service through the path Original_Network_ID, Transport_Stream_ID.
 175 @item -mpegts_transport_stream_id @var{number}
 176 Set the transport_stream_id (default 0x0001). This identifies a
 177 transponder in DVB.
 178 @item -mpegts_service_id @var{number}
 179 Set the service_id (default 0x0001) also known as program in DVB.
 180 @item -mpegts_pmt_start_pid @var{number}
 181 Set the first PID for PMT (default 0x1000, max 0x1f00).
 182 @item -mpegts_start_pid @var{number}
 183 Set the first PID for data packets (default 0x0100, max 0x0f00).
 184 @end table
 185
 186 The recognized metadata settings in mpegts muxer are @code{service_provider}
 187 and @code{service_name}. If they are not set the default for
 188 @code{service_provider} is "FFmpeg" and the default for
 189 @code{service_name} is "Service01".
 190
 191 @example
 192 ffmpeg -i file.mpg -c copy \
 193      -mpegts_original_network_id 0x1122 \
 194      -mpegts_transport_stream_id 0x3344 \
 195      -mpegts_service_id 0x5566 \
 196      -mpegts_pmt_start_pid 0x1500 \
 197      -mpegts_start_pid 0x150 \
 198      -metadata service_provider="Some provider" \
 199      -metadata service_name="Some Channel" \
 200      -y out.ts
 201 @end example
 202
 203 @section null
 204
 205 Null muxer.
 206
 207 This muxer does not generate any output file, it is mainly useful for
 208 testing or benchmarking purposes.
 209
 210 For example to benchmark decoding with @command{ffmpeg} you can use the
 211 command:
 212 @example
 213 ffmpeg -benchmark -i INPUT -f null out.null
 214 @end example
 215
 216 Note that the above command does not read or write the @file{out.null}
 217 file, but specifying the output file is required by the @command{ffmpeg}
 218 syntax.
 219
 220 Alternatively you can write the command as:
 221 @example
 222 ffmpeg -benchmark -i INPUT -f null -
 223 @end example
 224
 225 @section matroska
 226
 227 Matroska container muxer.
 228
 229 This muxer implements the matroska and webm container specs.
 230
 231 The recognized metadata settings in this muxer are:
 232
 233 @table @option
 234
 235 @item title=@var{title name}
 236 Name provided to a single track
 237 @end table
 238
 239 @table @option
 240
 241 @item language=@var{language name}
 242 Specifies the language of the track in the Matroska languages form
 243 @end table
 244
 245 @table @option
 246
 247 @item stereo_mode=@var{mode}
 248 Stereo 3D video layout of two views in a single video track
 249 @table @option
 250 @item mono
 251 video is not stereo
 252 @item left_right
 253 Both views are arranged side by side, Left-eye view is on the left
 254 @item bottom_top
 255 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
 256 @item top_bottom
 257 Both views are arranged in top-bottom orientation, Left-eye view is on top
 258 @item checkerboard_rl
 259 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
 260 @item checkerboard_lr
 261 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
 262 @item row_interleaved_rl
 263 Each view is constituted by a row based interleaving, Right-eye view is first row
 264 @item row_interleaved_lr
 265 Each view is constituted by a row based interleaving, Left-eye view is first row
 266 @item col_interleaved_rl
 267 Both views are arranged in a column based interleaving manner, Right-eye view is first column
 268 @item col_interleaved_lr
 269 Both views are arranged in a column based interleaving manner, Left-eye view is first column
 270 @item anaglyph_cyan_red
 271 All frames are in anaglyph format viewable through red-cyan filters
 272 @item right_left
 273 Both views are arranged side by side, Right-eye view is on the left
 274 @item anaglyph_green_magenta
 275 All frames are in anaglyph format viewable through green-magenta filters
 276 @item block_lr
 277 Both eyes laced in one Block, Left-eye view is first
 278 @item block_rl
 279 Both eyes laced in one Block, Right-eye view is first
 280 @end table
 281 @end table
 282
 283 For example a 3D WebM clip can be created using the following command line:
 284 @example
 285 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
 286 @end example
 287
 288 @c man end MUXERS