[FFmpeg-devel] [PATCH] Add documentation for the framecrc muxer.

[Måns Rullgård]

Stefano Sabatini <stefano.sabatini-lala at poste.it> writes:

> ---
>  doc/muxers.texi |   40 ++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 40 insertions(+), 0 deletions(-)
>
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index f097753..56ac13f 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -18,6 +18,7 @@ enabled muxers.
>
>  A description of some of the currently available muxers follows.
>
> + at anchor{crc}
>  @section crc

Should that have been in the previous patch?

>  CRC (Cyclic Redundancy Check) testing format.
> @@ -51,6 +52,45 @@ and the input video converted to MPEG-2 video, use the command:
>  ffmpeg -i INPUT -acodec pcm_u8 -vcodec mpeg2video -f crc -
>  @end example
>
> +See also the @code{framecrc} muxer (@pxref{framecrc}).
> +
> + at anchor{framecrc}
> + at section framecrc
> +
> +Per-frame CRC (Cyclic Redundancy Check) testing format.
> +
> +This muxer computes and prints a CRC for each decoded audio and video
> +frame. By default the CRC is computed on the input audio and video
> +frames converted respectively to rawvideo and signed 16-bit rawaudio.
> +
> +The output of the muxer consists of a line for each audio and video
> +frame of the form: @var{stream_index}, @var{frame_dts},
> + at var{frame_size}, 0x at var{CRC}, where @var{CRC} is an hexadecimal
> +number 0-padded to 8 digits containing the CRC of the decoded frame.
> +
> +For example to compute the CRC of each decoded frame in the input, and
> +store it in the file @file{out.crc}:
> + at example
> +ffmpeg -i INPUT -f framecrc out.crc
> + at end example
> +
> +You can print the CRC of each decoded frame to stdout with the command
> +(using the @file{sh} shell syntax):
> + at example
> +ffmpeg -i INPUT -f framecrc - 2&> /dev/null
> + at end example
> +
> +You can select the output format of each frame with @file{ffmpeg} by
> +specifying the audio and video codec and format. For example to
> +compute the CRC of each decoded input audio frame converted to PCM
> +unsigned 8-bit and of each decoded input video frame converted to
> +MPEG-2 video, use the command:
> + at example
> +ffmpeg -i INPUT -acodec pcm_u8 -vcodec mpeg2video -f framecrc -
> + at end example
> +
> +See also the @code{crc} muxer (@pxref{crc}).
> +
>  @section image2
>
>  Image file muxer.
> -- 
> 1.7.2.3

Same comments as previous patch.

-- 
M?ns Rullg?rd
mans at mansr.com