Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavutil / sha.h
1 /*
2  * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
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_SHA_H
22 #define AVUTIL_SHA_H
23
24 #include <stdint.h>
25
26 /**
27  * @defgroup lavu_sha SHA
28  * @ingroup lavu_crypto
29  * @{
30  */
31
32 extern const int av_sha_size;
33
34 struct AVSHA;
35
36 /**
37  * Initialize SHA-1 or SHA-2 hashing.
38  *
39  * @param context pointer to the function context (of size av_sha_size)
40  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
41  * @return        zero if initialization succeeded, -1 otherwise
42  */
43 int av_sha_init(struct AVSHA* context, int bits);
44
45 /**
46  * Update hash value.
47  *
48  * @param context hash function context
49  * @param data    input data to update hash with
50  * @param len     input data length
51  */
52 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len);
53
54 /**
55  * Finish hashing and output digest value.
56  *
57  * @param context hash function context
58  * @param digest  buffer where output digest value is stored
59  */
60 void av_sha_final(struct AVSHA* context, uint8_t *digest);
61
62 /**
63  * @}
64  */
65
66 #endif /* AVUTIL_SHA_H */