Browse code

doc/muxers: add documentation for the md5 and framemd5 muxers

Address trac ticket #1153.

Stefano Sabatini authored on 2012/04/07 18:05:58
Showing 1 changed files
... ...
@@ -96,6 +96,39 @@ ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
96 96
 
97 97
 See also the @ref{crc} muxer.
98 98
 
99
+@anchor{framemd5}
100
+@section framemd5
101
+
102
+Per-packet MD5 testing format.
103
+
104
+This muxer computes and prints the MD5 hash for each audio
105
+and video packet. By default audio frames are converted to signed
106
+16-bit raw audio and video frames to raw video before computing the
107
+hash.
108
+
109
+The output of the muxer consists of a line for each audio and video
110
+packet of the form:
111
+@example
112
+@var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
113
+@end example
114
+
115
+@var{MD5} is a hexadecimal number representing the computed MD5 hash
116
+for the packet.
117
+
118
+For example to compute the MD5 of the audio and video frames in
119
+@file{INPUT}, converted to raw audio and video packets, and store it
120
+in the file @file{out.md5}:
121
+@example
122
+ffmpeg -i INPUT -f framemd5 out.md5
123
+@end example
124
+
125
+To print the information to stdout, use the command:
126
+@example
127
+ffmpeg -i INPUT -f framemd5 -
128
+@end example
129
+
130
+See also the @ref{md5} muxer.
131
+
99 132
 @anchor{image2}
100 133
 @section image2
101 134
 
... ...
@@ -154,6 +187,33 @@ each of the YUV420P components. To read or write this image file format,
154 154
 specify the name of the '.Y' file. The muxer will automatically open the
155 155
 '.U' and '.V' files as required.
156 156
 
157
+@anchor{md5}
158
+@section md5
159
+
160
+MD5 testing format.
161
+
162
+This muxer computes and prints the MD5 hash of all the input audio
163
+and video frames. By default audio frames are converted to signed
164
+16-bit raw audio and video frames to raw video before computing the
165
+hash.
166
+
167
+The output of the muxer consists of a single line of the form:
168
+MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
169
+the computed MD5 hash.
170
+
171
+For example to compute the MD5 hash of the input converted to raw
172
+audio and video, and store it in the file @file{out.md5}:
173
+@example
174
+ffmpeg -i INPUT -f md5 out.md5
175
+@end example
176
+
177
+You can print the MD5 to stdout with the command:
178
+@example
179
+ffmpeg -i INPUT -f md5 -
180
+@end example
181
+
182
+See also the @ref{framemd5} muxer.
183
+
157 184
 @section MOV/MP4/ISMV
158 185
 
159 186
 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4