[FFmpeg-devel] [PATCH] doc/muxers: add documentation for the md5 and framemd5 muxers

[Stefano Sabatini]

Address trac ticket #1153.
---
 doc/muxers.texi |   60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 60 insertions(+), 0 deletions(-)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index c257ab2..c6e0608 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -53,6 +53,33 @@ ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
 
 See also the @ref{framecrc} muxer.
 
+ at anchor{md5}
+ at section md5
+
+MD5 testing format.
+
+This muxer computes and prints the MD5 hash of all the input audio
+and video frames. By default audio frames are converted to signed
+16-bit raw audio and video frames to raw video before computing the
+hash.
+
+The output of the muxer consists of a single line of the form:
+MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
+the computed MD5 hash.
+
+For example to compute the MD5 hash of the input converted to raw
+audio and video, and store it in the file @file{out.crc}:
+ at example
+ffmpeg -i INPUT -f md5 out.md5
+ at end example
+
+You can print the CRC to stdout with the command:
+ at example
+ffmpeg -i INPUT -f md5 -
+ at end example
+
+See also the @ref{framemd5} muxer.
+
 @anchor{framecrc}
 @section framecrc
 
@@ -96,6 +123,39 @@ ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
 
 See also the @ref{crc} muxer.
 
+ at anchor{framemd5}
+ at section framemd5
+
+Per-packet MD5 testing format.
+
+This muxer computes and prints the MD5 hash for each audio
+and video packet. By default audio frames are converted to signed
+16-bit raw audio and video frames to raw video before computing the
+hash.
+
+The output of the muxer consists of a line for each audio and video
+packet of the form:
+ at example
+ at var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
+ at end example
+
+ at var{MD5} is a hexadecimal number representing the computed MD5 hash
+for the packet.
+
+For example to compute the MD5 of the audio and video frames in
+ at file{INPUT}, converted to raw audio and video packets, and store it
+in the file @file{out.md5}:
+ at example
+ffmpeg -i INPUT -f framemd5 out.md5
+ at end example
+
+To print the information to stdout, use the command:
+ at example
+ffmpeg -i INPUT -f framemd5 -
+ at end example
+
+See also the @ref{md5} muxer.
+
 @anchor{image2}
 @section image2
 
-- 
1.7.5.4