FFmpeg
adler32.h
Go to the documentation of this file.
1 /*
2  * copyright (c) 2006 Mans Rullgard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /**
22  * @file
23  * @ingroup lavu_adler32
24  * Public header for Adler-32 hash function implementation.
25  */
26 
27 #ifndef AVUTIL_ADLER32_H
28 #define AVUTIL_ADLER32_H
29 
30 #include <stddef.h>
31 #include <stdint.h>
32 #include "attributes.h"
33 
34 /**
35  * @defgroup lavu_adler32 Adler-32
36  * @ingroup lavu_hash
37  * Adler-32 hash function implementation.
38  *
39  * @{
40  */
41 
42 typedef uint32_t AVAdler;
43 
44 /**
45  * Calculate the Adler32 checksum of a buffer.
46  *
47  * Passing the return value to a subsequent av_adler32_update() call
48  * allows the checksum of multiple buffers to be calculated as though
49  * they were concatenated.
50  *
51  * @param adler initial checksum value
52  * @param buf pointer to input buffer
53  * @param len size of input buffer
54  * @return updated checksum
55  */
56 AVAdler av_adler32_update(AVAdler adler, const uint8_t *buf,
57  size_t len) av_pure;
58 
59 /**
60  * @}
61  */
62 
63 #endif /* AVUTIL_ADLER32_H */
av_pure
#define av_pure
Definition: attributes.h:78
av_adler32_update
AVAdler av_adler32_update(AVAdler adler, const uint8_t *buf, size_t len) av_pure
Calculate the Adler32 checksum of a buffer.
Definition: adler32.c:44
attributes.h
len
int len
Definition: vorbis_enc_data.h:452
AVAdler
uint32_t AVAdler
Definition: adler32.h:42