avutil: Group hash functions separately in Doxygen
[ffmpeg.git] / libavutil / murmur3.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_murmur3
24  * Public header for MurmurHash3 hash function implementation.
25  */
26
27 #ifndef AVUTIL_MURMUR3_H
28 #define AVUTIL_MURMUR3_H
29
30 #include <stdint.h>
31
32 /**
33  * @defgroup lavu_murmur3 Murmur3
34  * @ingroup lavu_hash
35  * MurmurHash3 hash function implementation.
36  *
37  * @{
38  */
39
40 struct AVMurMur3 *av_murmur3_alloc(void);
41 void av_murmur3_init_seeded(struct AVMurMur3 *c, uint64_t seed);
42 void av_murmur3_init(struct AVMurMur3 *c);
43 void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, int len);
44 void av_murmur3_final(struct AVMurMur3 *c, uint8_t dst[16]);
45
46 /**
47  * @}
48  */
49
50 #endif /* AVUTIL_MURMUR3_H */