Cycles :
[blender.git] / intern / cycles / kernel / kernel_light.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 CCL_NAMESPACE_BEGIN
20
21 /* Light Sample result */
22
23 typedef struct LightSample {
24         float3 P;                       /* position on light, or direction for distant light */
25         float3 Ng;                      /* normal on light */
26         float3 D;                       /* direction from shading point to light */
27         float t;                        /* distance to light (FLT_MAX for distant light) */
28         float pdf;                      /* light sampling probability density function */
29         float eval_fac;         /* intensity multiplier */
30         int object;                     /* object id for triangle/curve lights */
31         int prim;                       /* primitive id for triangle/curve ligths */
32         int shader;                     /* shader id */
33         int lamp;                       /* lamp id */
34         LightType type;         /* type of light */
35 } LightSample;
36
37 /* Background Light */
38
39 #ifdef __BACKGROUND_MIS__
40
41 __device float3 background_light_sample(KernelGlobals *kg, float randu, float randv, float *pdf)
42 {
43         /* for the following, the CDF values are actually a pair of floats, with the
44          * function value as X and the actual CDF as Y.  The last entry's function
45          * value is the CDF total. */
46         int res = kernel_data.integrator.pdf_background_res;
47         int cdf_count = res + 1;
48
49         /* this is basically std::lower_bound as used by pbrt */
50         int first = 0;
51         int count = res;
52
53         while(count > 0) {
54                 int step = count >> 1;
55                 int middle = first + step;
56
57                 if(kernel_tex_fetch(__light_background_marginal_cdf, middle).y < randv) {
58                         first = middle + 1;
59                         count -= step + 1;
60                 }
61                 else
62                         count = step;
63         }
64
65         int index_v = max(0, first - 1);
66         kernel_assert(index_v >= 0 && index_v < res);
67
68         float2 cdf_v = kernel_tex_fetch(__light_background_marginal_cdf, index_v);
69         float2 cdf_next_v = kernel_tex_fetch(__light_background_marginal_cdf, index_v + 1);
70         float2 cdf_last_v = kernel_tex_fetch(__light_background_marginal_cdf, res);
71
72         /* importance-sampled V direction */
73         float dv = (randv - cdf_v.y) / (cdf_next_v.y - cdf_v.y);
74         float v = (index_v + dv) / res;
75
76         /* this is basically std::lower_bound as used by pbrt */
77         first = 0;
78         count = res;
79         while(count > 0) {
80                 int step = count >> 1;
81                 int middle = first + step;
82
83                 if(kernel_tex_fetch(__light_background_conditional_cdf, index_v * cdf_count + middle).y < randu) {
84                         first = middle + 1;
85                         count -= step + 1;
86                 }
87                 else
88                         count = step;
89         }
90
91         int index_u = max(0, first - 1);
92         kernel_assert(index_u >= 0 && index_u < res);
93
94         float2 cdf_u = kernel_tex_fetch(__light_background_conditional_cdf, index_v * cdf_count + index_u);
95         float2 cdf_next_u = kernel_tex_fetch(__light_background_conditional_cdf, index_v * cdf_count + index_u + 1);
96         float2 cdf_last_u = kernel_tex_fetch(__light_background_conditional_cdf, index_v * cdf_count + res);
97
98         /* importance-sampled U direction */
99         float du = (randu - cdf_u.y) / (cdf_next_u.y - cdf_u.y);
100         float u = (index_u + du) / res;
101
102         /* compute pdf */
103         float denom = cdf_last_u.x * cdf_last_v.x;
104         float sin_theta = sinf(M_PI_F * v);
105
106         if(sin_theta == 0.0f || denom == 0.0f)
107                 *pdf = 0.0f;
108         else
109                 *pdf = (cdf_u.x * cdf_v.x)/(M_2PI_F * M_PI_F * sin_theta * denom);
110
111         *pdf *= kernel_data.integrator.pdf_lights;
112
113         /* compute direction */
114         return -equirectangular_to_direction(u, v);
115 }
116
117 __device float background_light_pdf(KernelGlobals *kg, float3 direction)
118 {
119         float2 uv = direction_to_equirectangular(direction);
120         int res = kernel_data.integrator.pdf_background_res;
121
122         float sin_theta = sinf(uv.y * M_PI_F);
123
124         if(sin_theta == 0.0f)
125                 return 0.0f;
126
127         int index_u = clamp((int)(uv.x * res), 0, res - 1);
128         int index_v = clamp((int)(uv.y * res), 0, res - 1);
129
130         /* pdfs in V direction */
131         float2 cdf_last_u = kernel_tex_fetch(__light_background_conditional_cdf, index_v * (res + 1) + res);
132         float2 cdf_last_v = kernel_tex_fetch(__light_background_marginal_cdf, res);
133
134         float denom = cdf_last_u.x * cdf_last_v.x;
135
136         if(denom == 0.0f)
137                 return 0.0f;
138
139         /* pdfs in U direction */
140         float2 cdf_u = kernel_tex_fetch(__light_background_conditional_cdf, index_v * (res + 1) + index_u);
141         float2 cdf_v = kernel_tex_fetch(__light_background_marginal_cdf, index_v);
142
143         float pdf = (cdf_u.x * cdf_v.x)/(M_2PI_F * M_PI_F * sin_theta * denom);
144
145         return pdf * kernel_data.integrator.pdf_lights;
146 }
147 #endif
148
149 /* Regular Light */
150
151 __device float3 disk_light_sample(float3 v, float randu, float randv)
152 {
153         float3 ru, rv;
154
155         make_orthonormals(v, &ru, &rv);
156         to_unit_disk(&randu, &randv);
157
158         return ru*randu + rv*randv;
159 }
160
161 __device float3 distant_light_sample(float3 D, float radius, float randu, float randv)
162 {
163         return normalize(D + disk_light_sample(D, randu, randv)*radius);
164 }
165
166 __device float3 sphere_light_sample(float3 P, float3 center, float radius, float randu, float randv)
167 {
168         return disk_light_sample(normalize(P - center), randu, randv)*radius;
169 }
170
171 __device float3 area_light_sample(float3 axisu, float3 axisv, float randu, float randv)
172 {
173         randu = randu - 0.5f;
174         randv = randv - 0.5f;
175
176         return axisu*randu + axisv*randv;
177 }
178
179 __device float spot_light_attenuation(float4 data1, float4 data2, LightSample *ls)
180 {
181         float3 dir = make_float3(data2.y, data2.z, data2.w);
182         float3 I = ls->Ng;
183
184         float spot_angle = data1.w;
185         float spot_smooth = data2.x;
186
187         float attenuation = dot(dir, I);
188
189         if(attenuation <= spot_angle) {
190                 attenuation = 0.0f;
191         }
192         else {
193                 float t = attenuation - spot_angle;
194
195                 if(t < spot_smooth && spot_smooth != 0.0f)
196                         attenuation *= smoothstepf(t/spot_smooth);
197         }
198
199         return attenuation;
200 }
201
202 __device float lamp_light_pdf(KernelGlobals *kg, const float3 Ng, const float3 I, float t)
203 {
204         float cos_pi = dot(Ng, I);
205
206         if(cos_pi <= 0.0f)
207                 return 0.0f;
208         
209         return t*t/cos_pi;
210 }
211
212 __device void lamp_light_sample(KernelGlobals *kg, int lamp,
213         float randu, float randv, float3 P, LightSample *ls)
214 {
215         float4 data0 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 0);
216         float4 data1 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 1);
217
218         LightType type = (LightType)__float_as_int(data0.x);
219         ls->type = type;
220         ls->shader = __float_as_int(data1.x);
221         ls->object = ~0;
222         ls->prim = ~0;
223         ls->lamp = lamp;
224
225         if(type == LIGHT_DISTANT) {
226                 /* distant light */
227                 float3 lightD = make_float3(data0.y, data0.z, data0.w);
228                 float3 D = lightD;
229                 float radius = data1.y;
230                 float invarea = data1.w;
231
232                 if(radius > 0.0f)
233                         D = distant_light_sample(D, radius, randu, randv);
234
235                 ls->P = D;
236                 ls->Ng = D;
237                 ls->D = -D;
238                 ls->t = FLT_MAX;
239
240                 float costheta = dot(lightD, D);
241                 ls->pdf = invarea/(costheta*costheta*costheta);
242                 ls->eval_fac = ls->pdf*kernel_data.integrator.inv_pdf_lights;
243         }
244 #ifdef __BACKGROUND_MIS__
245         else if(type == LIGHT_BACKGROUND) {
246                 /* infinite area light (e.g. light dome or env light) */
247                 float3 D = background_light_sample(kg, randu, randv, &ls->pdf);
248
249                 ls->P = D;
250                 ls->Ng = D;
251                 ls->D = -D;
252                 ls->t = FLT_MAX;
253                 ls->eval_fac = 1.0f;
254         }
255 #endif
256         else {
257                 ls->P = make_float3(data0.y, data0.z, data0.w);
258
259                 if(type == LIGHT_POINT || type == LIGHT_SPOT) {
260                         float radius = data1.y;
261
262                         if(radius > 0.0f)
263                                 /* sphere light */
264                                 ls->P += sphere_light_sample(P, ls->P, radius, randu, randv);
265
266                         ls->D = normalize_len(ls->P - P, &ls->t);
267                         ls->Ng = -ls->D;
268
269                         float invarea = data1.z;
270                         ls->eval_fac = (0.25f*M_1_PI_F)*invarea;
271                         ls->pdf = invarea;
272
273                         if(type == LIGHT_SPOT) {
274                                 /* spot light attentuation */
275                                 float4 data2 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 2);
276                                 ls->eval_fac *= spot_light_attenuation(data1, data2, ls);
277                         }
278                 }
279                 else {
280                         /* area light */
281                         float4 data2 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 2);
282                         float4 data3 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 3);
283
284                         float3 axisu = make_float3(data1.y, data1.z, data1.w);
285                         float3 axisv = make_float3(data2.y, data2.z, data2.w);
286                         float3 D = make_float3(data3.y, data3.z, data3.w);
287
288                         ls->P += area_light_sample(axisu, axisv, randu, randv);
289                         ls->Ng = D;
290                         ls->D = normalize_len(ls->P - P, &ls->t);
291
292                         float invarea = data2.x;
293
294                         ls->eval_fac = 0.25f*invarea;
295                         ls->pdf = invarea;
296                 }
297
298                 ls->eval_fac *= kernel_data.integrator.inv_pdf_lights;
299                 ls->pdf *= lamp_light_pdf(kg, ls->Ng, -ls->D, ls->t);
300         }
301 }
302
303 __device bool lamp_light_eval(KernelGlobals *kg, int lamp, float3 P, float3 D, float t, LightSample *ls)
304 {
305         float4 data0 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 0);
306         float4 data1 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 1);
307
308         LightType type = (LightType)__float_as_int(data0.x);
309         ls->type = type;
310         ls->shader = __float_as_int(data1.x);
311         ls->object = ~0;
312         ls->prim = ~0;
313         ls->lamp = lamp;
314
315         if(!(ls->shader & SHADER_USE_MIS))
316                 return false;
317
318         if(type == LIGHT_DISTANT) {
319                 /* distant light */
320                 float radius = data1.y;
321
322                 if(radius == 0.0f)
323                         return false;
324                 if(t != FLT_MAX)
325                         return false;
326
327                 /* a distant light is infinitely far away, but equivalent to a disk
328                  * shaped light exactly 1 unit away from the current shading point.
329                  *
330                  *     radius              t^2/cos(theta)
331                  *  <---------->           t = sqrt(1^2 + tan(theta)^2)
332                  *       tan(th)           area = radius*radius*pi
333                  *       <----->
334                  *        \    |           (1 + tan(theta)^2)/cos(theta)
335                  *         \   |           (1 + tan(acos(cos(theta)))^2)/cos(theta)
336                  *       t  \th| 1         simplifies to
337                  *           \-|           1/(cos(theta)^3)
338                  *            \|           magic!
339                  *             P
340                  */
341
342                 float3 lightD = make_float3(data0.y, data0.z, data0.w);
343                 float costheta = dot(-lightD, D);
344                 float cosangle = data1.z;
345
346                 if(costheta < cosangle)
347                         return false;
348
349                 ls->P = -D;
350                 ls->Ng = -D;
351                 ls->D = D;
352                 ls->t = FLT_MAX;
353
354                 float invarea = data1.w;
355                 ls->pdf = invarea/(costheta*costheta*costheta);
356                 ls->eval_fac = ls->pdf;
357         }
358         else if(type == LIGHT_POINT || type == LIGHT_SPOT) {
359                 float3 lightP = make_float3(data0.y, data0.z, data0.w);
360                 float radius = data1.y;
361
362                 /* sphere light */
363                 if(radius == 0.0f)
364                         return false;
365
366                 if(!ray_aligned_disk_intersect(P, D, t,
367                         lightP, radius, &ls->P, &ls->t))
368                         return false;
369
370                 ls->Ng = -D;
371                 ls->D = D;
372
373                 float invarea = data1.z;
374                 ls->eval_fac = (0.25f*M_1_PI_F)*invarea;
375                 ls->pdf = invarea;
376
377                 if(type == LIGHT_SPOT) {
378                         /* spot light attentuation */
379                         float4 data2 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 2);
380                         ls->eval_fac *= spot_light_attenuation(data1, data2, ls);
381
382                         if(ls->eval_fac == 0.0f)
383                                 return false;
384                 }
385         }
386         else if(type == LIGHT_AREA) {
387                 /* area light */
388                 float4 data2 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 2);
389                 float4 data3 = kernel_tex_fetch(__light_data, lamp*LIGHT_SIZE + 3);
390
391                 float invarea = data2.x;
392                 if(invarea == 0.0f)
393                         return false;
394
395                 float3 axisu = make_float3(data1.y, data1.z, data1.w);
396                 float3 axisv = make_float3(data2.y, data2.z, data2.w);
397                 float3 Ng = make_float3(data3.y, data3.z, data3.w);
398
399                 /* one sided */
400                 if(dot(D, Ng) >= 0.0f)
401                         return false;
402
403                 ls->P = make_float3(data0.y, data0.z, data0.w);
404
405                 if(!ray_quad_intersect(P, D, t,
406                         ls->P, axisu, axisv, &ls->P, &ls->t))
407                         return false;
408
409                 ls->D = D;
410                 ls->Ng = Ng;
411                 ls->pdf = invarea;
412                 ls->eval_fac = 0.25f*ls->pdf;
413         }
414         else
415                 return false;
416
417         /* compute pdf */
418         if(ls->t != FLT_MAX)
419                 ls->pdf *= lamp_light_pdf(kg, ls->Ng, -ls->D, ls->t);
420         ls->eval_fac *= kernel_data.integrator.inv_pdf_lights;
421
422         return true;
423 }
424
425 /* Triangle Light */
426
427 __device void object_transform_light_sample(KernelGlobals *kg, LightSample *ls, int object, float time)
428 {
429 #ifdef __INSTANCING__
430         /* instance transform */
431         if(object >= 0) {
432 #ifdef __OBJECT_MOTION__
433                 Transform tfm = object_fetch_transform_motion_test(kg, object, time, NULL);
434 #else
435                 Transform tfm = object_fetch_transform(kg, object, OBJECT_TRANSFORM);
436 #endif
437
438                 ls->P = transform_point(&tfm, ls->P);
439                 ls->Ng = normalize(transform_direction(&tfm, ls->Ng));
440         }
441 #endif
442 }
443
444 __device void triangle_light_sample(KernelGlobals *kg, int prim, int object,
445         float randu, float randv, float time, LightSample *ls)
446 {
447         /* triangle, so get position, normal, shader */
448         ls->P = triangle_sample_MT(kg, prim, randu, randv);
449         ls->Ng = triangle_normal_MT(kg, prim, &ls->shader);
450         ls->object = object;
451         ls->prim = prim;
452         ls->lamp = ~0;
453         ls->shader |= SHADER_USE_MIS;
454         ls->t = 0.0f;
455         ls->type = LIGHT_TRIANGLE;
456         ls->eval_fac = 1.0f;
457
458         object_transform_light_sample(kg, ls, object, time);
459 }
460
461 __device float triangle_light_pdf(KernelGlobals *kg,
462         const float3 Ng, const float3 I, float t)
463 {
464         float pdf = kernel_data.integrator.pdf_triangles;
465         float cos_pi = fabsf(dot(Ng, I));
466
467         if(cos_pi == 0.0f)
468                 return 0.0f;
469         
470         return t*t*pdf/cos_pi;
471 }
472
473 /* Curve Light */
474
475 #ifdef __HAIR__
476
477 __device void curve_segment_light_sample(KernelGlobals *kg, int prim, int object,
478         int segment, float randu, float randv, float time, LightSample *ls)
479 {
480         /* this strand code needs completion */
481         float4 v00 = kernel_tex_fetch(__curves, prim);
482
483         int k0 = __float_as_int(v00.x) + segment;
484         int k1 = k0 + 1;
485
486         float4 P1 = kernel_tex_fetch(__curve_keys, k0);
487         float4 P2 = kernel_tex_fetch(__curve_keys, k1);
488
489         float l = len(float4_to_float3(P2) - float4_to_float3(P1));
490
491         float r1 = P1.w;
492         float r2 = P2.w;
493         float3 tg = (float4_to_float3(P2) - float4_to_float3(P1)) / l;
494         float3 xc = make_float3(tg.x * tg.z, tg.y * tg.z, -(tg.x * tg.x + tg.y * tg.y));
495         if (is_zero(xc))
496                 xc = make_float3(tg.x * tg.y, -(tg.x * tg.x + tg.z * tg.z), tg.z * tg.y);
497         xc = normalize(xc);
498         float3 yc = cross(tg, xc);
499         float gd = ((r2 - r1)/l);
500
501         /* normal currently ignores gradient */
502         ls->Ng = sinf(M_2PI_F * randv) * xc + cosf(M_2PI_F * randv) * yc;
503         ls->P = randu * l * tg + (gd * l + r1) * ls->Ng;
504         ls->object = object;
505         ls->prim = prim;
506         ls->lamp = ~0;
507         ls->t = 0.0f;
508         ls->type = LIGHT_STRAND;
509         ls->eval_fac = 1.0f;
510         ls->shader = __float_as_int(v00.z) | SHADER_USE_MIS;
511
512         object_transform_light_sample(kg, ls, object, time);
513 }
514
515 #endif
516
517 /* Light Distribution */
518
519 __device int light_distribution_sample(KernelGlobals *kg, float randt)
520 {
521         /* this is basically std::upper_bound as used by pbrt, to find a point light or
522          * triangle to emit from, proportional to area. a good improvement would be to
523          * also sample proportional to power, though it's not so well defined with
524          * OSL shaders. */
525         int first = 0;
526         int len = kernel_data.integrator.num_distribution + 1;
527
528         while(len > 0) {
529                 int half_len = len >> 1;
530                 int middle = first + half_len;
531
532                 if(randt < kernel_tex_fetch(__light_distribution, middle).x) {
533                         len = half_len;
534                 }
535                 else {
536                         first = middle + 1;
537                         len = len - half_len - 1;
538                 }
539         }
540
541         /* clamping should not be needed but float rounding errors seem to
542          * make this fail on rare occasions */
543         return clamp(first-1, 0, kernel_data.integrator.num_distribution-1);
544 }
545
546 /* Generic Light */
547
548 __device void light_sample(KernelGlobals *kg, float randt, float randu, float randv, float time, float3 P, LightSample *ls)
549 {
550         /* sample index */
551         int index = light_distribution_sample(kg, randt);
552
553         /* fetch light data */
554         float4 l = kernel_tex_fetch(__light_distribution, index);
555         int prim = __float_as_int(l.y);
556
557         if(prim >= 0) {
558                 int object = __float_as_int(l.w);
559 #ifdef __HAIR__
560                 int segment = __float_as_int(l.z);
561 #endif
562
563 #ifdef __HAIR__
564                 if (segment != (int)~0)
565                         curve_segment_light_sample(kg, prim, object, segment, randu, randv, time, ls);
566                 else
567 #endif
568                         triangle_light_sample(kg, prim, object, randu, randv, time, ls);
569
570                 /* compute incoming direction, distance and pdf */
571                 ls->D = normalize_len(ls->P - P, &ls->t);
572                 ls->pdf = triangle_light_pdf(kg, ls->Ng, -ls->D, ls->t);
573         }
574         else {
575                 int lamp = -prim-1;
576                 lamp_light_sample(kg, lamp, randu, randv, P, ls);
577         }
578 }
579
580 __device int light_select_num_samples(KernelGlobals *kg, int index)
581 {
582         float4 data3 = kernel_tex_fetch(__light_data, index*LIGHT_SIZE + 3);
583         return __float_as_int(data3.x);
584 }
585
586 __device void light_select(KernelGlobals *kg, int index, float randu, float randv, float3 P, LightSample *ls)
587 {
588         lamp_light_sample(kg, index, randu, randv, P, ls);
589 }
590
591 __device int lamp_light_eval_sample(KernelGlobals *kg, float randt)
592 {
593         /* sample index */
594         int index = light_distribution_sample(kg, randt);
595
596         /* fetch light data */
597         float4 l = kernel_tex_fetch(__light_distribution, index);
598         int prim = __float_as_int(l.y);
599
600         if(prim < 0) {
601                 int lamp = -prim-1;
602                 return lamp;
603         }
604         else
605                 return ~0;
606 }
607
608 CCL_NAMESPACE_END
609