Cycles: Code cleanup, spaces around keywords
[blender-staging.git] / intern / cycles / kernel / kernel_jitter.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /* TODO(sergey): Consider moving portable ctz/clz stuff to util. */
18
19 CCL_NAMESPACE_BEGIN
20
21 /* "Correlated Multi-Jittered Sampling"
22  * Andrew Kensler, Pixar Technical Memo 13-01, 2013 */
23
24 /* todo: find good value, suggested 64 gives pattern on cornell box ceiling */
25 #define CMJ_RANDOM_OFFSET_LIMIT 4096
26
27 ccl_device_inline bool cmj_is_pow2(int i)
28 {
29         return (i & (i - 1)) == 0;
30 }
31
32 ccl_device_inline int cmj_fast_mod_pow2(int a, int b)
33 {
34         return (a & (b - 1));
35 }
36
37 /* a must be > 0 and b must be > 1 */
38 ccl_device_inline int cmj_fast_div_pow2(int a, int b)
39 {
40         kernel_assert(a > 0);
41         kernel_assert(b > 1);
42 #if defined(__KERNEL_SSE2__)
43 #  ifdef _MSC_VER
44         unsigned long ctz;
45         _BitScanForward(&ctz, b);
46         return a >> ctz;
47 #  else
48         return a >> __builtin_ctz(b);
49 #  endif
50 #elif defined(__KERNEL_CUDA__)
51         return a >> (__ffs(b) - 1);
52 #else
53         return a/b;
54 #endif
55 }
56
57 ccl_device_inline uint cmj_w_mask(uint w)
58 {
59         kernel_assert(w > 1);
60 #if defined(__KERNEL_SSE2__)
61 #  ifdef _MSC_VER
62         unsigned long leading_zero;
63         _BitScanReverse(&leading_zero, w);
64         return ((1 << (1 + leading_zero)) - 1);
65 #  else
66         return ((1 << (32 - __builtin_clz(w))) - 1);
67 #  endif
68 #elif defined(__KERNEL_CUDA__)
69         return ((1 << (32 - __clz(w))) - 1);
70 #else
71         w |= w >> 1;
72         w |= w >> 2;
73         w |= w >> 4;
74         w |= w >> 8;
75         w |= w >> 16;
76
77         return w;
78 #endif
79 }
80
81 ccl_device_inline uint cmj_permute(uint i, uint l, uint p)
82 {
83         uint w = l - 1;
84
85         if((l & w) == 0) {
86                 /* l is a power of two (fast) */
87                 i ^= p;
88                 i *= 0xe170893d;
89                 i ^= p >> 16;
90                 i ^= (i & w) >> 4;
91                 i ^= p >> 8;
92                 i *= 0x0929eb3f;
93                 i ^= p >> 23;
94                 i ^= (i & w) >> 1;
95                 i *= 1 | p >> 27;
96                 i *= 0x6935fa69;
97                 i ^= (i & w) >> 11;
98                 i *= 0x74dcb303;
99                 i ^= (i & w) >> 2;
100                 i *= 0x9e501cc3;
101                 i ^= (i & w) >> 2;
102                 i *= 0xc860a3df;
103                 i &= w;
104                 i ^= i >> 5;
105
106                 return (i + p) & w;
107         }
108         else {
109                 /* l is not a power of two (slow) */
110                 w = cmj_w_mask(w);
111
112                 do {
113                         i ^= p;
114                         i *= 0xe170893d;
115                         i ^= p >> 16;
116                         i ^= (i & w) >> 4;
117                         i ^= p >> 8;
118                         i *= 0x0929eb3f;
119                         i ^= p >> 23;
120                         i ^= (i & w) >> 1;
121                         i *= 1 | p >> 27;
122                         i *= 0x6935fa69;
123                         i ^= (i & w) >> 11;
124                         i *= 0x74dcb303;
125                         i ^= (i & w) >> 2;
126                         i *= 0x9e501cc3;
127                         i ^= (i & w) >> 2;
128                         i *= 0xc860a3df;
129                         i &= w;
130                         i ^= i >> 5;
131                 } while(i >= l);
132
133                 return (i + p) % l;
134         }
135 }
136
137 ccl_device_inline uint cmj_hash(uint i, uint p)
138 {
139         i ^= p;
140         i ^= i >> 17;
141         i ^= i >> 10;
142         i *= 0xb36534e5;
143         i ^= i >> 12;
144         i ^= i >> 21;
145         i *= 0x93fc4795;
146         i ^= 0xdf6e307f;
147         i ^= i >> 17;
148         i *= 1 | p >> 18;
149
150         return i;
151 }
152
153 ccl_device_inline float cmj_randfloat(uint i, uint p)
154 {
155         return cmj_hash(i, p) * (1.0f / 4294967808.0f);
156 }
157
158 #ifdef __CMJ__
159 ccl_device float cmj_sample_1D(int s, int N, int p)
160 {
161         kernel_assert(s < N);
162
163         uint x = cmj_permute(s, N, p * 0x68bc21eb);
164         float jx = cmj_randfloat(s, p * 0x967a889b);
165
166         float invN = 1.0f/N;
167         return (x + jx)*invN;
168 }
169
170 ccl_device void cmj_sample_2D(int s, int N, int p, float *fx, float *fy)
171 {
172         kernel_assert(s < N);
173
174 #if defined(__KERNEL_CUDA__)
175         int m = float_to_int(__fsqrt_ru(N));
176 #else
177         int m = float_to_int(sqrtf(N));
178 #endif
179         int n = (N + m - 1)/m;
180         float invN = 1.0f/N;
181         float invm = 1.0f/m;
182         float invn = 1.0f/n;
183
184         s = cmj_permute(s, N, p * 0x51633e2d);
185
186         int sdivm, smodm;
187
188         if(cmj_is_pow2(m)) {
189                 sdivm = cmj_fast_div_pow2(s, m);
190                 smodm = cmj_fast_mod_pow2(s, m);
191         }
192         else {
193                 /* Doing s*inmv gives precision issues here. */
194                 sdivm = s / m;
195                 smodm = s - sdivm*m;
196         }
197
198         uint sx = cmj_permute(smodm, m, p * 0x68bc21eb);
199         uint sy = cmj_permute(sdivm, n, p * 0x02e5be93);
200
201         float jx = cmj_randfloat(s, p * 0x967a889b);
202         float jy = cmj_randfloat(s, p * 0x368cc8b7);
203
204         *fx = (sx + (sy + jx)*invn)*invm;
205         *fy = (s + jy)*invN;
206 }
207 #endif
208
209 CCL_NAMESPACE_END
210