Browse code

doc/muxers: clarify documentation for the framecrc muxer

Makes more explicit that framecrc works at the packet level, also prefers
the term "packet" over "frame" when it makes sense.

Stefano Sabatini authored on 2012/04/07 17:44:07
Showing 1 changed files
... ...
@@ -56,31 +56,37 @@ See also the @ref{framecrc} muxer.
56 56
 @anchor{framecrc}
57 57
 @section framecrc
58 58
 
59
-Per-frame CRC (Cyclic Redundancy Check) testing format.
59
+Per-packet CRC (Cyclic Redundancy Check) testing format.
60 60
 
61
-This muxer computes and prints the Adler-32 CRC for each decoded audio
62
-and video frame. By default audio frames are converted to signed
61
+This muxer computes and prints the Adler-32 CRC for each audio
62
+and video packet. By default audio frames are converted to signed
63 63
 16-bit raw audio and video frames to raw video before computing the
64 64
 CRC.
65 65
 
66 66
 The output of the muxer consists of a line for each audio and video
67
-frame of the form: @var{stream_index}, @var{frame_dts}, @var{frame_pts}, @var{frame_duration},
68
-@var{frame_size}, 0x@var{CRC}, where @var{CRC} is a hexadecimal
69
-number 0-padded to 8 digits containing the CRC of the decoded frame.
67
+packet of the form:
68
+@example
69
+@var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
70
+@end example
70 71
 
71
-For example to compute the CRC of each decoded frame in the input, and
72
-store it in the file @file{out.crc}:
72
+@var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
73
+CRC of the packet.
74
+
75
+For example to compute the CRC of the audio and video frames in
76
+@file{INPUT}, converted to raw audio and video packets, and store it
77
+in the file @file{out.crc}:
73 78
 @example
74 79
 ffmpeg -i INPUT -f framecrc out.crc
75 80
 @end example
76 81
 
77
-You can print the CRC of each decoded frame to stdout with the command:
82
+To print the information to stdout, use the command:
78 83
 @example
79 84
 ffmpeg -i INPUT -f framecrc -
80 85
 @end example
81 86
 
82
-You can select the output format of each frame with @command{ffmpeg} by
83
-specifying the audio and video codec and format. For example, to
87
+With @command{ffmpeg}, you can select the output format to which the
88
+audio and video frames are encoded before computing the CRC for each
89
+packet by specifying the audio and video codec. For example, to
84 90
 compute the CRC of each decoded input audio frame converted to PCM
85 91
 unsigned 8-bit and of each decoded input video frame converted to
86 92
 MPEG-2 video, use the command: