adler32.h 1.55 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Mans Rullgard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVUTIL_ADLER32_H
#define AVUTIL_ADLER32_H
23

24
#include <stdint.h>
25
#include "attributes.h"
26

27
/**
28 29 30
 * @file
 * Public header for libavutil Adler32 hasher
 *
31
 * @defgroup lavu_adler32 Adler32
32
 * @ingroup lavu_crypto
33
 * @{
34 35 36
 */

/**
37 38 39 40 41 42 43 44 45 46 47
 * 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
 */
48
unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
49
                                unsigned int len) av_pure;
50

51 52 53 54
/**
 * @}
 */

55
#endif /* AVUTIL_ADLER32_H */