git.sesse.net Git - ffmpeg/blob - libavutil/adler32.h

   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 #ifndef AVUTIL_ADLER32_H
  22 #define AVUTIL_ADLER32_H
  23
  24 #include <stdint.h>
  25 #include "attributes.h"
  26
  27 /**
  28  * @file
  29  * Public header for libavutil Adler32 hasher
  30  *
  31  * @defgroup lavu_adler32 Adler32
  32  * @ingroup lavu_crypto
  33  * @{
  34  */
  35
  36 /**
  37  * Calculate the Adler32 checksum of a buffer.
  38  *
  39  * Passing the return value to a subsequent av_adler32_update() call
  40  * allows the checksum of multiple buffers to be calculated as though
  41  * they were concatenated.
  42  *
  43  * @param adler initial checksum value
  44  * @param buf   pointer to input buffer
  45  * @param len   size of input buffer
  46  * @return      updated checksum
  47  */
  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 */