random_seed: more elaborate doxy.
[ffmpeg.git] / libavutil / random_seed.h
1 /*
2  * Copyright (c) 2009 Baptiste Coudurier <baptiste.coudurier@gmail.com>
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_RANDOM_SEED_H
22 #define AVUTIL_RANDOM_SEED_H
23
24 #include <stdint.h>
25
26 /**
27  * Get a seed to use in conjunction with random functions.
28  * This function tries to provide a good seed at a best effort bases.
29  * Its possible to call this function multiple times if more bits are needed.
30  * It can be quite slow, which is why it should only be used as seed for a faster
31  * PRNG. The quality of the seed depends on the platform.
32  */
33 uint32_t av_get_random_seed(void);
34
35 #endif /* AVUTIL_RANDOM_SEED_H */