Cycles: Improve denoising speed on GPUs with small tile sizes
[blender.git] / intern / cycles / util / util_math.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 #ifndef __UTIL_MATH_H__
18 #define __UTIL_MATH_H__
19
20 /* Math
21  *
22  * Basic math functions on scalar and vector types. This header is used by
23  * both the kernel code when compiled as C++, and other C++ non-kernel code. */
24
25 #ifndef __KERNEL_GPU__
26 #  include <cmath>
27 #endif
28
29
30 #ifndef __KERNEL_OPENCL__
31 #  include <float.h>
32 #  include <math.h>
33 #  include <stdio.h>
34 #endif  /* __KERNEL_OPENCL__ */
35
36 #include "util/util_types.h"
37
38 CCL_NAMESPACE_BEGIN
39
40 /* Float Pi variations */
41
42 /* Division */
43 #ifndef M_PI_F
44 #  define M_PI_F    (3.1415926535897932f)  /* pi */
45 #endif
46 #ifndef M_PI_2_F
47 #  define M_PI_2_F  (1.5707963267948966f)  /* pi/2 */
48 #endif
49 #ifndef M_PI_4_F
50 #  define M_PI_4_F  (0.7853981633974830f)  /* pi/4 */
51 #endif
52 #ifndef M_1_PI_F
53 #  define M_1_PI_F  (0.3183098861837067f)  /* 1/pi */
54 #endif
55 #ifndef M_2_PI_F
56 #  define M_2_PI_F  (0.6366197723675813f)  /* 2/pi */
57 #endif
58
59 /* Multiplication */
60 #ifndef M_2PI_F
61 #  define M_2PI_F   (6.2831853071795864f)  /* 2*pi */
62 #endif
63 #ifndef M_4PI_F
64 #  define M_4PI_F   (12.566370614359172f)  /* 4*pi */
65 #endif
66
67 /* Float sqrt variations */
68 #ifndef M_SQRT2_F
69 #  define M_SQRT2_F (1.4142135623730950f)  /* sqrt(2) */
70 #endif
71 #ifndef M_LN2_F
72 #  define M_LN2_F   (0.6931471805599453f)  /* ln(2) */
73 #endif
74 #ifndef M_LN10_F
75 #  define M_LN10_F  (2.3025850929940457f)  /* ln(10) */
76 #endif
77
78 /* Scalar */
79
80 #ifdef _WIN32
81 #  ifndef __KERNEL_OPENCL__
82 ccl_device_inline float fmaxf(float a, float b)
83 {
84         return (a > b)? a: b;
85 }
86
87 ccl_device_inline float fminf(float a, float b)
88 {
89         return (a < b)? a: b;
90 }
91 #  endif  /* !__KERNEL_OPENCL__ */
92 #endif  /* _WIN32 */
93
94 #ifndef __KERNEL_GPU__
95 using std::isfinite;
96 using std::isnan;
97 using std::sqrt;
98
99 ccl_device_inline int abs(int x)
100 {
101         return (x > 0)? x: -x;
102 }
103
104 ccl_device_inline int max(int a, int b)
105 {
106         return (a > b)? a: b;
107 }
108
109 ccl_device_inline int min(int a, int b)
110 {
111         return (a < b)? a: b;
112 }
113
114 ccl_device_inline float max(float a, float b)
115 {
116         return (a > b)? a: b;
117 }
118
119 ccl_device_inline float min(float a, float b)
120 {
121         return (a < b)? a: b;
122 }
123
124 ccl_device_inline double max(double a, double b)
125 {
126         return (a > b)? a: b;
127 }
128
129 ccl_device_inline double min(double a, double b)
130 {
131         return (a < b)? a: b;
132 }
133
134 /* These 2 guys are templated for usage with registers data.
135  *
136  * NOTE: Since this is CPU-only functions it is ok to use references here.
137  * But for other devices we'll need to be careful about this.
138  */
139
140 template<typename T>
141 ccl_device_inline T min4(const T& a, const T& b, const T& c, const T& d)
142 {
143         return min(min(a,b),min(c,d));
144 }
145
146 template<typename T>
147 ccl_device_inline T max4(const T& a, const T& b, const T& c, const T& d)
148 {
149         return max(max(a,b),max(c,d));
150 }
151 #endif /* __KERNEL_GPU__ */
152
153 ccl_device_inline float min4(float a, float b, float c, float d)
154 {
155         return min(min(a, b), min(c, d));
156 }
157
158 ccl_device_inline float max4(float a, float b, float c, float d)
159 {
160         return max(max(a, b), max(c, d));
161 }
162
163 #ifndef __KERNEL_OPENCL__
164 /* Int/Float conversion */
165
166 ccl_device_inline int as_int(uint i)
167 {
168         union { uint ui; int i; } u;
169         u.ui = i;
170         return u.i;
171 }
172
173 ccl_device_inline uint as_uint(int i)
174 {
175         union { uint ui; int i; } u;
176         u.i = i;
177         return u.ui;
178 }
179
180 ccl_device_inline uint as_uint(float f)
181 {
182         union { uint i; float f; } u;
183         u.f = f;
184         return u.i;
185 }
186
187 ccl_device_inline int __float_as_int(float f)
188 {
189         union { int i; float f; } u;
190         u.f = f;
191         return u.i;
192 }
193
194 ccl_device_inline float __int_as_float(int i)
195 {
196         union { int i; float f; } u;
197         u.i = i;
198         return u.f;
199 }
200
201 ccl_device_inline uint __float_as_uint(float f)
202 {
203         union { uint i; float f; } u;
204         u.f = f;
205         return u.i;
206 }
207
208 ccl_device_inline float __uint_as_float(uint i)
209 {
210         union { uint i; float f; } u;
211         u.i = i;
212         return u.f;
213 }
214 #endif /* __KERNEL_OPENCL__ */
215
216 /* Versions of functions which are safe for fast math. */
217 ccl_device_inline bool isnan_safe(float f)
218 {
219         unsigned int x = __float_as_uint(f);
220         return (x << 1) > 0xff000000u;
221 }
222
223 ccl_device_inline bool isfinite_safe(float f)
224 {
225         /* By IEEE 754 rule, 2*Inf equals Inf */
226         unsigned int x = __float_as_uint(f);
227         return (f == f) && (x == 0 || x == (1u << 31) || (f != 2.0f*f)) && !((x << 1) > 0xff000000u);
228 }
229
230 ccl_device_inline float ensure_finite(float v)
231 {
232         return isfinite_safe(v)? v : 0.0f;
233 }
234
235 #ifndef __KERNEL_OPENCL__
236 ccl_device_inline int clamp(int a, int mn, int mx)
237 {
238         return min(max(a, mn), mx);
239 }
240
241 ccl_device_inline float clamp(float a, float mn, float mx)
242 {
243         return min(max(a, mn), mx);
244 }
245
246 ccl_device_inline float mix(float a, float b, float t)
247 {
248     return a + t*(b - a);
249 }
250 #endif  /* __KERNEL_OPENCL__ */
251
252 #ifndef __KERNEL_CUDA__
253 ccl_device_inline float saturate(float a)
254 {
255         return clamp(a, 0.0f, 1.0f);
256 }
257 #endif  /* __KERNEL_CUDA__ */
258
259 ccl_device_inline int float_to_int(float f)
260 {
261         return (int)f;
262 }
263
264 ccl_device_inline int floor_to_int(float f)
265 {
266         return float_to_int(floorf(f));
267 }
268
269 ccl_device_inline int ceil_to_int(float f)
270 {
271         return float_to_int(ceilf(f));
272 }
273
274 ccl_device_inline float signf(float f)
275 {
276         return (f < 0.0f)? -1.0f: 1.0f;
277 }
278
279 ccl_device_inline float nonzerof(float f, float eps)
280 {
281         if(fabsf(f) < eps)
282                 return signf(f)*eps;
283         else
284                 return f;
285 }
286
287 ccl_device_inline float smoothstepf(float f)
288 {
289         float ff = f*f;
290         return (3.0f*ff - 2.0f*ff*f);
291 }
292
293 ccl_device_inline int mod(int x, int m)
294 {
295         return (x % m + m) % m;
296 }
297
298 ccl_device_inline float3 float2_to_float3(const float2 a)
299 {
300         return make_float3(a.x, a.y, 0.0f);
301 }
302
303 ccl_device_inline float3 float4_to_float3(const float4 a)
304 {
305         return make_float3(a.x, a.y, a.z);
306 }
307
308 ccl_device_inline float4 float3_to_float4(const float3 a)
309 {
310         return make_float4(a.x, a.y, a.z, 1.0f);
311 }
312
313 CCL_NAMESPACE_END
314
315 #include "util/util_math_int2.h"
316 #include "util/util_math_int3.h"
317 #include "util/util_math_int4.h"
318
319 #include "util/util_math_float2.h"
320 #include "util/util_math_float3.h"
321 #include "util/util_math_float4.h"
322
323 #include "util/util_rect.h"
324
325 CCL_NAMESPACE_BEGIN
326
327 #ifndef __KERNEL_OPENCL__
328 /* Interpolation */
329
330 template<class A, class B> A lerp(const A& a, const A& b, const B& t)
331 {
332         return (A)(a * ((B)1 - t) + b * t);
333 }
334
335 #endif  /* __KERNEL_OPENCL__ */
336
337 /* Triangle */
338
339 #ifndef __KERNEL_OPENCL__
340 ccl_device_inline float triangle_area(const float3& v1,
341                                       const float3& v2,
342                                       const float3& v3)
343 #else
344 ccl_device_inline float triangle_area(const float3 v1,
345                                       const float3 v2,
346                                       const float3 v3)
347 #endif
348 {
349         return len(cross(v3 - v2, v1 - v2))*0.5f;
350 }
351
352 /* Orthonormal vectors */
353
354 ccl_device_inline void make_orthonormals(const float3 N, float3 *a, float3 *b)
355 {
356 #if 0
357         if(fabsf(N.y) >= 0.999f) {
358                 *a = make_float3(1, 0, 0);
359                 *b = make_float3(0, 0, 1);
360                 return;
361         }
362         if(fabsf(N.z) >= 0.999f) {
363                 *a = make_float3(1, 0, 0);
364                 *b = make_float3(0, 1, 0);
365                 return;
366         }
367 #endif
368
369         if(N.x != N.y || N.x != N.z)
370                 *a = make_float3(N.z-N.y, N.x-N.z, N.y-N.x);  //(1,1,1)x N
371         else
372                 *a = make_float3(N.z-N.y, N.x+N.z, -N.y-N.x);  //(-1,1,1)x N
373
374         *a = normalize(*a);
375         *b = cross(N, *a);
376 }
377
378 /* Color division */
379
380 ccl_device_inline float3 safe_invert_color(float3 a)
381 {
382         float x, y, z;
383
384         x = (a.x != 0.0f)? 1.0f/a.x: 0.0f;
385         y = (a.y != 0.0f)? 1.0f/a.y: 0.0f;
386         z = (a.z != 0.0f)? 1.0f/a.z: 0.0f;
387
388         return make_float3(x, y, z);
389 }
390
391 ccl_device_inline float3 safe_divide_color(float3 a, float3 b)
392 {
393         float x, y, z;
394
395         x = (b.x != 0.0f)? a.x/b.x: 0.0f;
396         y = (b.y != 0.0f)? a.y/b.y: 0.0f;
397         z = (b.z != 0.0f)? a.z/b.z: 0.0f;
398
399         return make_float3(x, y, z);
400 }
401
402 ccl_device_inline float3 safe_divide_even_color(float3 a, float3 b)
403 {
404         float x, y, z;
405
406         x = (b.x != 0.0f)? a.x/b.x: 0.0f;
407         y = (b.y != 0.0f)? a.y/b.y: 0.0f;
408         z = (b.z != 0.0f)? a.z/b.z: 0.0f;
409
410         /* try to get gray even if b is zero */
411         if(b.x == 0.0f) {
412                 if(b.y == 0.0f) {
413                         x = z;
414                         y = z;
415                 }
416                 else if(b.z == 0.0f) {
417                         x = y;
418                         z = y;
419                 }
420                 else
421                         x = 0.5f*(y + z);
422         }
423         else if(b.y == 0.0f) {
424                 if(b.z == 0.0f) {
425                         y = x;
426                         z = x;
427                 }
428                 else
429                         y = 0.5f*(x + z);
430         }
431         else if(b.z == 0.0f) {
432                 z = 0.5f*(x + y);
433         }
434
435         return make_float3(x, y, z);
436 }
437
438 /* Rotation of point around axis and angle */
439
440 ccl_device_inline float3 rotate_around_axis(float3 p, float3 axis, float angle)
441 {
442         float costheta = cosf(angle);
443         float sintheta = sinf(angle);
444         float3 r;
445
446         r.x = ((costheta + (1 - costheta) * axis.x * axis.x) * p.x) +
447               (((1 - costheta) * axis.x * axis.y - axis.z * sintheta) * p.y) +
448               (((1 - costheta) * axis.x * axis.z + axis.y * sintheta) * p.z);
449
450         r.y = (((1 - costheta) * axis.x * axis.y + axis.z * sintheta) * p.x) +
451               ((costheta + (1 - costheta) * axis.y * axis.y) * p.y) +
452              (((1 - costheta) * axis.y * axis.z - axis.x * sintheta) * p.z);
453
454         r.z = (((1 - costheta) * axis.x * axis.z - axis.y * sintheta) * p.x) +
455               (((1 - costheta) * axis.y * axis.z + axis.x * sintheta) * p.y) +
456               ((costheta + (1 - costheta) * axis.z * axis.z) * p.z);
457
458         return r;
459 }
460
461 /* NaN-safe math ops */
462
463 ccl_device_inline float safe_sqrtf(float f)
464 {
465         return sqrtf(max(f, 0.0f));
466 }
467
468 ccl_device float safe_asinf(float a)
469 {
470         return asinf(clamp(a, -1.0f, 1.0f));
471 }
472
473 ccl_device float safe_acosf(float a)
474 {
475         return acosf(clamp(a, -1.0f, 1.0f));
476 }
477
478 ccl_device float compatible_powf(float x, float y)
479 {
480 #ifdef __KERNEL_GPU__
481         if(y == 0.0f) /* x^0 -> 1, including 0^0 */
482                 return 1.0f;
483
484         /* GPU pow doesn't accept negative x, do manual checks here */
485         if(x < 0.0f) {
486                 if(fmodf(-y, 2.0f) == 0.0f)
487                         return powf(-x, y);
488                 else
489                         return -powf(-x, y);
490         }
491         else if(x == 0.0f)
492                 return 0.0f;
493 #endif
494         return powf(x, y);
495 }
496
497 ccl_device float safe_powf(float a, float b)
498 {
499         if(UNLIKELY(a < 0.0f && b != float_to_int(b)))
500                 return 0.0f;
501
502         return compatible_powf(a, b);
503 }
504
505 ccl_device float safe_divide(float a, float b)
506 {
507         return (b != 0.0f)? a/b: 0.0f;
508 }
509
510 ccl_device float safe_logf(float a, float b)
511 {
512         if(UNLIKELY(a <= 0.0f || b <= 0.0f))
513                 return 0.0f;
514
515         return safe_divide(logf(a),logf(b));
516 }
517
518 ccl_device float safe_modulo(float a, float b)
519 {
520         return (b != 0.0f)? fmodf(a, b): 0.0f;
521 }
522
523 ccl_device_inline float sqr(float a)
524 {
525         return a * a;
526 }
527
528 ccl_device_inline float beta(float x, float y)
529 {
530 #ifndef __KERNEL_OPENCL__
531         return expf(lgammaf(x) + lgammaf(y) - lgammaf(x+y));
532 #else
533         return expf(lgamma(x) + lgamma(y) - lgamma(x+y));
534 #endif
535 }
536
537 ccl_device_inline float xor_signmask(float x, int y)
538 {
539         return __int_as_float(__float_as_int(x) ^ y);
540 }
541
542 /* projections */
543 ccl_device_inline float2 map_to_tube(const float3 co)
544 {
545         float len, u, v;
546         len = sqrtf(co.x * co.x + co.y * co.y);
547         if(len > 0.0f) {
548                 u = (1.0f - (atan2f(co.x / len, co.y / len) / M_PI_F)) * 0.5f;
549                 v = (co.z + 1.0f) * 0.5f;
550         }
551         else {
552                 u = v = 0.0f;
553         }
554         return make_float2(u, v);
555 }
556
557 ccl_device_inline float2 map_to_sphere(const float3 co)
558 {
559         float l = len(co);
560         float u, v;
561         if(l > 0.0f) {
562                 if(UNLIKELY(co.x == 0.0f && co.y == 0.0f)) {
563                         u = 0.0f;  /* othwise domain error */
564                 }
565                 else {
566                         u = (1.0f - atan2f(co.x, co.y) / M_PI_F) / 2.0f;
567                 }
568                 v = 1.0f - safe_acosf(co.z / l) / M_PI_F;
569         }
570         else {
571                 u = v = 0.0f;
572         }
573         return make_float2(u, v);
574 }
575
576 CCL_NAMESPACE_END
577
578 #endif /* __UTIL_MATH_H__ */