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

   1 /*
   2  * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
   3  * Copyright (C) 2013 James Almer <jamrial@gmail.com>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file
  24  * @ingroup lavu_ripemd
  25  * Public header for RIPEMD hash function implementation.
  26  */
  27
  28 #ifndef AVUTIL_RIPEMD_H
  29 #define AVUTIL_RIPEMD_H
  30
  31 #include <stdint.h>
  32
  33 #include "attributes.h"
  34 #include "version.h"
  35
  36 /**
  37  * @defgroup lavu_ripemd RIPEMD
  38  * @ingroup lavu_hash
  39  * RIPEMD hash function implementation.
  40  *
  41  * @{
  42  */
  43
  44 extern const int av_ripemd_size;
  45
  46 struct AVRIPEMD;
  47
  48 /**
  49  * Allocate an AVRIPEMD context.
  50  */
  51 struct AVRIPEMD *av_ripemd_alloc(void);
  52
  53 /**
  54  * Initialize RIPEMD hashing.
  55  *
  56  * @param context pointer to the function context (of size av_ripemd_size)
  57  * @param bits    number of bits in digest (128, 160, 256 or 320 bits)
  58  * @return        zero if initialization succeeded, -1 otherwise
  59  */
  60 int av_ripemd_init(struct AVRIPEMD* context, int bits);
  61
  62 /**
  63  * Update hash value.
  64  *
  65  * @param context hash function context
  66  * @param data    input data to update hash with
  67  * @param len     input data length
  68  */
  69 void av_ripemd_update(struct AVRIPEMD* context, const uint8_t* data, unsigned int len);
  70
  71 /**
  72  * Finish hashing and output digest value.
  73  *
  74  * @param context hash function context
  75  * @param digest  buffer where output digest value is stored
  76  */
  77 void av_ripemd_final(struct AVRIPEMD* context, uint8_t *digest);
  78
  79 /**
  80  * @}
  81  */
  82
  83 #endif /* AVUTIL_RIPEMD_H */