blob: a1f035b7340f8b7d0fd6327e3a9b65189c4e93a4
| 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 <stdint.h> |
| 31 | #include "attributes.h" |
| 32 | |
| 33 | /** |
| 34 | * @defgroup lavu_adler32 Adler-32 |
| 35 | * @ingroup lavu_hash |
| 36 | * Adler-32 hash function implementation. |
| 37 | * |
| 38 | * @{ |
| 39 | */ |
| 40 | |
| 41 | /** |
| 42 | * Calculate the Adler32 checksum of a buffer. |
| 43 | * |
| 44 | * Passing the return value to a subsequent av_adler32_update() call |
| 45 | * allows the checksum of multiple buffers to be calculated as though |
| 46 | * they were concatenated. |
| 47 | * |
| 48 | * @param adler initial checksum value |
| 49 | * @param buf pointer to input buffer |
| 50 | * @param len size of input buffer |
| 51 | * @return updated checksum |
| 52 | */ |
| 53 | unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf, |
| 54 | unsigned int len) av_pure; |
| 55 | |
| 56 | /** |
| 57 | * @} |
| 58 | */ |
| 59 | |
| 60 | #endif /* AVUTIL_ADLER32_H */ |
| 61 |