annotate sha1.h @ 747:860d74503de2 libavutil

Document SHA-1 functions and structures
author kostya
date Thu, 09 Jul 2009 07:07:01 +0000
parents bd4052d9050c
children 1e5bfdf9054d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
351
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
1 /*
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
2 * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
3 *
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
4 * This file is part of FFmpeg.
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
5 *
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
8 * License as published by the Free Software Foundation; either
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
10 *
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
14 * Lesser General Public License for more details.
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
15 *
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
19 */
47335869d5f7 Add proper license header.
diego
parents: 343
diff changeset
20
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 446
diff changeset
21 #ifndef AVUTIL_SHA1_H
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 446
diff changeset
22 #define AVUTIL_SHA1_H
288
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
23
343
f21d1907d47c include all prerequisites in header files
mru
parents: 288
diff changeset
24 #include <stdint.h>
f21d1907d47c include all prerequisites in header files
mru
parents: 288
diff changeset
25
288
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
26 extern const int av_sha1_size;
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
27
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
28 struct AVSHA1;
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
29
747
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
30 /**
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
31 * Initializes SHA-1 hashing.
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
32 *
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
33 * @param context pointer to the function context (of size av_sha_size)
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
34 */
288
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
35 void av_sha1_init(struct AVSHA1* context);
747
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
36
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
37 /**
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
38 * Updates hash value.
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
39 *
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
40 * @param context hash function context
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
41 * @param data input data to update hash with
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
42 * @param len input data length
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
43 */
446
81f4d434dc96 Missing const found by -Wwrite-strings.
michael
parents: 392
diff changeset
44 void av_sha1_update(struct AVSHA1* context, const uint8_t* data, unsigned int len);
747
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
45
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
46 /**
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
47 * Finishes hashing and output digest value.
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
48 *
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
49 * @param context hash function context
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
50 * @param digest buffer where output digest value is stored
860d74503de2 Document SHA-1 functions and structures
kostya
parents: 567
diff changeset
51 */
288
c82b7b95e69d simple SHA-1 implementation
michael
parents:
diff changeset
52 void av_sha1_final(struct AVSHA1* context, uint8_t digest[20]);
392
d0f3bb6e367e Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 351
diff changeset
53
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 446
diff changeset
54 #endif /* AVUTIL_SHA1_H */