Document SHA-1 functions and structures
[libav.git] / libavutil / sha1.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_SHA1_H
22 #define AVUTIL_SHA1_H
23
24 #include <stdint.h>
25
26 extern const int av_sha1_size;
27
28 struct AVSHA1;
29
30 /**
31 * Initializes SHA-1 hashing.
32 *
33 * @param context pointer to the function context (of size av_sha_size)
34 */
35 void av_sha1_init(struct AVSHA1* context);
36
37 /**
38 * Updates hash value.
39 *
40 * @param context hash function context
41 * @param data input data to update hash with
42 * @param len input data length
43 */
44 void av_sha1_update(struct AVSHA1* context, const uint8_t* data, unsigned int len);
45
46 /**
47 * Finishes hashing and output digest value.
48 *
49 * @param context hash function context
50 * @param digest buffer where output digest value is stored
51 */
52 void av_sha1_final(struct AVSHA1* context, uint8_t digest[20]);
53
54 #endif /* AVUTIL_SHA1_H */