Browse code

Add documentation for the framecrc muxer.

Signed-off-by: Janne Grunau <janne-ffmpeg@jannau.net>

Stefano Sabatini authored on 2011/02/01 09:03:48
Showing 1 changed files
... ...
@@ -18,6 +18,7 @@ enabled muxers.
18 18
 
19 19
 A description of some of the currently available muxers follows.
20 20
 
21
+@anchor{crc}
21 22
 @section crc
22 23
 
23 24
 CRC (Cyclic Redundancy Check) testing format.
... ...
@@ -50,6 +51,45 @@ and the input video converted to MPEG-2 video, use the command:
50 50
 ffmpeg -i INPUT -acodec pcm_u8 -vcodec mpeg2video -f crc -
51 51
 @end example
52 52
 
53
+See also the @code{framecrc} muxer (@pxref{framecrc}).
54
+
55
+@anchor{framecrc}
56
+@section framecrc
57
+
58
+Per-frame CRC (Cyclic Redundancy Check) testing format.
59
+
60
+This muxer computes and prints the Adler-32 CRC for each decoded audio
61
+and video frame. By default audio frames are converted to signed
62
+16-bit raw audio and video frames to raw video before computing the
63
+CRC.
64
+
65
+The output of the muxer consists of a line for each audio and video
66
+frame of the form: @var{stream_index}, @var{frame_dts},
67
+@var{frame_size}, 0x@var{CRC}, where @var{CRC} is a hexadecimal
68
+number 0-padded to 8 digits containing the CRC of the decoded frame.
69
+
70
+For example to compute the CRC of each decoded frame in the input, and
71
+store it in the file @file{out.crc}:
72
+@example
73
+ffmpeg -i INPUT -f framecrc out.crc
74
+@end example
75
+
76
+You can print the CRC of each decoded frame to stdout with the command:
77
+@example
78
+ffmpeg -i INPUT -f framecrc -
79
+@end example
80
+
81
+You can select the output format of each frame with @file{ffmpeg} by
82
+specifying the audio and video codec and format. For example, to
83
+compute the CRC of each decoded input audio frame converted to PCM
84
+unsigned 8-bit and of each decoded input video frame converted to
85
+MPEG-2 video, use the command:
86
+@example
87
+ffmpeg -i INPUT -acodec pcm_u8 -vcodec mpeg2video -f framecrc -
88
+@end example
89
+
90
+See also the @code{crc} muxer (@pxref{crc}).
91
+
53 92
 @section image2
54 93
 
55 94
 Image file muxer.