ClangFormat: apply to source, most of intern
[blender.git] / intern / cycles / kernel / kernel_montecarlo.h
1 /*
2  * Parts 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 #ifndef __KERNEL_MONTECARLO_CL__
34 #define __KERNEL_MONTECARLO_CL__
35
36 CCL_NAMESPACE_BEGIN
37
38 /* distribute uniform xy on [0,1] over unit disk [-1,1] */
39 ccl_device void to_unit_disk(float *x, float *y)
40 {
41   float phi = M_2PI_F * (*x);
42   float r = sqrtf(*y);
43
44   *x = r * cosf(phi);
45   *y = r * sinf(phi);
46 }
47
48 /* return an orthogonal tangent and bitangent given a normal and tangent that
49  * may not be exactly orthogonal */
50 ccl_device void make_orthonormals_tangent(const float3 N, const float3 T, float3 *a, float3 *b)
51 {
52   *b = normalize(cross(N, T));
53   *a = cross(*b, N);
54 }
55
56 /* sample direction with cosine weighted distributed in hemisphere */
57 ccl_device_inline void sample_cos_hemisphere(
58     const float3 N, float randu, float randv, float3 *omega_in, float *pdf)
59 {
60   to_unit_disk(&randu, &randv);
61   float costheta = sqrtf(max(1.0f - randu * randu - randv * randv, 0.0f));
62   float3 T, B;
63   make_orthonormals(N, &T, &B);
64   *omega_in = randu * T + randv * B + costheta * N;
65   *pdf = costheta * M_1_PI_F;
66 }
67
68 /* sample direction uniformly distributed in hemisphere */
69 ccl_device_inline void sample_uniform_hemisphere(
70     const float3 N, float randu, float randv, float3 *omega_in, float *pdf)
71 {
72   float z = randu;
73   float r = sqrtf(max(0.0f, 1.0f - z * z));
74   float phi = M_2PI_F * randv;
75   float x = r * cosf(phi);
76   float y = r * sinf(phi);
77
78   float3 T, B;
79   make_orthonormals(N, &T, &B);
80   *omega_in = x * T + y * B + z * N;
81   *pdf = 0.5f * M_1_PI_F;
82 }
83
84 /* sample direction uniformly distributed in cone */
85 ccl_device_inline void sample_uniform_cone(
86     const float3 N, float angle, float randu, float randv, float3 *omega_in, float *pdf)
87 {
88   float z = cosf(angle * randu);
89   float r = sqrtf(max(0.0f, 1.0f - z * z));
90   float phi = M_2PI_F * randv;
91   float x = r * cosf(phi);
92   float y = r * sinf(phi);
93
94   float3 T, B;
95   make_orthonormals(N, &T, &B);
96   *omega_in = x * T + y * B + z * N;
97   *pdf = 0.5f * M_1_PI_F / (1.0f - cosf(angle));
98 }
99
100 /* sample uniform point on the surface of a sphere */
101 ccl_device float3 sample_uniform_sphere(float u1, float u2)
102 {
103   float z = 1.0f - 2.0f * u1;
104   float r = sqrtf(fmaxf(0.0f, 1.0f - z * z));
105   float phi = M_2PI_F * u2;
106   float x = r * cosf(phi);
107   float y = r * sinf(phi);
108
109   return make_float3(x, y, z);
110 }
111
112 ccl_device float balance_heuristic(float a, float b)
113 {
114   return (a) / (a + b);
115 }
116
117 ccl_device float balance_heuristic_3(float a, float b, float c)
118 {
119   return (a) / (a + b + c);
120 }
121
122 ccl_device float power_heuristic(float a, float b)
123 {
124   return (a * a) / (a * a + b * b);
125 }
126
127 ccl_device float power_heuristic_3(float a, float b, float c)
128 {
129   return (a * a) / (a * a + b * b + c * c);
130 }
131
132 ccl_device float max_heuristic(float a, float b)
133 {
134   return (a > b) ? 1.0f : 0.0f;
135 }
136
137 /* distribute uniform xy on [0,1] over unit disk [-1,1], with concentric mapping
138  * to better preserve stratification for some RNG sequences */
139 ccl_device float2 concentric_sample_disk(float u1, float u2)
140 {
141   float phi, r;
142   float a = 2.0f * u1 - 1.0f;
143   float b = 2.0f * u2 - 1.0f;
144
145   if (a == 0.0f && b == 0.0f) {
146     return make_float2(0.0f, 0.0f);
147   }
148   else if (a * a > b * b) {
149     r = a;
150     phi = M_PI_4_F * (b / a);
151   }
152   else {
153     r = b;
154     phi = M_PI_2_F - M_PI_4_F * (a / b);
155   }
156
157   return make_float2(r * cosf(phi), r * sinf(phi));
158 }
159
160 /* sample point in unit polygon with given number of corners and rotation */
161 ccl_device float2 regular_polygon_sample(float corners, float rotation, float u, float v)
162 {
163   /* sample corner number and reuse u */
164   float corner = floorf(u * corners);
165   u = u * corners - corner;
166
167   /* uniform sampled triangle weights */
168   u = sqrtf(u);
169   v = v * u;
170   u = 1.0f - u;
171
172   /* point in triangle */
173   float angle = M_PI_F / corners;
174   float2 p = make_float2((u + v) * cosf(angle), (u - v) * sinf(angle));
175
176   /* rotate */
177   rotation += corner * 2.0f * angle;
178
179   float cr = cosf(rotation);
180   float sr = sinf(rotation);
181
182   return make_float2(cr * p.x - sr * p.y, sr * p.x + cr * p.y);
183 }
184
185 ccl_device float3 ensure_valid_reflection(float3 Ng, float3 I, float3 N)
186 {
187   float3 R = 2 * dot(N, I) * N - I;
188
189   /* Reflection rays may always be at least as shallow as the incoming ray. */
190   float threshold = min(0.9f * dot(Ng, I), 0.01f);
191   if (dot(Ng, R) >= threshold) {
192     return N;
193   }
194
195   /* Form coordinate system with Ng as the Z axis and N inside the X-Z-plane.
196    * The X axis is found by normalizing the component of N that's orthogonal to Ng.
197    * The Y axis isn't actually needed.
198    */
199   float NdotNg = dot(N, Ng);
200   float3 X = normalize(N - NdotNg * Ng);
201
202   /* Calculate N.z and N.x in the local coordinate system.
203    *
204    * The goal of this computation is to find a N' that is rotated towards Ng just enough
205    * to lift R' above the threshold (here called t), therefore dot(R', Ng) = t.
206    *
207    * According to the standard reflection equation, this means that we want dot(2*dot(N', I)*N' - I, Ng) = t.
208    *
209    * Since the Z axis of our local coordinate system is Ng, dot(x, Ng) is just x.z, so we get 2*dot(N', I)*N'.z - I.z = t.
210    *
211    * The rotation is simple to express in the coordinate system we formed - since N lies in the X-Z-plane, we know that
212    * N' will also lie in the X-Z-plane, so N'.y = 0 and therefore dot(N', I) = N'.x*I.x + N'.z*I.z .
213    *
214    * Furthermore, we want N' to be normalized, so N'.x = sqrt(1 - N'.z^2).
215    *
216    * With these simplifications, we get the final equation 2*(sqrt(1 - N'.z^2)*I.x + N'.z*I.z)*N'.z - I.z = t.
217    *
218    * The only unknown here is N'.z, so we can solve for that.
219    *
220    * The equation has four solutions in general:
221    *
222    * N'.z = +-sqrt(0.5*(+-sqrt(I.x^2*(I.x^2 + I.z^2 - t^2)) + t*I.z + I.x^2 + I.z^2)/(I.x^2 + I.z^2))
223    * We can simplify this expression a bit by grouping terms:
224    *
225    * a = I.x^2 + I.z^2
226    * b = sqrt(I.x^2 * (a - t^2))
227    * c = I.z*t + a
228    * N'.z = +-sqrt(0.5*(+-b + c)/a)
229    *
230    * Two solutions can immediately be discarded because they're negative so N' would lie in the lower hemisphere.
231    */
232   float Ix = dot(I, X), Iz = dot(I, Ng);
233   float Ix2 = sqr(Ix), Iz2 = sqr(Iz);
234   float a = Ix2 + Iz2;
235
236   float b = safe_sqrtf(Ix2 * (a - sqr(threshold)));
237   float c = Iz * threshold + a;
238
239   /* Evaluate both solutions.
240    * In many cases one can be immediately discarded (if N'.z would be imaginary or larger than one), so check for that first.
241    * If no option is viable (might happen in extreme cases like N being in the wrong hemisphere), give up and return Ng. */
242   float fac = 0.5f / a;
243   float N1_z2 = fac * (b + c), N2_z2 = fac * (-b + c);
244   bool valid1 = (N1_z2 > 1e-5f) && (N1_z2 <= (1.0f + 1e-5f));
245   bool valid2 = (N2_z2 > 1e-5f) && (N2_z2 <= (1.0f + 1e-5f));
246
247   float2 N_new;
248   if (valid1 && valid2) {
249     /* If both are possible, do the expensive reflection-based check. */
250     float2 N1 = make_float2(safe_sqrtf(1.0f - N1_z2), safe_sqrtf(N1_z2));
251     float2 N2 = make_float2(safe_sqrtf(1.0f - N2_z2), safe_sqrtf(N2_z2));
252
253     float R1 = 2 * (N1.x * Ix + N1.y * Iz) * N1.y - Iz;
254     float R2 = 2 * (N2.x * Ix + N2.y * Iz) * N2.y - Iz;
255
256     valid1 = (R1 >= 1e-5f);
257     valid2 = (R2 >= 1e-5f);
258     if (valid1 && valid2) {
259       /* If both solutions are valid, return the one with the shallower reflection since it will be closer to the input
260        * (if the original reflection wasn't shallow, we would not be in this part of the function). */
261       N_new = (R1 < R2) ? N1 : N2;
262     }
263     else {
264       /* If only one reflection is valid (= positive), pick that one. */
265       N_new = (R1 > R2) ? N1 : N2;
266     }
267   }
268   else if (valid1 || valid2) {
269     /* Only one solution passes the N'.z criterium, so pick that one. */
270     float Nz2 = valid1 ? N1_z2 : N2_z2;
271     N_new = make_float2(safe_sqrtf(1.0f - Nz2), safe_sqrtf(Nz2));
272   }
273   else {
274     return Ng;
275   }
276
277   return N_new.x * X + N_new.y * Ng;
278 }
279
280 CCL_NAMESPACE_END
281
282 #endif /* __KERNEL_MONTECARLO_CL__ */