Merge branch 'blender2.7'
[blender.git] / source / blender / python / mathutils / mathutils_noise.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup mathutils
19  *
20  * This file defines the 'noise' module, a general purpose module to access
21  * blenders noise functions.
22  */
23
24
25 /************************/
26 /* Blender Noise Module */
27 /************************/
28
29 #include <Python.h>
30
31 #include "BLI_math.h"
32 #include "BLI_noise.h"
33 #include "BLI_utildefines.h"
34
35 #include "DNA_texture_types.h"
36
37 #include "../generic/py_capi_utils.h"
38
39 #include "mathutils.h"
40 #include "mathutils_noise.h"
41
42 /*-----------------------------------------*/
43 /* 'mersenne twister' random number generator */
44
45 /*
46  * A C-program for MT19937, with initialization improved 2002/2/10.
47  * Coded by Takuji Nishimura and Makoto Matsumoto.
48  * This is a faster version by taking Shawn Cokus's optimization,
49  * Matthe Bellew's simplification, Isaku Wada's real version.
50  *
51  * Before using, initialize the state by using init_genrand(seed)
52  * or init_by_array(init_key, key_length).
53  *
54  * Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
55  * All rights reserved.
56  *
57  * Redistribution and use in source and binary forms, with or without
58  * modification, are permitted provided that the following conditions
59  * are met:
60  *
61  *   1. Redistributions of source code must retain the above copyright
62  *      notice, this list of conditions and the following disclaimer.
63  *
64  *   2. Redistributions in binary form must reproduce the above copyright
65  *      notice, this list of conditions and the following disclaimer in the
66  *      documentation and/or other materials provided with the distribution.
67  *
68  *   3. The names of its contributors may not be used to endorse or promote
69  *      products derived from this software without specific prior written
70  *      permission.
71  *
72  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
73  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
74  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
75  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
76  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
77  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
78  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
79  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
80  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
81  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
82  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83  * Any feedback is very welcome.
84  * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
85  * email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
86  */
87
88 /* Period parameters */
89 #define N 624
90 #define M 397
91 #define MATRIX_A 0x9908b0dfUL   /* constant vector a */
92 #define UMASK 0x80000000UL  /* most significant w-r bits */
93 #define LMASK 0x7fffffffUL  /* least significant r bits */
94 #define MIXBITS(u, v) (((u) & UMASK) | ((v) & LMASK))
95 #define TWIST(u, v) ((MIXBITS(u, v) >> 1) ^ ((v) & 1UL ? MATRIX_A : 0UL))
96
97 static unsigned long state[N];  /* the array for the state vector  */
98 static int left = 1;
99 static int initf = 0;
100 static unsigned long *next;
101 static float state_offset_vector[3 * 3];
102
103 /* initializes state[N] with a seed */
104 static void init_genrand(unsigned long s)
105 {
106         int j;
107         state[0] = s & 0xffffffffUL;
108         for (j = 1; j < N; j++) {
109                 state[j] =
110                     (1812433253UL *
111                      (state[j - 1] ^ (state[j - 1] >> 30)) + j);
112                 /* See Knuth TAOCP Vol2. 3rd Ed. P.106 for multiplier. */
113                 /* In the previous versions, MSBs of the seed affect   */
114                 /* only MSBs of the array state[].                        */
115                 /* 2002/01/09 modified by Makoto Matsumoto             */
116                 state[j] &= 0xffffffffUL;   /* for >32 bit machines */
117         }
118         left = 1;
119         initf = 1;
120
121         /* update vector offset */
122         {
123                 const unsigned long *state_offset = &state[N - ARRAY_SIZE(state_offset_vector)];
124                 const float range = 32;  /* range in both pos/neg direction */
125                 for (j = 0; j < ARRAY_SIZE(state_offset_vector); j++, state_offset++) {
126                         /* overflow is fine here */
127                         state_offset_vector[j] = (float)(int)(*state_offset) * (1.0f / (INT_MAX / range));
128                 }
129         }
130 }
131
132 static void next_state(void)
133 {
134         unsigned long *p = state;
135         int j;
136
137         /* if init_genrand() has not been called, */
138         /* a default initial seed is used         */
139         if (initf == 0)
140                 init_genrand(5489UL);
141
142         left = N;
143         next = state;
144
145         for (j = N - M + 1; --j; p++)
146                 *p = p[M] ^ TWIST(p[0], p[1]);
147
148         for (j = M; --j; p++)
149                 *p = p[M - N] ^ TWIST(p[0], p[1]);
150
151         *p = p[M - N] ^ TWIST(p[0], state[0]);
152 }
153
154 /*------------------------------------------------------------*/
155
156 static void setRndSeed(int seed)
157 {
158         if (seed == 0)
159                 init_genrand(time(NULL));
160         else
161                 init_genrand(seed);
162 }
163
164 /* float number in range [0, 1) using the mersenne twister rng */
165 static float frand(void)
166 {
167         unsigned long y;
168
169         if (--left == 0)
170                 next_state();
171         y = *next++;
172
173         /* Tempering */
174         y ^= (y >> 11);
175         y ^= (y << 7) & 0x9d2c5680UL;
176         y ^= (y << 15) & 0xefc60000UL;
177         y ^= (y >> 18);
178
179         return (float) y / 4294967296.f;
180 }
181
182 /*------------------------------------------------------------*/
183 /* Utility Functions */
184 /*------------------------------------------------------------*/
185
186 #define BPY_NOISE_BASIS_ENUM_DOC \
187 "   :arg noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', " \
188                                                                         "'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', " \
189                                                                         "'CELLNOISE'].\n" \
190 "   :type noise_basis: string\n" \
191
192 #define BPY_NOISE_METRIC_ENUM_DOC \
193 "   :arg distance_metric: Enumerator in ['DISTANCE', 'DISTANCE_SQUARED', 'MANHATTAN', 'CHEBYCHEV', " \
194                                                                                 "'MINKOVSKY', 'MINKOVSKY_HALF', 'MINKOVSKY_FOUR'].\n" \
195 "   :type distance_metric: string\n" \
196
197 /* Noise basis enum */
198 #define DEFAULT_NOISE_TYPE TEX_STDPERLIN
199
200 static PyC_FlagSet bpy_noise_types[] = {
201         {TEX_BLENDER,         "BLENDER"},
202         {TEX_STDPERLIN,       "PERLIN_ORIGINAL"},
203         {TEX_NEWPERLIN,       "PERLIN_NEW"},
204         {TEX_VORONOI_F1,      "VORONOI_F1"},
205         {TEX_VORONOI_F2,      "VORONOI_F2"},
206         {TEX_VORONOI_F3,      "VORONOI_F3"},
207         {TEX_VORONOI_F4,      "VORONOI_F4"},
208         {TEX_VORONOI_F2F1,    "VORONOI_F2F1"},
209         {TEX_VORONOI_CRACKLE, "VORONOI_CRACKLE"},
210         {TEX_CELLNOISE,       "CELLNOISE"},
211         {0, NULL},
212 };
213
214 /* Metric basis enum */
215 #define DEFAULT_METRIC_TYPE TEX_DISTANCE
216
217 static PyC_FlagSet bpy_noise_metrics[] = {
218         {TEX_DISTANCE,         "DISTANCE"},
219         {TEX_DISTANCE_SQUARED, "DISTANCE_SQUARED"},
220         {TEX_MANHATTAN,        "MANHATTAN"},
221         {TEX_CHEBYCHEV,        "CHEBYCHEV"},
222         {TEX_MINKOVSKY,        "MINKOVSKY"},
223         {TEX_MINKOVSKY_HALF,   "MINKOVSKY_HALF"},
224         {TEX_MINKOVSKY_FOUR,   "MINKOVSKY_FOUR"},
225         {0, NULL},
226 };
227
228 /* Fills an array of length size with random numbers in the range (-1, 1)*/
229 static void rand_vn(float *array_tar, const int size)
230 {
231         float *array_pt = array_tar + (size - 1);
232         int i = size;
233         while (i--) { *(array_pt--) = 2.0f * frand() - 1.0f; }
234 }
235
236 /* Fills an array of length 3 with noise values */
237 static void noise_vector(float x, float y, float z, int nb, float v[3])
238 {
239         /* Simply evaluate noise at 3 different positions */
240         const float *ofs = state_offset_vector;
241         for (int j = 0; j < 3; j++) {
242                 v[j] = (2.0f * BLI_gNoise(1.0f, x + ofs[0], y + ofs[1], z + ofs[2], 0, nb) - 1.0f);
243                 ofs += 3;
244         }
245 }
246
247 /* Returns a turbulence value for a given position (x, y, z) */
248 static float turb(
249         float x, float y, float z, int oct, int hard, int nb,
250         float ampscale, float freqscale)
251 {
252         float amp, out, t;
253         int i;
254         amp = 1.f;
255         out = (float)(2.0f * BLI_gNoise(1.f, x, y, z, 0, nb) - 1.0f);
256         if (hard)
257                 out = fabsf(out);
258         for (i = 1; i < oct; i++) {
259                 amp *= ampscale;
260                 x *= freqscale;
261                 y *= freqscale;
262                 z *= freqscale;
263                 t = (float)(amp * (2.0f * BLI_gNoise(1.f, x, y, z, 0, nb) - 1.0f));
264                 if (hard)
265                         t = fabsf(t);
266                 out += t;
267         }
268         return out;
269 }
270
271 /* Fills an array of length 3 with the turbulence vector for a given
272  * position (x, y, z) */
273 static void vTurb(
274         float x, float y, float z, int oct, int hard, int nb,
275         float ampscale, float freqscale, float v[3])
276 {
277         float amp, t[3];
278         int i;
279         amp = 1.f;
280         noise_vector(x, y, z, nb, v);
281         if (hard) {
282                 v[0] = fabsf(v[0]);
283                 v[1] = fabsf(v[1]);
284                 v[2] = fabsf(v[2]);
285         }
286         for (i = 1; i < oct; i++) {
287                 amp *= ampscale;
288                 x *= freqscale;
289                 y *= freqscale;
290                 z *= freqscale;
291                 noise_vector(x, y, z, nb, t);
292                 if (hard) {
293                         t[0] = fabsf(t[0]);
294                         t[1] = fabsf(t[1]);
295                         t[2] = fabsf(t[2]);
296                 }
297                 v[0] += amp * t[0];
298                 v[1] += amp * t[1];
299                 v[2] += amp * t[2];
300         }
301 }
302
303 /*-------------------------DOC STRINGS ---------------------------*/
304 PyDoc_STRVAR(M_Noise_doc,
305 "The Blender noise module"
306 );
307
308 /*------------------------------------------------------------*/
309 /* Python Functions */
310 /*------------------------------------------------------------*/
311
312 PyDoc_STRVAR(M_Noise_random_doc,
313 ".. function:: random()\n"
314 "\n"
315 "   Returns a random number in the range [0, 1).\n"
316 "\n"
317 "   :return: The random number.\n"
318 "   :rtype: float\n"
319 );
320 static PyObject *M_Noise_random(PyObject *UNUSED(self))
321 {
322         return PyFloat_FromDouble(frand());
323 }
324
325 PyDoc_STRVAR(M_Noise_random_unit_vector_doc,
326 ".. function:: random_unit_vector(size=3)\n"
327 "\n"
328 "   Returns a unit vector with random entries.\n"
329 "\n"
330 "   :arg size: The size of the vector to be produced, in the range [2, 4].\n"
331 "   :type size: int\n"
332 "   :return: The random unit vector.\n"
333 "   :rtype: :class:`mathutils.Vector`\n"
334 );
335 static PyObject *M_Noise_random_unit_vector(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
336 {
337         static const char *kwlist[] = {"size", NULL};
338         float vec[4] = {0.0f, 0.0f, 0.0f, 0.0f};
339         float norm = 2.0f;
340         int size = 3;
341
342         if (!PyArg_ParseTupleAndKeywords(
343                     args, kw, "|$i:random_unit_vector", (char **)kwlist,
344                     &size))
345         {
346                 return NULL;
347         }
348
349         if (size > 4 || size < 2) {
350                 PyErr_SetString(PyExc_ValueError, "Vector(): invalid size");
351                 return NULL;
352         }
353
354         while (norm == 0.0f || norm > 1.0f) {
355                 rand_vn(vec, size);
356                 norm = normalize_vn(vec, size);
357         }
358
359         return Vector_CreatePyObject(vec, size, NULL);
360 }
361
362 PyDoc_STRVAR(M_Noise_random_vector_doc,
363 ".. function:: random_vector(size=3)\n"
364 "\n"
365 "   Returns a vector with random entries in the range (-1, 1).\n"
366 "\n"
367 "   :arg size: The size of the vector to be produced.\n"
368 "   :type size: int\n"
369 "   :return: The random vector.\n"
370 "   :rtype: :class:`mathutils.Vector`\n"
371 );
372 static PyObject *M_Noise_random_vector(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
373 {
374         static const char *kwlist[] = {"size", NULL};
375         float *vec = NULL;
376         int size = 3;
377
378         if (!PyArg_ParseTupleAndKeywords(
379                     args, kw, "|$i:random_vector", (char **)kwlist,
380                     &size))
381         {
382                 return NULL;
383         }
384
385         if (size < 2) {
386                 PyErr_SetString(PyExc_ValueError, "Vector(): invalid size");
387                 return NULL;
388         }
389
390         vec = PyMem_New(float, size);
391
392         rand_vn(vec, size);
393
394         return Vector_CreatePyObject_alloc(vec, size, NULL);
395 }
396
397 PyDoc_STRVAR(M_Noise_seed_set_doc,
398 ".. function:: seed_set(seed)\n"
399 "\n"
400 "   Sets the random seed used for random_unit_vector, and random.\n"
401 "\n"
402 "   :arg seed: Seed used for the random generator.\n"
403 "      When seed is zero, the current time will be used instead.\n"
404 "   :type seed: int\n"
405 );
406 static PyObject *M_Noise_seed_set(PyObject *UNUSED(self), PyObject *args)
407 {
408         int s;
409         if (!PyArg_ParseTuple(args, "i:seed_set", &s))
410                 return NULL;
411         setRndSeed(s);
412         Py_RETURN_NONE;
413 }
414
415 PyDoc_STRVAR(M_Noise_noise_doc,
416 ".. function:: noise(position, noise_basis='PERLIN_ORIGINAL')\n"
417 "\n"
418 "   Returns noise value from the noise basis at the position specified.\n"
419 "\n"
420 "   :arg position: The position to evaluate the selected noise function.\n"
421 "   :type position: :class:`mathutils.Vector`\n"
422 BPY_NOISE_BASIS_ENUM_DOC
423 "   :return: The noise value.\n"
424 "   :rtype: float\n"
425 );
426 static PyObject *M_Noise_noise(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
427 {
428         static const char *kwlist[] = {"", "noise_basis", NULL};
429         PyObject *value;
430         float vec[3];
431         const char *noise_basis_str = NULL;
432         int noise_basis_enum = DEFAULT_NOISE_TYPE;
433
434         if (!PyArg_ParseTupleAndKeywords(
435                     args, kw, "O|$s:noise", (char **)kwlist,
436                     &value, &noise_basis_str))
437         {
438                 return NULL;
439         }
440
441         if (!noise_basis_str) {
442                 /* pass through */
443         }
444         else if (PyC_FlagSet_ValueFromID(
445                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "noise") == -1)
446         {
447                 return NULL;
448         }
449
450         if (mathutils_array_parse(vec, 3, 3, value, "noise: invalid 'position' arg") == -1)
451                 return NULL;
452
453         return PyFloat_FromDouble((2.0f * BLI_gNoise(1.0f, vec[0], vec[1], vec[2], 0, noise_basis_enum) - 1.0f));
454 }
455
456 PyDoc_STRVAR(M_Noise_noise_vector_doc,
457 ".. function:: noise_vector(position, noise_basis='PERLIN_ORIGINAL')\n"
458 "\n"
459 "   Returns the noise vector from the noise basis at the specified position.\n"
460 "\n"
461 "   :arg position: The position to evaluate the selected noise function.\n"
462 "   :type position: :class:`mathutils.Vector`\n"
463 BPY_NOISE_BASIS_ENUM_DOC
464 "   :return: The noise vector.\n"
465 "   :rtype: :class:`mathutils.Vector`\n"
466 );
467 static PyObject *M_Noise_noise_vector(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
468 {
469         static const char *kwlist[] = {"", "noise_basis", NULL};
470         PyObject *value;
471         float vec[3], r_vec[3];
472         const char *noise_basis_str = NULL;
473         int noise_basis_enum = DEFAULT_NOISE_TYPE;
474
475         if (!PyArg_ParseTupleAndKeywords(
476                     args, kw, "O|$s:noise_vector", (char **)kwlist,
477                     &value, &noise_basis_str))
478         {
479                 return NULL;
480         }
481
482         if (!noise_basis_str) {
483                 /* pass through */
484         }
485         else if (PyC_FlagSet_ValueFromID(
486                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "noise_vector") == -1)
487         {
488                 return NULL;
489         }
490
491         if (mathutils_array_parse(vec, 3, 3, value, "noise_vector: invalid 'position' arg") == -1)
492                 return NULL;
493
494         noise_vector(vec[0], vec[1], vec[2], noise_basis_enum, r_vec);
495
496         return Vector_CreatePyObject(r_vec, 3, NULL);
497 }
498
499 PyDoc_STRVAR(M_Noise_turbulence_doc,
500 ".. function:: turbulence(position, octaves, hard, noise_basis='PERLIN_ORIGINAL', amplitude_scale=0.5, frequency_scale=2.0)\n"
501 "\n"
502 "   Returns the turbulence value from the noise basis at the specified position.\n"
503 "\n"
504 "   :arg position: The position to evaluate the selected noise function.\n"
505 "   :type position: :class:`mathutils.Vector`\n"
506 "   :arg octaves: The number of different noise frequencies used.\n"
507 "   :type octaves: int\n"
508 "   :arg hard: Specifies whether returned turbulence is hard (sharp transitions) or soft (smooth transitions).\n"
509 "   :type hard: boolean\n"
510 BPY_NOISE_BASIS_ENUM_DOC
511 "   :arg amplitude_scale: The amplitude scaling factor.\n"
512 "   :type amplitude_scale: float\n"
513 "   :arg frequency_scale: The frequency scaling factor\n"
514 "   :type frequency_scale: float\n"
515 "   :return: The turbulence value.\n"
516 "   :rtype: float\n"
517 );
518 static PyObject *M_Noise_turbulence(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
519 {
520         static const char *kwlist[] = {"", "", "", "noise_basis", "amplitude_scale", "frequency_scale", NULL};
521         PyObject *value;
522         float vec[3];
523         const char *noise_basis_str = NULL;
524         int oct, hd, noise_basis_enum = DEFAULT_NOISE_TYPE;
525         float as = 0.5f, fs = 2.0f;
526
527         if (!PyArg_ParseTupleAndKeywords(
528                     args, kw, "Oii|$sff:turbulence", (char **)kwlist,
529                     &value, &oct, &hd, &noise_basis_str, &as, &fs))
530         {
531                 return NULL;
532         }
533
534         if (!noise_basis_str) {
535                 /* pass through */
536         }
537         else if (PyC_FlagSet_ValueFromID(
538                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "turbulence") == -1)
539         {
540                 return NULL;
541         }
542
543         if (mathutils_array_parse(vec, 3, 3, value, "turbulence: invalid 'position' arg") == -1)
544                 return NULL;
545
546         return PyFloat_FromDouble(turb(vec[0], vec[1], vec[2], oct, hd, noise_basis_enum, as, fs));
547 }
548
549 PyDoc_STRVAR(M_Noise_turbulence_vector_doc,
550 ".. function:: turbulence_vector(position, octaves, hard, noise_basis='PERLIN_ORIGINAL', amplitude_scale=0.5, frequency_scale=2.0)\n"
551 "\n"
552 "   Returns the turbulence vector from the noise basis at the specified position.\n"
553 "\n"
554 "   :arg position: The position to evaluate the selected noise function.\n"
555 "   :type position: :class:`mathutils.Vector`\n"
556 "   :arg octaves: The number of different noise frequencies used.\n"
557 "   :type octaves: int\n"
558 "   :arg hard: Specifies whether returned turbulence is hard (sharp transitions) or soft (smooth transitions).\n"
559 "   :type hard: :boolean\n"
560 BPY_NOISE_BASIS_ENUM_DOC
561 "   :arg amplitude_scale: The amplitude scaling factor.\n"
562 "   :type amplitude_scale: float\n"
563 "   :arg frequency_scale: The frequency scaling factor\n"
564 "   :type frequency_scale: float\n"
565 "   :return: The turbulence vector.\n"
566 "   :rtype: :class:`mathutils.Vector`\n"
567 );
568 static PyObject *M_Noise_turbulence_vector(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
569 {
570         static const char *kwlist[] = {"", "", "", "noise_basis", "amplitude_scale", "frequency_scale", NULL};
571         PyObject *value;
572         float vec[3], r_vec[3];
573         const char *noise_basis_str = NULL;
574         int oct, hd, noise_basis_enum = DEFAULT_NOISE_TYPE;
575         float as = 0.5f, fs = 2.0f;
576
577         if (!PyArg_ParseTupleAndKeywords(
578                     args, kw, "Oii|$sff:turbulence_vector", (char **)kwlist,
579                     &value, &oct, &hd, &noise_basis_str, &as, &fs))
580         {
581                 return NULL;
582         }
583
584         if (!noise_basis_str) {
585                 /* pass through */
586         }
587         else if (PyC_FlagSet_ValueFromID(
588                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "turbulence_vector") == -1)
589         {
590                 return NULL;
591         }
592
593         if (mathutils_array_parse(vec, 3, 3, value, "turbulence_vector: invalid 'position' arg") == -1)
594                 return NULL;
595
596         vTurb(vec[0], vec[1], vec[2], oct, hd, noise_basis_enum, as, fs, r_vec);
597
598         return Vector_CreatePyObject(r_vec, 3, NULL);
599 }
600
601 /* F. Kenton Musgrave's fractal functions */
602 PyDoc_STRVAR(M_Noise_fractal_doc,
603 ".. function:: fractal(position, H, lacunarity, octaves, noise_basis='PERLIN_ORIGINAL')\n"
604 "\n"
605 "   Returns the fractal Brownian motion (fBm) noise value from the noise basis at the specified position.\n"
606 "\n"
607 "   :arg position: The position to evaluate the selected noise function.\n"
608 "   :type position: :class:`mathutils.Vector`\n"
609 "   :arg H: The fractal increment factor.\n"
610 "   :type H: float\n"
611 "   :arg lacunarity: The gap between successive frequencies.\n"
612 "   :type lacunarity: float\n"
613 "   :arg octaves: The number of different noise frequencies used.\n"
614 "   :type octaves: int\n"
615 BPY_NOISE_BASIS_ENUM_DOC
616 "   :return: The fractal Brownian motion noise value.\n"
617 "   :rtype: float\n"
618 );
619 static PyObject *M_Noise_fractal(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
620 {
621         static const char *kwlist[] = {"", "", "", "", "noise_basis", NULL};
622         PyObject *value;
623         float vec[3];
624         const char *noise_basis_str = NULL;
625         float H, lac, oct;
626         int noise_basis_enum = DEFAULT_NOISE_TYPE;
627
628         if (!PyArg_ParseTupleAndKeywords(
629                     args, kw, "Offf|$s:fractal", (char **)kwlist,
630                     &value, &H, &lac, &oct, &noise_basis_str))
631         {
632                 return NULL;
633         }
634
635         if (!noise_basis_str) {
636                 /* pass through */
637         }
638         else if (PyC_FlagSet_ValueFromID(
639                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "fractal") == -1)
640         {
641                 return NULL;
642         }
643
644         if (mathutils_array_parse(vec, 3, 3, value, "fractal: invalid 'position' arg") == -1)
645                 return NULL;
646
647         return PyFloat_FromDouble(mg_fBm(vec[0], vec[1], vec[2], H, lac, oct, noise_basis_enum));
648 }
649
650 PyDoc_STRVAR(M_Noise_multi_fractal_doc,
651 ".. function:: multi_fractal(position, H, lacunarity, octaves, noise_basis='PERLIN_ORIGINAL')\n"
652 "\n"
653 "   Returns multifractal noise value from the noise basis at the specified position.\n"
654 "\n"
655 "   :arg position: The position to evaluate the selected noise function.\n"
656 "   :type position: :class:`mathutils.Vector`\n"
657 "   :arg H: The fractal increment factor.\n"
658 "   :type H: float\n"
659 "   :arg lacunarity: The gap between successive frequencies.\n"
660 "   :type lacunarity: float\n"
661 "   :arg octaves: The number of different noise frequencies used.\n"
662 "   :type octaves: int\n"
663 BPY_NOISE_BASIS_ENUM_DOC
664 "   :return: The multifractal noise value.\n"
665 "   :rtype: float\n"
666 );
667 static PyObject *M_Noise_multi_fractal(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
668 {
669         static const char *kwlist[] = {"", "", "", "", "noise_basis", NULL};
670         PyObject *value;
671         float vec[3];
672         const char *noise_basis_str = NULL;
673         float H, lac, oct;
674         int noise_basis_enum = DEFAULT_NOISE_TYPE;
675
676         if (!PyArg_ParseTupleAndKeywords(
677                     args, kw, "Offf|$s:multi_fractal", (char **)kwlist,
678                     &value, &H, &lac, &oct, &noise_basis_str))
679         {
680                 return NULL;
681         }
682
683         if (!noise_basis_str) {
684                 /* pass through */
685         }
686         else if (PyC_FlagSet_ValueFromID(
687                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "multi_fractal") == -1)
688         {
689                 return NULL;
690         }
691
692         if (mathutils_array_parse(vec, 3, 3, value, "multi_fractal: invalid 'position' arg") == -1)
693                 return NULL;
694
695         return PyFloat_FromDouble(mg_MultiFractal(vec[0], vec[1], vec[2], H, lac, oct, noise_basis_enum));
696 }
697
698 PyDoc_STRVAR(M_Noise_variable_lacunarity_doc,
699 ".. function:: variable_lacunarity(position, distortion, noise_type1='PERLIN_ORIGINAL', noise_type2='PERLIN_ORIGINAL')\n"
700 "\n"
701 "   Returns variable lacunarity noise value, a distorted variety of noise, from noise type 1 distorted by noise type 2 at the specified position.\n"
702 "\n"
703 "   :arg position: The position to evaluate the selected noise function.\n"
704 "   :type position: :class:`mathutils.Vector`\n"
705 "   :arg distortion: The amount of distortion.\n"
706 "   :type distortion: float\n"
707 "   :arg noise_type1: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', " \
708                                                                         "'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', " \
709                                                                         "'CELLNOISE'].\n"
710 "   :type noise_type1: string\n"
711 "   :arg noise_type2: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', " \
712                                                                         "'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', " \
713                                                                         "'CELLNOISE'].\n"
714 "   :type noise_type2: string\n"
715 "   :return: The variable lacunarity noise value.\n"
716 "   :rtype: float\n"
717 );
718 static PyObject *M_Noise_variable_lacunarity(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
719 {
720         static const char *kwlist[] = {"", "", "noise_type1", "noise_type2", NULL};
721         PyObject *value;
722         float vec[3];
723         const char *noise_type1_str = NULL, *noise_type2_str = NULL;
724         float d;
725         int noise_type1_enum = DEFAULT_NOISE_TYPE, noise_type2_enum = DEFAULT_NOISE_TYPE;
726
727         if (!PyArg_ParseTupleAndKeywords(
728                     args, kw, "Of|$ss:variable_lacunarity", (char **)kwlist,
729                     &value, &d, &noise_type1_str, &noise_type2_str))
730         {
731                 return NULL;
732         }
733
734         if (!noise_type1_str) {
735                 /* pass through */
736         }
737         else if (PyC_FlagSet_ValueFromID(
738                          bpy_noise_types, noise_type1_str, &noise_type1_enum, "variable_lacunarity") == -1)
739         {
740                 return NULL;
741         }
742
743         if (!noise_type2_str) {
744                 /* pass through */
745         }
746         else if (PyC_FlagSet_ValueFromID(
747                          bpy_noise_types, noise_type2_str, &noise_type2_enum, "variable_lacunarity") == -1)
748         {
749                 return NULL;
750         }
751
752         if (mathutils_array_parse(vec, 3, 3, value, "variable_lacunarity: invalid 'position' arg") == -1)
753                 return NULL;
754
755         return PyFloat_FromDouble(mg_VLNoise(vec[0], vec[1], vec[2], d, noise_type1_enum, noise_type2_enum));
756 }
757
758 PyDoc_STRVAR(M_Noise_hetero_terrain_doc,
759 ".. function:: hetero_terrain(position, H, lacunarity, octaves, offset, noise_basis='PERLIN_ORIGINAL')\n"
760 "\n"
761 "   Returns the heterogeneous terrain value from the noise basis at the specified position.\n"
762 "\n"
763 "   :arg position: The position to evaluate the selected noise function.\n"
764 "   :type position: :class:`mathutils.Vector`\n"
765 "   :arg H: The fractal dimension of the roughest areas.\n"
766 "   :type H: float\n"
767 "   :arg lacunarity: The gap between successive frequencies.\n"
768 "   :type lacunarity: float\n"
769 "   :arg octaves: The number of different noise frequencies used.\n"
770 "   :type octaves: int\n"
771 "   :arg offset: The height of the terrain above 'sea level'.\n"
772 "   :type offset: float\n"
773 BPY_NOISE_BASIS_ENUM_DOC
774 "   :return: The heterogeneous terrain value.\n"
775 "   :rtype: float\n"
776 );
777 static PyObject *M_Noise_hetero_terrain(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
778 {
779         static const char *kwlist[] = {"", "", "", "", "", "noise_basis", NULL};
780         PyObject *value;
781         float vec[3];
782         const char *noise_basis_str = NULL;
783         float H, lac, oct, ofs;
784         int noise_basis_enum = DEFAULT_NOISE_TYPE;
785
786         if (!PyArg_ParseTupleAndKeywords(
787                     args, kw, "Offff|$s:hetero_terrain", (char **)kwlist,
788                     &value, &H, &lac, &oct, &ofs, &noise_basis_str))
789         {
790                 return NULL;
791         }
792
793         if (!noise_basis_str) {
794                 /* pass through */
795         }
796         else if (PyC_FlagSet_ValueFromID(
797                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "hetero_terrain") == -1)
798         {
799                 return NULL;
800         }
801
802         if (mathutils_array_parse(vec, 3, 3, value, "hetero_terrain: invalid 'position' arg") == -1)
803                 return NULL;
804
805         return PyFloat_FromDouble(mg_HeteroTerrain(vec[0], vec[1], vec[2], H, lac, oct, ofs, noise_basis_enum));
806 }
807
808 PyDoc_STRVAR(M_Noise_hybrid_multi_fractal_doc,
809 ".. function:: hybrid_multi_fractal(position, H, lacunarity, octaves, offset, gain, noise_basis='PERLIN_ORIGINAL')\n"
810 "\n"
811 "   Returns hybrid multifractal value from the noise basis at the specified position.\n"
812 "\n"
813 "   :arg position: The position to evaluate the selected noise function.\n"
814 "   :type position: :class:`mathutils.Vector`\n"
815 "   :arg H: The fractal dimension of the roughest areas.\n"
816 "   :type H: float\n"
817 "   :arg lacunarity: The gap between successive frequencies.\n"
818 "   :type lacunarity: float\n"
819 "   :arg octaves: The number of different noise frequencies used.\n"
820 "   :type octaves: int\n"
821 "   :arg offset: The height of the terrain above 'sea level'.\n"
822 "   :type offset: float\n"
823 "   :arg gain: Scaling applied to the values.\n"
824 "   :type gain: float\n"
825 BPY_NOISE_BASIS_ENUM_DOC
826 "   :return: The hybrid multifractal value.\n"
827 "   :rtype: float\n"
828 );
829 static PyObject *M_Noise_hybrid_multi_fractal(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
830 {
831         static const char *kwlist[] = {"", "", "", "", "", "", "noise_basis", NULL};
832         PyObject *value;
833         float vec[3];
834         const char *noise_basis_str = NULL;
835         float H, lac, oct, ofs, gn;
836         int noise_basis_enum = DEFAULT_NOISE_TYPE;
837
838         if (!PyArg_ParseTupleAndKeywords(
839                     args, kw, "Offfff|$s:hybrid_multi_fractal", (char **)kwlist,
840                     &value, &H, &lac, &oct, &ofs, &gn, &noise_basis_str))
841         {
842                 return NULL;
843         }
844
845         if (!noise_basis_str) {
846                 /* pass through */
847         }
848         else if (PyC_FlagSet_ValueFromID(
849                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "hybrid_multi_fractal") == -1)
850         {
851                 return NULL;
852         }
853
854         if (mathutils_array_parse(vec, 3, 3, value, "hybrid_multi_fractal: invalid 'position' arg") == -1)
855                 return NULL;
856
857         return PyFloat_FromDouble(mg_HybridMultiFractal(vec[0], vec[1], vec[2], H, lac, oct, ofs, gn, noise_basis_enum));
858 }
859
860 PyDoc_STRVAR(M_Noise_ridged_multi_fractal_doc,
861 ".. function:: ridged_multi_fractal(position, H, lacunarity, octaves, offset, gain, noise_basis='PERLIN_ORIGINAL')\n"
862 "\n"
863 "   Returns ridged multifractal value from the noise basis at the specified position.\n"
864 "\n"
865 "   :arg position: The position to evaluate the selected noise function.\n"
866 "   :type position: :class:`mathutils.Vector`\n"
867 "   :arg H: The fractal dimension of the roughest areas.\n"
868 "   :type H: float\n"
869 "   :arg lacunarity: The gap between successive frequencies.\n"
870 "   :type lacunarity: float\n"
871 "   :arg octaves: The number of different noise frequencies used.\n"
872 "   :type octaves: int\n"
873 "   :arg offset: The height of the terrain above 'sea level'.\n"
874 "   :type offset: float\n"
875 "   :arg gain: Scaling applied to the values.\n"
876 "   :type gain: float\n"
877 BPY_NOISE_BASIS_ENUM_DOC
878 "   :return: The ridged multifractal value.\n"
879 "   :rtype: float\n"
880 );
881 static PyObject *M_Noise_ridged_multi_fractal(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
882 {
883         static const char *kwlist[] = {"", "", "", "", "", "", "noise_basis", NULL};
884         PyObject *value;
885         float vec[3];
886         const char *noise_basis_str = NULL;
887         float H, lac, oct, ofs, gn;
888         int noise_basis_enum = DEFAULT_NOISE_TYPE;
889
890         if (!PyArg_ParseTupleAndKeywords(
891                     args, kw, "Offfff|$s:ridged_multi_fractal", (char **)kwlist,
892                     &value, &H, &lac, &oct, &ofs, &gn, &noise_basis_str))
893         {
894                 return NULL;
895         }
896
897         if (!noise_basis_str) {
898                 /* pass through */
899         }
900         else if (PyC_FlagSet_ValueFromID(
901                          bpy_noise_types, noise_basis_str, &noise_basis_enum, "ridged_multi_fractal") == -1)
902         {
903                 return NULL;
904         }
905
906         if (mathutils_array_parse(vec, 3, 3, value, "ridged_multi_fractal: invalid 'position' arg") == -1)
907                 return NULL;
908
909         return PyFloat_FromDouble(mg_RidgedMultiFractal(vec[0], vec[1], vec[2], H, lac, oct, ofs, gn, noise_basis_enum));
910 }
911
912 PyDoc_STRVAR(M_Noise_voronoi_doc,
913 ".. function:: voronoi(position, distance_metric='DISTANCE', exponent=2.5)\n"
914 "\n"
915 "   Returns a list of distances to the four closest features and their locations.\n"
916 "\n"
917 "   :arg position: The position to evaluate the selected noise function.\n"
918 "   :type position: :class:`mathutils.Vector`\n"
919 BPY_NOISE_METRIC_ENUM_DOC
920 "   :arg exponent: The exponent for Minkowski distance metric.\n"
921 "   :type exponent: float\n"
922 "   :return: A list of distances to the four closest features and their locations.\n"
923 "   :rtype: list of four floats, list of four :class:`mathutils.Vector` types\n"
924 );
925 static PyObject *M_Noise_voronoi(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
926 {
927         static const char *kwlist[] = {"", "distance_metric", "exponent", NULL};
928         PyObject *value;
929         PyObject *list;
930         PyObject *ret;
931         float vec[3];
932         const char *metric_str = NULL;
933         float da[4], pa[12];
934         int metric_enum = DEFAULT_METRIC_TYPE;
935         float me = 2.5f;  /* default minkowski exponent */
936
937         int i;
938
939         if (!PyArg_ParseTupleAndKeywords(
940                     args, kw, "O|$sf:voronoi", (char **)kwlist,
941                     &value, &metric_str, &me))
942         {
943                 return NULL;
944         }
945
946         if (!metric_str) {
947                 /* pass through */
948         }
949         else if (PyC_FlagSet_ValueFromID(
950                          bpy_noise_metrics, metric_str, &metric_enum, "voronoi") == -1)
951         {
952                 return NULL;
953         }
954
955         if (mathutils_array_parse(vec, 3, 3, value, "voronoi: invalid 'position' arg") == -1)
956                 return NULL;
957
958         list = PyList_New(4);
959
960         voronoi(vec[0], vec[1], vec[2], da, pa, me, metric_enum);
961
962         for (i = 0; i < 4; i++) {
963                 PyObject *v = Vector_CreatePyObject(pa + 3 * i, 3, NULL);
964                 PyList_SET_ITEM(list, i, v);
965         }
966
967         ret = Py_BuildValue("[[ffff]O]", da[0], da[1], da[2], da[3], list);
968         Py_DECREF(list);
969         return ret;
970 }
971
972 PyDoc_STRVAR(M_Noise_cell_doc,
973 ".. function:: cell(position)\n"
974 "\n"
975 "   Returns cell noise value at the specified position.\n"
976 "\n"
977 "   :arg position: The position to evaluate the selected noise function.\n"
978 "   :type position: :class:`mathutils.Vector`\n"
979 "   :return: The cell noise value.\n"
980 "   :rtype: float\n"
981 );
982 static PyObject *M_Noise_cell(PyObject *UNUSED(self), PyObject *args)
983 {
984         PyObject *value;
985         float vec[3];
986
987         if (!PyArg_ParseTuple(args, "O:cell", &value))
988                 return NULL;
989
990         if (mathutils_array_parse(vec, 3, 3, value, "cell: invalid 'position' arg") == -1)
991                 return NULL;
992
993         return PyFloat_FromDouble(cellNoise(vec[0], vec[1], vec[2]));
994 }
995
996 PyDoc_STRVAR(M_Noise_cell_vector_doc,
997 ".. function:: cell_vector(position)\n"
998 "\n"
999 "   Returns cell noise vector at the specified position.\n"
1000 "\n"
1001 "   :arg position: The position to evaluate the selected noise function.\n"
1002 "   :type position: :class:`mathutils.Vector`\n"
1003 "   :return: The cell noise vector.\n"
1004 "   :rtype: :class:`mathutils.Vector`\n"
1005 );
1006 static PyObject *M_Noise_cell_vector(PyObject *UNUSED(self), PyObject *args)
1007 {
1008         PyObject *value;
1009         float vec[3], r_vec[3];
1010
1011         if (!PyArg_ParseTuple(args, "O:cell_vector", &value))
1012                 return NULL;
1013
1014         if (mathutils_array_parse(vec, 3, 3, value, "cell_vector: invalid 'position' arg") == -1)
1015                 return NULL;
1016
1017         cellNoiseV(vec[0], vec[1], vec[2], r_vec);
1018         return Vector_CreatePyObject(r_vec, 3, NULL);
1019 }
1020
1021 static PyMethodDef M_Noise_methods[] = {
1022         {"seed_set", (PyCFunction) M_Noise_seed_set, METH_VARARGS, M_Noise_seed_set_doc},
1023         {"random", (PyCFunction) M_Noise_random, METH_NOARGS, M_Noise_random_doc},
1024         {"random_unit_vector", (PyCFunction) M_Noise_random_unit_vector, METH_VARARGS | METH_KEYWORDS, M_Noise_random_unit_vector_doc},
1025         {"random_vector", (PyCFunction) M_Noise_random_vector, METH_VARARGS | METH_KEYWORDS, M_Noise_random_vector_doc},
1026         {"noise", (PyCFunction) M_Noise_noise, METH_VARARGS | METH_KEYWORDS, M_Noise_noise_doc},
1027         {"noise_vector", (PyCFunction) M_Noise_noise_vector, METH_VARARGS | METH_KEYWORDS, M_Noise_noise_vector_doc},
1028         {"turbulence", (PyCFunction) M_Noise_turbulence, METH_VARARGS | METH_KEYWORDS, M_Noise_turbulence_doc},
1029         {"turbulence_vector", (PyCFunction) M_Noise_turbulence_vector, METH_VARARGS | METH_KEYWORDS, M_Noise_turbulence_vector_doc},
1030         {"fractal", (PyCFunction) M_Noise_fractal, METH_VARARGS | METH_KEYWORDS, M_Noise_fractal_doc},
1031         {"multi_fractal", (PyCFunction) M_Noise_multi_fractal, METH_VARARGS | METH_KEYWORDS, M_Noise_multi_fractal_doc},
1032         {"variable_lacunarity", (PyCFunction) M_Noise_variable_lacunarity, METH_VARARGS | METH_KEYWORDS, M_Noise_variable_lacunarity_doc},
1033         {"hetero_terrain", (PyCFunction) M_Noise_hetero_terrain, METH_VARARGS | METH_KEYWORDS, M_Noise_hetero_terrain_doc},
1034         {"hybrid_multi_fractal", (PyCFunction) M_Noise_hybrid_multi_fractal, METH_VARARGS | METH_KEYWORDS, M_Noise_hybrid_multi_fractal_doc},
1035         {"ridged_multi_fractal", (PyCFunction) M_Noise_ridged_multi_fractal, METH_VARARGS | METH_KEYWORDS, M_Noise_ridged_multi_fractal_doc},
1036         {"voronoi", (PyCFunction) M_Noise_voronoi, METH_VARARGS | METH_KEYWORDS, M_Noise_voronoi_doc},
1037         {"cell", (PyCFunction) M_Noise_cell, METH_VARARGS, M_Noise_cell_doc},
1038         {"cell_vector", (PyCFunction) M_Noise_cell_vector, METH_VARARGS, M_Noise_cell_vector_doc},
1039         {NULL, NULL, 0, NULL},
1040 };
1041
1042 static struct PyModuleDef M_Noise_module_def = {
1043         PyModuleDef_HEAD_INIT,
1044         "mathutils.noise",  /* m_name */
1045         M_Noise_doc,  /* m_doc */
1046         0,     /* m_size */
1047         M_Noise_methods,  /* m_methods */
1048         NULL,  /* m_reload */
1049         NULL,  /* m_traverse */
1050         NULL,  /* m_clear */
1051         NULL,  /* m_free */
1052 };
1053
1054 /*----------------------------MODULE INIT-------------------------*/
1055 PyMODINIT_FUNC PyInit_mathutils_noise(void)
1056 {
1057         PyObject *submodule = PyModule_Create(&M_Noise_module_def);
1058
1059         /* use current time as seed for random number generator by default */
1060         setRndSeed(0);
1061
1062         return submodule;
1063 }