style cleanup: block comments
[blender.git] / intern / cycles / kernel / svm / svm_noise.h
1 /*
2  * Adapted from Open Shading Language with this license:
3  *
4  * Copyright (c) 2009-2010 Sony Pictures Imageworks Inc., et al.
5  * All Rights Reserved.
6  *
7  * Modifications Copyright 2011, Blender Foundation.
8  * 
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are
11  * met:
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in the
16  *   documentation and/or other materials provided with the distribution.
17  * * Neither the name of Sony Pictures Imageworks nor the names of its
18  *   contributors may be used to endorse or promote products derived from
19  *   this software without specific prior written permission.
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 CCL_NAMESPACE_BEGIN
34
35 __device int quick_floor(float x)
36 {
37         return (int)x - ((x < 0) ? 1 : 0);
38 }
39
40 __device float bits_to_01(uint bits)
41 {
42         return bits * (1.0f/(float)0xFFFFFFFF);
43 }
44
45 __device uint hash(uint kx, uint ky, uint kz)
46 {
47         // define some handy macros
48 #define rot(x,k) (((x)<<(k)) | ((x)>>(32-(k))))
49 #define final(a,b,c) \
50 { \
51         c ^= b; c -= rot(b,14); \
52         a ^= c; a -= rot(c,11); \
53         b ^= a; b -= rot(a,25); \
54         c ^= b; c -= rot(b,16); \
55         a ^= c; a -= rot(c,4);  \
56         b ^= a; b -= rot(a,14); \
57         c ^= b; c -= rot(b,24); \
58 }
59         // now hash the data!
60         uint a, b, c, len = 3;
61         a = b = c = 0xdeadbeef + (len << 2) + 13;
62
63         c += kz;
64         b += ky;
65         a += kx;
66         final(a, b, c);
67
68         return c;
69         // macros not needed anymore
70 #undef rot
71 #undef final
72 }
73
74 __device int imod(int a, int b)
75 {
76         a %= b;
77         return a < 0 ? a + b : a;
78 }
79
80 __device uint phash(int kx, int ky, int kz, int3 p) 
81 {
82         return hash(imod(kx, p.x), imod(ky, p.y), imod(kz, p.z));
83 }
84
85 __device float floorfrac(float x, int* i)
86 {
87     float f = floorf(x);
88     *i = (int)f;
89     return x - f;
90 }
91
92 __device float fade(float t)
93 {
94         return t * t * t * (t * (t * 6.0f - 15.0f) + 10.0f);
95 }
96
97 __device float nerp(float t, float a, float b)
98 {
99     return (1.0f - t) * a + t * b;
100 }
101
102 __device float grad(int hash, float x, float y, float z)
103 {
104         // use vectors pointing to the edges of the cube
105         int h = hash & 15;
106         float u = h<8 ? x : y;
107         float v = h<4 ? y : h==12||h==14 ? x : z;
108         return ((h&1) ? -u : u) + ((h&2) ? -v : v);
109 }
110
111 __device float scale3(float result)
112 {
113         return 0.9820f * result;
114 }
115
116 __device_noinline float perlin(float x, float y, float z)
117 {
118         int X; float fx = floorfrac(x, &X);
119         int Y; float fy = floorfrac(y, &Y);
120         int Z; float fz = floorfrac(z, &Z);
121
122         float u = fade(fx);
123         float v = fade(fy);
124         float w = fade(fz);
125
126         float result;
127
128         result = nerp (w, nerp (v, nerp (u, grad (hash (X  , Y  , Z  ), fx       , fy    , fz     ),
129                                                                                 grad (hash (X+1, Y  , Z  ), fx-1.0f, fy  , fz     )),
130                                                            nerp (u, grad (hash (X  , Y+1, Z  ), fx       , fy-1.0f, fz    ),
131                                                                                 grad (hash (X+1, Y+1, Z  ), fx-1.0f, fy-1.0f, fz          ))),
132                                           nerp (v, nerp (u, grad (hash (X  , Y  , Z+1), fx       , fy    , fz-1.0f ),
133                                                                                 grad (hash (X+1, Y  , Z+1), fx-1.0f, fy  , fz-1.0f )),
134                                                            nerp (u, grad (hash (X  , Y+1, Z+1), fx       , fy-1.0f, fz-1.0f ),
135                                                                                 grad (hash (X+1, Y+1, Z+1), fx-1.0f, fy-1.0f, fz-1.0f ))));
136         return scale3(result);
137 }
138
139 __device_noinline float perlin_periodic(float x, float y, float z, float3 pperiod)
140 {
141         int X; float fx = floorfrac(x, &X);
142         int Y; float fy = floorfrac(y, &Y);
143         int Z; float fz = floorfrac(z, &Z);
144
145         int3 p;
146
147         p.x = max(quick_floor(pperiod.x), 1);
148         p.y = max(quick_floor(pperiod.y), 1);
149         p.z = max(quick_floor(pperiod.z), 1);
150
151         float u = fade(fx);
152         float v = fade(fy);
153         float w = fade(fz);
154
155         float result;
156
157         result = nerp (w, nerp (v, nerp (u, grad (phash (X  , Y  , Z  , p), fx   , fy    , fz     ),
158                                                                                 grad (phash (X+1, Y  , Z  , p), fx-1.0f, fy      , fz     )),
159                                                            nerp (u, grad (phash (X  , Y+1, Z  , p), fx   , fy-1.0f, fz    ),
160                                                                                 grad (phash (X+1, Y+1, Z  , p), fx-1.0f, fy-1.0f, fz      ))),
161                                           nerp (v, nerp (u, grad (phash (X  , Y  , Z+1, p), fx   , fy    , fz-1.0f ),
162                                                                                 grad (phash (X+1, Y  , Z+1, p), fx-1.0f, fy      , fz-1.0f )),
163                                                            nerp (u, grad (phash (X  , Y+1, Z+1, p), fx   , fy-1.0f, fz-1.0f ),
164                                                                                 grad (phash (X+1, Y+1, Z+1, p), fx-1.0f, fy-1.0f, fz-1.0f ))));
165         return scale3(result);
166 }
167
168 /* perlin noise in range 0..1 */
169 __device float noise(float3 p)
170 {
171         float r = perlin(p.x, p.y, p.z);
172         return 0.5f*r + 0.5f;
173 }
174
175 /* perlin noise in range -1..1 */
176 __device float snoise(float3 p)
177 {
178         return perlin(p.x, p.y, p.z);
179 }
180
181 /* cell noise */
182 __device_noinline float cellnoise(float3 p)
183 {
184         uint ix = quick_floor(p.x);
185         uint iy = quick_floor(p.y);
186         uint iz = quick_floor(p.z);
187
188         return bits_to_01(hash(ix, iy, iz));
189 }
190
191 __device float3 cellnoise_color(float3 p)
192 {
193         float r = cellnoise(p);
194         float g = cellnoise(make_float3(p.y, p.x, p.z));
195         float b = cellnoise(make_float3(p.y, p.z, p.x));
196
197         return make_float3(r, g, b);
198 }
199
200 /* periodic perlin noise in range 0..1 */
201 __device float pnoise(float3 p, float3 pperiod)
202 {
203         float r = perlin_periodic(p.x, p.y, p.z, pperiod);
204         return 0.5f*r + 0.5f;
205 }
206
207 /* periodic perlin noise in range -1..1 */
208 __device float psnoise(float3 p, float3 pperiod)
209 {
210         return perlin_periodic(p.x, p.y, p.z, pperiod);
211 }
212
213 CCL_NAMESPACE_END
214