avutil: Group hash functions separately in Doxygen
[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 /**
22  * @file
23  * @ingroup lavu_sha
24  * Public header for SHA-1 & SHA-256 hash function implementations.
25  */
26
27 #ifndef AVUTIL_SHA_H
28 #define AVUTIL_SHA_H
29
30 #include <stdint.h>
31
32 #include "attributes.h"
33 #include "version.h"
34
35 /**
36  * @defgroup lavu_sha SHA
37  * @ingroup lavu_hash
38  * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations.
39  *
40  * @{
41  */
42
43 extern const int av_sha_size;
44
45 struct AVSHA;
46
47 /**
48  * Allocate an AVSHA context.
49  */
50 struct AVSHA *av_sha_alloc(void);
51
52 /**
53  * Initialize SHA-1 or SHA-2 hashing.
54  *
55  * @param context pointer to the function context (of size av_sha_size)
56  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
57  * @return        zero if initialization succeeded, -1 otherwise
58  */
59 int av_sha_init(struct AVSHA* context, int bits);
60
61 /**
62  * Update hash value.
63  *
64  * @param context hash function context
65  * @param data    input data to update hash with
66  * @param len     input data length
67  */
68 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len);
69
70 /**
71  * Finish hashing and output digest value.
72  *
73  * @param context hash function context
74  * @param digest  buffer where output digest value is stored
75  */
76 void av_sha_final(struct AVSHA* context, uint8_t *digest);
77
78 /**
79  * @}
80  */
81
82 #endif /* AVUTIL_SHA_H */