adler32: add API documentation
[libav.git] / libavutil / adler32.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2006 Mans Rullgard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
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
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVUTIL_ADLER32_H
22#define AVUTIL_ADLER32_H
b9a73d8d 23
99545457 24#include <stdint.h>
2ed6f399 25#include "attributes.h"
99545457 26
82012619
MR
27/**
28 * Calculate the Adler32 checksum of a buffer.
29 *
30 * Passing the return value to a subsequent av_adler32_update() call
31 * allows the checksum of multiple buffers to be calculated as though
32 * they were concatenated.
33 *
34 * @param adler initial checksum value
35 * @param buf pointer to input buffer
36 * @param len size of input buffer
37 * @return updated checksum
38 */
b9a73d8d 39unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
85074d3c 40 unsigned int len) av_pure;
b9a73d8d 41
98790382 42#endif /* AVUTIL_ADLER32_H */