doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / blenlib / intern / rand.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include <stdlib.h>
31 #include <string.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "PIL_time.h"
36
37 #include "BLI_threads.h"
38 #include "BLI_rand.h"
39
40 #if defined(WIN32) && !defined(FREE_WINDOWS)
41 typedef unsigned __int64        r_uint64;
42
43 #define MULTIPLIER      0x5DEECE66Di64 
44 #define MASK            0x0000FFFFFFFFFFFFi64
45 #else
46 typedef unsigned long long      r_uint64;
47
48 #define MULTIPLIER      0x5DEECE66Dll
49 #define MASK            0x0000FFFFFFFFFFFFll
50 #endif
51
52 #define ADDEND          0xB
53
54 #define LOWSEED         0x330E
55
56 /***/
57
58 struct RNG {
59         r_uint64 X;
60 };
61
62 RNG     *rng_new(unsigned int seed)
63 {
64         RNG *rng = MEM_mallocN(sizeof(*rng), "rng");
65
66         rng_seed(rng, seed);
67
68         return rng;
69 }
70
71 void rng_free(RNG* rng)
72 {
73         MEM_freeN(rng);
74 }
75
76 void rng_seed(RNG *rng, unsigned int seed) {
77         rng->X= (((r_uint64) seed)<<16) | LOWSEED;
78 }
79
80 void rng_srandom(RNG *rng, unsigned int seed) {
81         extern unsigned char hash[];    // noise.c
82         
83         rng_seed(rng, seed + hash[seed & 255]);
84         seed= rng_getInt(rng);
85         rng_seed(rng, seed + hash[seed & 255]);
86         seed= rng_getInt(rng);
87         rng_seed(rng, seed + hash[seed & 255]);
88 }
89
90 int rng_getInt(RNG *rng) {
91         rng->X= (MULTIPLIER*rng->X + ADDEND)&MASK;
92         return (int) (rng->X>>17);
93 }
94
95 double rng_getDouble(RNG *rng) {
96         return (double) rng_getInt(rng)/0x80000000;
97 }
98
99 float rng_getFloat(RNG *rng) {
100         return (float) rng_getInt(rng)/0x80000000;
101 }
102
103 void rng_shuffleArray(RNG *rng, void *data, int elemSize, int numElems)
104 {
105         int i = numElems;
106         void *temp = malloc(elemSize);
107
108         while (--i) {
109                 int j = rng_getInt(rng)%numElems;
110                 if(i!=j) {
111                         void *iElem = (unsigned char*)data + i*elemSize;
112                         void *jElem = (unsigned char*)data + j*elemSize;
113                         memcpy(temp, iElem, elemSize);
114                         memcpy(iElem, jElem, elemSize);
115                         memcpy(jElem, temp, elemSize);
116                 }
117         }
118
119         free(temp);
120 }
121
122 void rng_skip(RNG *rng, int n)
123 {
124         int i;
125
126         for(i=0; i<n; i++)
127                 rng_getInt(rng);
128 }
129
130 /***/
131
132 static RNG theBLI_rng = {0};
133
134 /* note, this one creates periodical patterns */
135 void BLI_srand(unsigned int seed) {
136         rng_seed(&theBLI_rng, seed);
137 }
138
139 /* using hash table to create better seed */
140 void BLI_srandom(unsigned int seed) {
141         rng_srandom(&theBLI_rng, seed);
142 }
143
144 int BLI_rand(void) {
145         return rng_getInt(&theBLI_rng);
146 }
147
148 double BLI_drand(void) {
149         return rng_getDouble(&theBLI_rng);
150 }
151
152 float BLI_frand(void) {
153         return rng_getFloat(&theBLI_rng);
154 }
155
156 void BLI_fillrand(void *addr, int len) {
157         RNG rng;
158         unsigned char *p= addr;
159
160         rng_seed(&rng, (unsigned int) (PIL_check_seconds_timer()*0x7FFFFFFF));
161         while (len--) *p++= rng_getInt(&rng)&0xFF;
162 }
163
164 void BLI_array_randomize(void *data, int elemSize, int numElems, unsigned int seed)
165 {
166         RNG rng;
167
168         rng_seed(&rng, seed);
169         rng_shuffleArray(&rng, data, elemSize, numElems);
170 }
171
172 /* ********* for threaded random ************** */
173
174 static RNG rng_tab[BLENDER_MAX_THREADS];
175
176 void BLI_thread_srandom(int thread, unsigned int seed)
177 {
178         extern unsigned char hash[];    // noise.c
179         
180         if(thread >= BLENDER_MAX_THREADS)
181                 thread= 0;
182         
183         rng_seed(&rng_tab[thread], seed + hash[seed & 255]);
184         seed= rng_getInt(&rng_tab[thread]);
185         rng_seed(&rng_tab[thread], seed + hash[seed & 255]);
186         seed= rng_getInt(&rng_tab[thread]);
187         rng_seed(&rng_tab[thread], seed + hash[seed & 255]);
188 }
189
190 int BLI_thread_rand(int thread) {
191         return rng_getInt(&rng_tab[thread]);
192 }
193
194 float BLI_thread_frand(int thread) {
195         return rng_getFloat(&rng_tab[thread]);
196 }
197