diff options
author | Måns Rullgård <mans@mansr.com> | 2010-06-30 20:09:40 +0000 |
---|---|---|
committer | Måns Rullgård <mans@mansr.com> | 2010-06-30 20:09:40 +0000 |
commit | 82012619962ed0fd97e8ec36b732265103a0a2a3 (patch) | |
tree | b0eeb8c327577d5322247318cd0a7b80fd68cda1 /libavutil/adler32.h | |
parent | 1782460b387258b1872fcb7c40edcab9a2e63bcb (diff) | |
download | ffmpeg-82012619962ed0fd97e8ec36b732265103a0a2a3.tar.gz |
adler32: add API documentation
Originally committed as revision 23907 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavutil/adler32.h')
-rw-r--r-- | libavutil/adler32.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/libavutil/adler32.h b/libavutil/adler32.h index 9626c80567..0b890bcc11 100644 --- a/libavutil/adler32.h +++ b/libavutil/adler32.h @@ -24,6 +24,18 @@ #include <stdint.h> #include "attributes.h" +/** + * Calculate the Adler32 checksum of a buffer. + * + * Passing the return value to a subsequent av_adler32_update() call + * allows the checksum of multiple buffers to be calculated as though + * they were concatenated. + * + * @param adler initial checksum value + * @param buf pointer to input buffer + * @param len size of input buffer + * @return updated checksum + */ unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf, unsigned int len) av_pure; |