FFmpeg 4.4.5
Loading...
Searching...
No Matches
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#include "version.h"
34
35/**
36 * @defgroup lavu_adler32 Adler-32
37 * @ingroup lavu_hash
38 * Adler-32 hash function implementation.
39 *
40 * @{
41 */
42
43#if FF_API_CRYPTO_SIZE_T
44typedef unsigned long AVAdler;
45#else
46typedef uint32_t AVAdler;
47#endif
48
49/**
50 * Calculate the Adler32 checksum of a buffer.
51 *
52 * Passing the return value to a subsequent av_adler32_update() call
53 * allows the checksum of multiple buffers to be calculated as though
54 * they were concatenated.
55 *
56 * @param adler initial checksum value
57 * @param buf pointer to input buffer
58 * @param len size of input buffer
59 * @return updated checksum
60 */
61AVAdler av_adler32_update(AVAdler adler, const uint8_t *buf,
63 unsigned int len) av_pure;
64#else
65 size_t len) av_pure;
66#endif
67
68/**
69 * @}
70 */
71
72#endif /* AVUTIL_ADLER32_H */
Macro definitions for various function/variable attributes.
#define av_pure
Definition attributes.h:76
uint32_t AVAdler
Definition adler32.h:46
AVAdler av_adler32_update(AVAdler adler, const uint8_t *buf, size_t len) av_pure
Calculate the Adler32 checksum of a buffer.
#define FF_API_CRYPTO_SIZE_T
Definition version.h:124
swscale version macros