Add documentation for the framecrc muxer.
[ffmpeg.git] / 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 @file{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 -acodec pcm_u8 -vcodec mpeg2video -f crc -
52 @end example
53
54 See also the @code{framecrc} muxer (@pxref{framecrc}).
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 @file{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 -acodec pcm_u8 -vcodec mpeg2video -f framecrc -
89 @end example
90
91 See also the @code{crc} muxer (@pxref{crc}).
92
93 @section image2
94
95 Image file muxer.
96
97 This muxer writes video frames to multiple image files specified by a
98 pattern.
99
100 The pattern may contain the string "%d" or "%0@var{N}d", which
101 specifies the position of the characters representing a numbering in
102 the filenames. If the form "%d0@var{N}d" is used, the string
103 representing the number in each filename is 0-padded to @var{N}
104 digits. The literal character '%' can be specified in the pattern with
105 the string "%%".
106
107 If the pattern contains "%d" or "%0@var{N}d", the first filename of
108 the file list specified will contain the number 1, all the following
109 numbers will be sequential.
110
111 The pattern may contain a suffix which is used to automatically
112 determine the format of the image files to write.
113
114 For example the pattern "img-%03d.bmp" will specify a sequence of
115 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
116 @file{img-010.bmp}, etc.
117 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
118 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
119 etc.
120
121 The following example shows how to use @file{ffmpeg} for creating a
122 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
123 taking one image every second from the input video:
124 @example
125 ffmpeg -i in.avi -r 1 -f image2 'img-%03d.jpeg'
126 @end example
127
128 Note that with @file{ffmpeg}, if the format is not specified with the
129 @code{-f} option and the output filename specifies an image file
130 format, the image2 muxer is automatically selected, so the previous
131 command can be written as:
132 @example
133 ffmpeg -i in.avi -r 1 'img-%03d.jpeg'
134 @end example
135
136 Note also that the pattern must not necessarily contain "%d" or
137 "%0@var{N}d", for example to create a single image file
138 @file{img.jpeg} from the input video you can employ the command:
139 @example
140 ffmpeg -i in.avi -f image2 -vframes 1 img.jpeg
141 @end example
142
143 @section mpegts
144
145 MPEG transport stream muxer.
146
147 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
148
149 The muxer options are:
150
151 @table @option
152 @item -mpegts_original_network_id @var{number}
153 Set the original_network_id (default 0x0001). This is unique identifier
154 of a network in DVB. Its main use is in the unique identification of a
155 service through the path Original_Network_ID, Transport_Stream_ID.
156 @item -mpegts_transport_stream_id @var{number}
157 Set the transport_stream_id (default 0x0001). This identifies a
158 transponder in DVB.
159 @item -mpegts_service_id @var{number}
160 Set the service_id (default 0x0001) also known as program in DVB.
161 @item -mpegts_pmt_start_pid @var{number}
162 Set the first PID for PMT (default 0x1000, max 0x1f00).
163 @item -mpegts_start_pid @var{number}
164 Set the first PID for data packets (default 0x0100, max 0x0f00).
165 @end table
166
167 The recognized metadata settings in mpegts muxer are @code{service_provider}
168 and @code{service_name}. If they are not set the default for
169 @code{service_provider} is "FFmpeg" and the default for
170 @code{service_name} is "Service01".
171
172 @example
173 ffmpeg -i file.mpg -acodec copy -vcodec copy \
174      -mpegts_original_network_id 0x1122 \
175      -mpegts_transport_stream_id 0x3344 \
176      -mpegts_service_id 0x5566 \
177      -mpegts_pmt_start_pid 0x1500 \
178      -mpegts_start_pid 0x150 \
179      -metadata service_provider="Some provider" \
180      -metadata service_name="Some Channel" \
181      -y out.ts
182 @end example
183
184 @section null
185
186 Null muxer.
187
188 This muxer does not generate any output file, it is mainly useful for
189 testing or benchmarking purposes.
190
191 For example to benchmark decoding with @file{ffmpeg} you can use the
192 command:
193 @example
194 ffmpeg -benchmark -i INPUT -f null out.null
195 @end example
196
197 Note that the above command does not read or write the @file{out.null}
198 file, but specifying the output file is required by the @file{ffmpeg}
199 syntax.
200
201 Alternatively you can write the command as:
202 @example
203 ffmpeg -benchmark -i INPUT -f null -
204 @end example
205
206 @c man end MUXERS