avutil: Group hash functions separately in Doxygen
[ffmpeg.git] / libavutil / hash.h
1 /*
2  * Copyright (C) 2013 Reimar Döffinger <Reimar.Doeffinger@gmx.de>
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_hash_generic
24  * Generic hashing API
25  */
26
27 #ifndef AVUTIL_HASH_H
28 #define AVUTIL_HASH_H
29
30 #include <stdint.h>
31
32 /**
33  * @defgroup lavu_hash Hash Functions
34  * @ingroup lavu_crypto
35  *
36  * @{
37  *
38  * @defgroup lavu_hash_generic Generic Hashing API
39  *
40  * @{
41  */
42
43 struct AVHashContext;
44
45 /**
46  * Allocate a hash context for the algorithm specified by name.
47  *
48  * @return  >= 0 for success, a negative error code for failure
49  * @note  The context is not initialized, you must call av_hash_init().
50  */
51 int av_hash_alloc(struct AVHashContext **ctx, const char *name);
52
53 /**
54  * Get the names of available hash algorithms.
55  *
56  * This function can be used to enumerate the algorithms.
57  *
58  * @param i  index of the hash algorithm, starting from 0
59  * @return   a pointer to a static string or NULL if i is out of range
60  */
61 const char *av_hash_names(int i);
62
63 /**
64  * Get the name of the algorithm corresponding to the given hash context.
65  */
66 const char *av_hash_get_name(const struct AVHashContext *ctx);
67
68 /**
69  * Maximum value that av_hash_get_size will currently return.
70  *
71  * You can use this if you absolutely want or need to use static allocation
72  * and are fine with not supporting hashes newly added to libavutil without
73  * recompilation.
74  * Note that you still need to check against av_hash_get_size, adding new hashes
75  * with larger sizes will not be considered an ABI change and should not cause
76  * your code to overflow a buffer.
77  */
78 #define AV_HASH_MAX_SIZE 64
79
80 /**
81  * Get the size of the resulting hash value in bytes.
82  *
83  * The pointer passed to av_hash_final have space for at least this many bytes.
84  */
85 int av_hash_get_size(const struct AVHashContext *ctx);
86
87 /**
88  * Initialize or reset a hash context.
89  */
90 void av_hash_init(struct AVHashContext *ctx);
91
92 /**
93  * Update a hash context with additional data.
94  */
95 void av_hash_update(struct AVHashContext *ctx, const uint8_t *src, int len);
96
97 /**
98  * Finalize a hash context and compute the actual hash value.
99  */
100 void av_hash_final(struct AVHashContext *ctx, uint8_t *dst);
101
102 /**
103  * Finalize a hash context and compute the actual hash value.
104  * If size is smaller than the hash size, the hash is truncated;
105  * if size is larger, the buffer is padded with 0.
106  */
107 void av_hash_final_bin(struct AVHashContext *ctx, uint8_t *dst, int size);
108
109 /**
110  * Finalize a hash context and compute the actual hash value as a hex string.
111  * The string is always 0-terminated.
112  * If size is smaller than 2 * hash_size + 1, the hex string is truncated.
113  */
114 void av_hash_final_hex(struct AVHashContext *ctx, uint8_t *dst, int size);
115
116 /**
117  * Finalize a hash context and compute the actual hash value as a base64 string.
118  * The string is always 0-terminated.
119  * If size is smaller than AV_BASE64_SIZE(hash_size), the base64 string is
120  * truncated.
121  */
122 void av_hash_final_b64(struct AVHashContext *ctx, uint8_t *dst, int size);
123
124 /**
125  * Free hash context.
126  */
127 void av_hash_freep(struct AVHashContext **ctx);
128
129 /**
130  * @}
131  * @}
132  */
133
134 #endif /* AVUTIL_HASH_H */