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

[Stefano Sabatini]

On date Saturday 2012-04-07 11:35:36 +0200, Clément Bœsch encoded:
> On Sat, Apr 07, 2012 at 11:13:08AM +0200, Stefano Sabatini wrote:
> > 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}:
> 
> out.md5
> 
> > + at example
> > +ffmpeg -i INPUT -f md5 out.md5
> > + at end example
> > +
> > +You can print the CRC to stdout with the command:
> 
> MD5
> 
> [...]
> 
> The rest LGTM.

Fixed&pushed.
-- 
FFmpeg = Fast Furious Multipurpose Philosofic Erratic Guide