Browse code

Add documentation for the crc muxer.

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

Stefano Sabatini authored on 2011/01/31 23:20:09
Showing 1 changed files
... ...
@@ -18,6 +18,38 @@ enabled muxers.
18 18
 
19 19
 A description of some of the currently available muxers follows.
20 20
 
21
+@section crc
22
+
23
+CRC (Cyclic Redundancy Check) testing format.
24
+
25
+This muxer computes and prints the Adler-32 CRC of all the input audio
26
+and video frames. By default audio frames are converted to signed
27
+16-bit raw audio and video frames to raw video before computing the
28
+CRC.
29
+
30
+The output of the muxer consists of a single line of the form:
31
+CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
32
+8 digits containing the CRC for all the decoded input frames.
33
+
34
+For example to compute the CRC of the input, and store it in the file
35
+@file{out.crc}:
36
+@example
37
+ffmpeg -i INPUT -f crc out.crc
38
+@end example
39
+
40
+You can print the CRC to stdout with the command:
41
+@example
42
+ffmpeg -i INPUT -f crc -
43
+@end example
44
+
45
+You can select the output format of each frame with @file{ffmpeg} by
46
+specifying the audio and video codec and format. For example to
47
+compute the CRC of the input audio converted to PCM unsigned 8-bit
48
+and the input video converted to MPEG-2 video, use the command:
49
+@example
50
+ffmpeg -i INPUT -acodec pcm_u8 -vcodec mpeg2video -f crc -
51
+@end example
52
+
21 53
 @section image2
22 54
 
23 55
 Image file muxer.