Merged changes in the trunk up to revision 46045.
[blender-staging.git] / source / blender / render / intern / source / volumetric.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Matt Ebb, Raul Fernandez Hernandez (Farsthary)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/render/intern/source/volumetric.c
29  *  \ingroup render
30  */
31
32
33 #include <math.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <float.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "BLI_blenlib.h"
41 #include "BLI_math.h"
42 #include "BLI_rand.h"
43 #include "BLI_voxel.h"
44 #include "BLI_utildefines.h"
45
46 #include "RE_shader_ext.h"
47
48 #include "DNA_material_types.h"
49 #include "DNA_group_types.h"
50 #include "DNA_lamp_types.h"
51 #include "DNA_meta_types.h"
52
53 #include "BKE_global.h"
54
55 #include "render_types.h"
56 #include "pixelshading.h"
57 #include "rayintersection.h"
58 #include "rayobject.h"
59 #include "shading.h"
60 #include "shadbuf.h"
61 #include "texture.h"
62 #include "volumetric.h"
63 #include "volume_precache.h"
64
65 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
66 /* defined in pipeline.c, is hardcopy of active dynamic allocated Render */
67 /* only to be used here in this file, it's for speed */
68 extern struct Render R;
69 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
70
71 /* luminance rec. 709 */
72 BLI_INLINE float luminance(const float col[3])
73 {
74         return (0.212671f*col[0] + 0.71516f*col[1] + 0.072169f*col[2]);
75 }
76
77 /* tracing */
78 static float vol_get_shadow(ShadeInput *shi, LampRen *lar, const float co[3])
79 {
80         float visibility = 1.f;
81         
82         if (lar->shb) {
83                 float dxco[3]={0.f, 0.f, 0.f}, dyco[3]={0.f, 0.f, 0.f};
84                 
85                 visibility = testshadowbuf(&R, lar->shb, co, dxco, dyco, 1.0, 0.0);             
86         }
87         else if (lar->mode & LA_SHAD_RAY) {
88                 /* trace shadow manually, no good lamp api atm */
89                 Isect is;
90                 
91                 copy_v3_v3(is.start, co);
92                 if (lar->type==LA_SUN || lar->type==LA_HEMI) {
93                         is.dir[0] = -lar->vec[0];
94                         is.dir[1] = -lar->vec[1];
95                         is.dir[2] = -lar->vec[2];
96                         is.dist = R.maxdist;
97                 }
98                 else {
99                         sub_v3_v3v3(is.dir, lar->co, is.start);
100                         is.dist = normalize_v3( is.dir );
101                 }
102
103                 is.mode = RE_RAY_MIRROR;
104                 is.check = RE_CHECK_VLR_NON_SOLID_MATERIAL;
105                 is.skip = 0;
106                 
107                 if (lar->mode & (LA_LAYER|LA_LAYER_SHADOW))
108                         is.lay= lar->lay;       
109                 else
110                         is.lay= -1;
111                         
112                 is.orig.ob = NULL;
113                 is.orig.face = NULL;
114                 is.last_hit = lar->last_hit[shi->thread];
115                 
116                 if (RE_rayobject_raycast(R.raytree,&is)) {
117                         visibility = 0.f;
118                 }
119                 
120                 lar->last_hit[shi->thread]= is.last_hit;
121         }
122         return visibility;
123 }
124
125 static int vol_get_bounds(ShadeInput *shi, const float co[3], const float vec[3], float hitco[3], Isect *isect, int intersect_type)
126 {
127         
128         copy_v3_v3(isect->start, co);
129         copy_v3_v3(isect->dir, vec);
130         isect->dist = FLT_MAX;
131         isect->mode= RE_RAY_MIRROR;
132         isect->last_hit = NULL;
133         isect->lay= -1;
134         isect->check= RE_CHECK_VLR_NONE;
135         
136         if (intersect_type == VOL_BOUNDS_DEPTH) {
137                 isect->skip = RE_SKIP_VLR_NEIGHBOUR;
138                 isect->orig.face = (void*)shi->vlr;
139                 isect->orig.ob = (void*)shi->obi;
140         }
141         else { // if (intersect_type == VOL_BOUNDS_SS) {
142                 isect->skip= 0;
143                 isect->orig.face= NULL;
144                 isect->orig.ob = NULL;
145         }
146         
147         if (RE_rayobject_raycast(R.raytree, isect)) {
148                 hitco[0] = isect->start[0] + isect->dist*isect->dir[0];
149                 hitco[1] = isect->start[1] + isect->dist*isect->dir[1];
150                 hitco[2] = isect->start[2] + isect->dist*isect->dir[2];
151                 return 1;
152         }
153         else {
154                 return 0;
155         }
156 }
157
158 static void shade_intersection(ShadeInput *shi, float col_r[4], Isect *is)
159 {
160         ShadeInput shi_new;
161         ShadeResult shr_new;
162         
163         memset(&shi_new, 0, sizeof(ShadeInput)); 
164         
165         shi_new.mask= shi->mask;
166         shi_new.osatex= shi->osatex;
167         shi_new.thread= shi->thread;
168         shi_new.depth = shi->depth + 1;
169         shi_new.volume_depth= shi->volume_depth + 1;
170         shi_new.xs= shi->xs;
171         shi_new.ys= shi->ys;
172         shi_new.lay= shi->lay;
173         shi_new.passflag= SCE_PASS_COMBINED; /* result of tracing needs no pass info */
174         shi_new.combinedflag= 0xFFFFFF;          /* ray trace does all options */
175         shi_new.light_override= shi->light_override;
176         shi_new.mat_override= shi->mat_override;
177         
178         copy_v3_v3(shi_new.camera_co, is->start);
179         
180         memset(&shr_new, 0, sizeof(ShadeResult));
181         
182         /* hardcoded limit of 100 for now - prevents problems in weird geometry */
183         if (shi->volume_depth < 100) {
184                 shade_ray(is, &shi_new, &shr_new);
185         }
186         
187         copy_v3_v3(col_r, shr_new.combined);
188         col_r[3] = shr_new.alpha;
189 }
190
191 static void vol_trace_behind(ShadeInput *shi, VlakRen *vlr, const float co[3], float col_r[4])
192 {
193         Isect isect;
194         
195         copy_v3_v3(isect.start, co);
196         copy_v3_v3(isect.dir, shi->view);
197         isect.dist = FLT_MAX;
198         
199         isect.mode= RE_RAY_MIRROR;
200         isect.check = RE_CHECK_VLR_NONE;
201         isect.skip = RE_SKIP_VLR_NEIGHBOUR;
202         isect.orig.ob = (void*) shi->obi;
203         isect.orig.face = (void*)vlr;
204         isect.last_hit = NULL;
205         isect.lay= -1;
206         
207         /* check to see if there's anything behind the volume, otherwise shade the sky */
208         if (RE_rayobject_raycast(R.raytree, &isect)) {
209                 shade_intersection(shi, col_r, &isect);
210         }
211         else {
212                 shadeSkyView(col_r, co, shi->view, NULL, shi->thread);
213                 shadeSunView(col_r, shi->view);
214         } 
215 }
216
217
218 /* trilinear interpolation */
219 static void vol_get_precached_scattering(Render *re, ShadeInput *shi, float scatter_col[3], const float co[3])
220 {
221         VolumePrecache *vp = shi->obi->volume_precache;
222         float bbmin[3], bbmax[3], dim[3];
223         float world_co[3], sample_co[3];
224         
225         if (!vp) return;
226         
227         /* find sample point in global space bounding box 0.0-1.0 */
228         global_bounds_obi(re, shi->obi, bbmin, bbmax);
229         sub_v3_v3v3(dim, bbmax, bbmin);
230         mul_v3_m4v3(world_co, re->viewinv, co); 
231
232         /* sample_co in 0.0-1.0 */
233         sample_co[0] = (world_co[0] - bbmin[0]) / dim[0];
234         sample_co[1] = (world_co[1] - bbmin[1]) / dim[1];
235         sample_co[2] = (world_co[2] - bbmin[2]) / dim[2];
236
237         scatter_col[0] = voxel_sample_triquadratic(vp->data_r, vp->res, sample_co);
238         scatter_col[1] = voxel_sample_triquadratic(vp->data_g, vp->res, sample_co);
239         scatter_col[2] = voxel_sample_triquadratic(vp->data_b, vp->res, sample_co);
240 }
241
242 /* Meta object density, brute force for now 
243  * (might be good enough anyway, don't need huge number of metaobs to model volumetric objects */
244 static float metadensity(Object* ob, const float co[3])
245 {
246         float mat[4][4], imat[4][4], dens = 0.f;
247         MetaBall* mb = (MetaBall*)ob->data;
248         MetaElem* ml;
249         
250         /* transform co to meta-element */
251         float tco[3] = {co[0], co[1], co[2]};
252         mult_m4_m4m4(mat, R.viewmat, ob->obmat);
253         invert_m4_m4(imat, mat);
254         mul_m4_v3(imat, tco);
255         
256         for (ml = mb->elems.first; ml; ml=ml->next) {
257                 float bmat[3][3], dist2;
258                 
259                 /* element rotation transform */
260                 float tp[3] = {ml->x - tco[0], ml->y - tco[1], ml->z - tco[2]};
261                 quat_to_mat3( bmat,ml->quat);
262                 transpose_m3(bmat);     // rot.only, so inverse == transpose
263                 mul_m3_v3(bmat, tp);
264                 
265                 /* MB_BALL default */
266                 switch (ml->type) {
267                         case MB_ELIPSOID:
268                                 tp[0] /= ml->expx, tp[1] /= ml->expy, tp[2] /= ml->expz;
269                                 break;
270                         case MB_CUBE:
271                                 tp[2] = (tp[2] > ml->expz) ? (tp[2] - ml->expz) : ((tp[2] < -ml->expz) ? (tp[2] + ml->expz) : 0.f);
272                                 // no break, xy as plane
273                         case MB_PLANE:
274                                 tp[1] = (tp[1] > ml->expy) ? (tp[1] - ml->expy) : ((tp[1] < -ml->expy) ? (tp[1] + ml->expy) : 0.f);
275                                 // no break, x as tube
276                         case MB_TUBE:
277                                 tp[0] = (tp[0] > ml->expx) ? (tp[0] - ml->expx) : ((tp[0] < -ml->expx) ? (tp[0] + ml->expx) : 0.f);
278                 }
279                 
280                 /* ml->rad2 is not set */
281                 dist2 = 1.0f - (dot_v3v3(tp, tp) / (ml->rad * ml->rad));
282                 if (dist2 > 0.f)
283                         dens += (ml->flag & MB_NEGATIVE) ? -ml->s*dist2*dist2*dist2 : ml->s*dist2*dist2*dist2;
284         }
285         
286         dens -= mb->thresh;
287         return (dens < 0.f) ? 0.f : dens;
288 }
289
290 float vol_get_density(struct ShadeInput *shi, const float co[3])
291 {
292         float density = shi->mat->vol.density;
293         float density_scale = shi->mat->vol.density_scale;
294                 
295         if (shi->mat->mapto_textured & MAP_DENSITY)
296                 do_volume_tex(shi, co, MAP_DENSITY, NULL, &density, &R);
297         
298         // if meta-object, modulate by metadensity without increasing it
299         if (shi->obi->obr->ob->type == OB_MBALL) {
300                 const float md = metadensity(shi->obi->obr->ob, co);
301                 if (md < 1.f) density *= md;
302          }
303         
304         return density * density_scale;
305 }
306
307
308 /* Color of light that gets scattered out by the volume */
309 /* Uses same physically based scattering parameter as in transmission calculations, 
310  * along with artificial reflection scale/reflection color tint */
311 static void vol_get_reflection_color(ShadeInput *shi, float ref_col[3], const float co[3])
312 {
313         float scatter = shi->mat->vol.scattering;
314         float reflection= shi->mat->vol.reflection;
315         copy_v3_v3(ref_col, shi->mat->vol.reflection_col);
316         
317         if (shi->mat->mapto_textured & (MAP_SCATTERING+MAP_REFLECTION_COL))
318                 do_volume_tex(shi, co, MAP_SCATTERING+MAP_REFLECTION_COL, ref_col, &scatter, &R);
319         
320         /* only one single float parameter at a time... :s */
321         if (shi->mat->mapto_textured & (MAP_REFLECTION))
322                 do_volume_tex(shi, co, MAP_REFLECTION, NULL, &reflection, &R);
323         
324         ref_col[0] = reflection * ref_col[0] * scatter;
325         ref_col[1] = reflection * ref_col[1] * scatter;
326         ref_col[2] = reflection * ref_col[2] * scatter;
327 }
328
329 /* compute emission component, amount of radiance to add per segment
330  * can be textured with 'emit' */
331 static void vol_get_emission(ShadeInput *shi, float emission_col[3], const float co[3])
332 {
333         float emission = shi->mat->vol.emission;
334         copy_v3_v3(emission_col, shi->mat->vol.emission_col);
335         
336         if (shi->mat->mapto_textured & (MAP_EMISSION+MAP_EMISSION_COL))
337                 do_volume_tex(shi, co, MAP_EMISSION+MAP_EMISSION_COL, emission_col, &emission, &R);
338         
339         emission_col[0] = emission_col[0] * emission;
340         emission_col[1] = emission_col[1] * emission;
341         emission_col[2] = emission_col[2] * emission;
342 }
343
344
345 /* A combination of scattering and absorption -> known as sigma T.
346  * This can possibly use a specific scattering color, 
347  * and absorption multiplier factor too, but these parameters are left out for simplicity.
348  * It's easy enough to get a good wide range of results with just these two parameters. */
349 static void vol_get_sigma_t(ShadeInput *shi, float sigma_t[3], const float co[3])
350 {
351         /* technically absorption, but named transmission color 
352          * since it describes the effect of the coloring *after* absorption */
353         float transmission_col[3] = {shi->mat->vol.transmission_col[0], shi->mat->vol.transmission_col[1], shi->mat->vol.transmission_col[2]};
354         float scattering = shi->mat->vol.scattering;
355         
356         if (shi->mat->mapto_textured & (MAP_SCATTERING+MAP_TRANSMISSION_COL))
357                 do_volume_tex(shi, co, MAP_SCATTERING+MAP_TRANSMISSION_COL, transmission_col, &scattering, &R);
358         
359         sigma_t[0] = (1.0f - transmission_col[0]) + scattering;
360         sigma_t[1] = (1.0f - transmission_col[1]) + scattering;
361         sigma_t[2] = (1.0f - transmission_col[2]) + scattering;
362 }
363
364 /* phase function - determines in which directions the light 
365  * is scattered in the volume relative to incoming direction 
366  * and view direction */
367 static float vol_get_phasefunc(ShadeInput *UNUSED(shi), float g, const float w[3], const float wp[3])
368 {
369         const float normalize = 0.25f; // = 1.f/4.f = M_PI/(4.f*M_PI)
370         
371         /* normalization constant is 1/4 rather than 1/4pi, since
372          * Blender's shading system doesn't normalize for
373          * energy conservation - eg. multiplying by pdf ( 1/pi for a lambert brdf ).
374          * This means that lambert surfaces in Blender are pi times brighter than they 'should be'
375          * and therefore, with correct energy conservation, volumes will darker than other solid objects,
376          * for the same lighting intensity.
377          * To correct this, scale up the phase function values by pi
378          * until Blender's shading system supports this better. --matt
379          */
380         
381         if (g == 0.f) { /* isotropic */
382                 return normalize * 1.f;
383         }
384         else {          /* schlick */
385                 const float k = 1.55f * g - .55f * g * g * g;
386                 const float kcostheta = k * dot_v3v3(w, wp);
387                 return normalize * (1.f - k*k) / ((1.f - kcostheta) * (1.f - kcostheta));
388         }
389         
390         /* not used, but here for reference: */
391 #if 0
392         switch (phasefunc_type) {
393                 case MA_VOL_PH_MIEHAZY:
394                         return normalize * (0.5f + 4.5f * powf(0.5 * (1.f + costheta), 8.f));
395                 case MA_VOL_PH_MIEMURKY:
396                         return normalize * (0.5f + 16.5f * powf(0.5 * (1.f + costheta), 32.f));
397                 case MA_VOL_PH_RAYLEIGH:
398                         return normalize * 3.f/4.f * (1 + costheta * costheta);
399                 case MA_VOL_PH_HG:
400                         return normalize * (1.f - g * g) / powf(1.f + g * g - 2.f * g * costheta, 1.5f);
401                 case MA_VOL_PH_SCHLICK:
402                 {
403                         const float k = 1.55f * g - .55f * g * g * g;
404                         const float kcostheta = k * costheta;
405                         return normalize * (1.f - k*k) / ((1.f - kcostheta) * (1.f - kcostheta));
406                 }
407                 case MA_VOL_PH_ISOTROPIC:
408                 default:
409                         return normalize * 1.f;
410         }
411 #endif
412 }
413
414 /* Compute transmittance = e^(-attenuation) */
415 static void vol_get_transmittance_seg(ShadeInput *shi, float tr[3], float stepsize, const float co[3], float density)
416 {
417         /* input density = density at co */
418         float tau[3] = {0.f, 0.f, 0.f};
419         const float stepd = density * stepsize;
420         float sigma_t[3];
421         
422         vol_get_sigma_t(shi, sigma_t, co);
423         
424         /* homogenous volume within the sampled distance */
425         tau[0] += stepd * sigma_t[0];
426         tau[1] += stepd * sigma_t[1];
427         tau[2] += stepd * sigma_t[2];
428         
429         tr[0] *= expf(-tau[0]);
430         tr[1] *= expf(-tau[1]);
431         tr[2] *= expf(-tau[2]);
432 }
433
434 /* Compute transmittance = e^(-attenuation) */
435 static void vol_get_transmittance(ShadeInput *shi, float tr[3], const float co[3], const float endco[3])
436 {
437         float p[3] = {co[0], co[1], co[2]};
438         float step_vec[3] = {endco[0] - co[0], endco[1] - co[1], endco[2] - co[2]};
439         float tau[3] = {0.f, 0.f, 0.f};
440
441         float t0 = 0.f;
442         float t1 = normalize_v3(step_vec);
443         float pt0 = t0;
444         
445         t0 += shi->mat->vol.stepsize * ((shi->mat->vol.stepsize_type == MA_VOL_STEP_CONSTANT) ? 0.5f : BLI_thread_frand(shi->thread));
446         p[0] += t0 * step_vec[0];
447         p[1] += t0 * step_vec[1];
448         p[2] += t0 * step_vec[2];
449         mul_v3_fl(step_vec, shi->mat->vol.stepsize);
450
451         for (; t0 < t1; pt0 = t0, t0 += shi->mat->vol.stepsize) {
452                 const float d = vol_get_density(shi, p);
453                 const float stepd = (t0 - pt0) * d;
454                 float sigma_t[3];
455                 
456                 vol_get_sigma_t(shi, sigma_t, p);
457                 
458                 tau[0] += stepd * sigma_t[0];
459                 tau[1] += stepd * sigma_t[1];
460                 tau[2] += stepd * sigma_t[2];
461                 
462                 add_v3_v3(p, step_vec);
463         }
464         
465         /* return transmittance */
466         tr[0] = expf(-tau[0]);
467         tr[1] = expf(-tau[1]);
468         tr[2] = expf(-tau[2]);
469 }
470
471 static void vol_shade_one_lamp(struct ShadeInput *shi, const float co[3], const float view[3], LampRen *lar, float lacol[3])
472 {
473         float visifac, lv[3], lampdist;
474         float tr[3]={1.0,1.0,1.0};
475         float hitco[3], *atten_co;
476         float p, ref_col[3];
477         
478         if (lar->mode & LA_LAYER) if ((lar->lay & shi->obi->lay)==0) return;
479         if ((lar->lay & shi->lay)==0) return;
480         if (lar->energy == 0.0f) return;
481         
482         if ((visifac= lamp_get_visibility(lar, co, lv, &lampdist)) == 0.f) return;
483         
484         copy_v3_v3(lacol, &lar->r);
485         
486         if (lar->mode & LA_TEXTURE) {
487                 shi->osatex= 0;
488                 do_lamp_tex(lar, lv, shi, lacol, LA_TEXTURE);
489         }
490
491         mul_v3_fl(lacol, visifac);
492
493         if (ELEM(lar->type, LA_SUN, LA_HEMI))
494                 copy_v3_v3(lv, lar->vec);
495         negate_v3(lv);
496         
497         if (shi->mat->vol.shade_type == MA_VOL_SHADE_SHADOWED) {
498                 mul_v3_fl(lacol, vol_get_shadow(shi, lar, co));
499         }
500         else if (ELEM3(shi->mat->vol.shade_type, MA_VOL_SHADE_SHADED, MA_VOL_SHADE_MULTIPLE, MA_VOL_SHADE_SHADEDPLUSMULTIPLE)) {
501                 Isect is;
502                 
503                 if (shi->mat->vol.shadeflag & MA_VOL_RECV_EXT_SHADOW) {
504                         mul_v3_fl(lacol, vol_get_shadow(shi, lar, co));
505                         if (luminance(lacol) < 0.001f) return;
506                 }
507                 
508                 /* find minimum of volume bounds, or lamp coord */
509                 if (vol_get_bounds(shi, co, lv, hitco, &is, VOL_BOUNDS_SS)) {
510                         float dist = len_v3v3(co, hitco);
511                         VlakRen *vlr = (VlakRen *)is.hit.face;
512                         
513                         /* simple internal shadowing */
514                         if (vlr->mat->material_type == MA_TYPE_SURFACE) {
515                                 lacol[0] = lacol[1] = lacol[2] = 0.0f;
516                                 return;
517                         }
518
519                         if (ELEM(lar->type, LA_SUN, LA_HEMI))
520                                 /* infinite lights, can never be inside volume */
521                                 atten_co = hitco;
522                         else if ( lampdist < dist ) {
523                                 atten_co = lar->co;
524                         }
525                         else
526                                 atten_co = hitco;
527                         
528                         vol_get_transmittance(shi, tr, co, atten_co);
529                         
530                         mul_v3_v3v3(lacol, lacol, tr);
531                 }
532                 else {
533                         /* Point is on the outside edge of the volume,
534                          * therefore no attenuation, full transmission.
535                          * Radiance from lamp remains unchanged */
536                 }
537         }
538         
539         if (luminance(lacol) < 0.001f) return;
540         
541         normalize_v3(lv);
542         p = vol_get_phasefunc(shi, shi->mat->vol.asymmetry, view, lv);
543         
544         /* physically based scattering with non-physically based RGB gain */
545         vol_get_reflection_color(shi, ref_col, co);
546         
547         lacol[0] *= p * ref_col[0];
548         lacol[1] *= p * ref_col[1];
549         lacol[2] *= p * ref_col[2];
550 }
551
552 /* single scattering only for now */
553 void vol_get_scattering(ShadeInput *shi, float scatter_col[3], const float co[3], const float view[3])
554 {
555         ListBase *lights;
556         GroupObject *go;
557         LampRen *lar;
558
559         zero_v3(scatter_col);
560
561         lights= get_lights(shi);
562         for (go=lights->first; go; go= go->next) {
563                 float lacol[3] = {0.f, 0.f, 0.f};
564                 lar= go->lampren;
565                 
566                 if (lar) {
567                         vol_shade_one_lamp(shi, co, view, lar, lacol);
568                         add_v3_v3(scatter_col, lacol);
569                 }
570         }
571 }
572
573         
574 /*
575  * The main volumetric integrator, using an emission/absorption/scattering model.
576  *
577  * Incoming radiance =
578  *
579  * outgoing radiance from behind surface * beam transmittance/attenuation
580  * + added radiance from all points along the ray due to participating media
581  *     --> radiance for each segment =
582  *         (radiance added by scattering + radiance added by emission) * beam transmittance/attenuation
583  */
584
585 /* For ease of use, I've also introduced a 'reflection' and 'reflection color' parameter, which isn't 
586  * physically correct. This works as an RGB tint/gain on out-scattered light, but doesn't affect the light 
587  * that is transmitted through the volume. While having wavelength dependent absorption/scattering is more correct,
588  * it also makes it harder to control the overall look of the volume since coloring the outscattered light results
589  * in the inverse color being transmitted through the rest of the volume.
590  */
591 static void volumeintegrate(struct ShadeInput *shi, float col[4], const float co[3], const float endco[3])
592 {
593         float radiance[3] = {0.f, 0.f, 0.f};
594         float tr[3] = {1.f, 1.f, 1.f};
595         float p[3] = {co[0], co[1], co[2]};
596         float step_vec[3] = {endco[0] - co[0], endco[1] - co[1], endco[2] - co[2]};
597         const float stepsize = shi->mat->vol.stepsize;
598         
599         float t0 = 0.f;
600         float pt0 = t0;
601         float t1 = normalize_v3(step_vec);      /* returns vector length */
602         
603         t0 += stepsize * ((shi->mat->vol.stepsize_type == MA_VOL_STEP_CONSTANT) ? 0.5f : BLI_thread_frand(shi->thread));
604         p[0] += t0 * step_vec[0];
605         p[1] += t0 * step_vec[1];
606         p[2] += t0 * step_vec[2];
607         mul_v3_fl(step_vec, stepsize);
608         
609         for (; t0 < t1; pt0 = t0, t0 += stepsize) {
610                 const float density = vol_get_density(shi, p);
611                 
612                 if (density > 0.00001f) {
613                         float scatter_col[3] = {0.f, 0.f, 0.f}, emit_col[3];
614                         const float stepd = (t0 - pt0) * density;
615                         
616                         /* transmittance component (alpha) */
617                         vol_get_transmittance_seg(shi, tr, stepsize, co, density);
618                         
619                         if (t0 > t1 * 0.25f) {
620                                 /* only use depth cutoff after we've traced a little way into the volume */
621                                 if (luminance(tr) < shi->mat->vol.depth_cutoff) break;
622                         }
623                         
624                         vol_get_emission(shi, emit_col, p);
625                         
626                         if (shi->obi->volume_precache) {
627                                 float p2[3];
628                                 
629                                 p2[0] = p[0] + (step_vec[0] * 0.5f);
630                                 p2[1] = p[1] + (step_vec[1] * 0.5f);
631                                 p2[2] = p[2] + (step_vec[2] * 0.5f);
632                                 
633                                 vol_get_precached_scattering(&R, shi, scatter_col, p2);
634                         }
635                         else
636                                 vol_get_scattering(shi, scatter_col, p, shi->view);
637                         
638                         radiance[0] += stepd * tr[0] * (emit_col[0] + scatter_col[0]);
639                         radiance[1] += stepd * tr[1] * (emit_col[1] + scatter_col[1]);
640                         radiance[2] += stepd * tr[2] * (emit_col[2] + scatter_col[2]);
641                 }
642                 add_v3_v3(p, step_vec);
643         }
644         
645         /* multiply original color (from behind volume) with transmittance over entire distance */
646         mul_v3_v3v3(col, tr, col);
647         add_v3_v3(col, radiance);
648         
649         /* alpha <-- transmission luminance */
650         col[3] = 1.0f - luminance(tr);
651 }
652
653 /* the main entry point for volume shading */
654 static void volume_trace(struct ShadeInput *shi, struct ShadeResult *shr, int inside_volume)
655 {
656         float hitco[3], col[4] = {0.f,0.f,0.f,0.f};
657         float *startco, *endco;
658         int trace_behind = 1;
659         const int ztransp= ((shi->depth==0) && (shi->mat->mode & MA_TRANSP) && (shi->mat->mode & MA_ZTRANSP));
660         Isect is;
661
662         /* check for shading an internal face a volume object directly */
663         if (inside_volume == VOL_SHADE_INSIDE)
664                 trace_behind = 0;
665         else if (inside_volume == VOL_SHADE_OUTSIDE) {
666                 if (shi->flippednor)
667                         inside_volume = VOL_SHADE_INSIDE;
668         }
669         
670         if (ztransp && inside_volume == VOL_SHADE_INSIDE) {
671                 MatInside *mi;
672                 int render_this=0;
673                 
674                 /* don't render the backfaces of ztransp volume materials.
675                  *
676                  * volume shading renders the internal volume from between the
677                  * ' view intersection of the solid volume to the
678                  * intersection on the other side, as part of the shading of
679                  * the front face.
680                  *
681                  * Because ztransp renders both front and back faces independently
682                  * this will double up, so here we prevent rendering the backface as well, 
683                  * which would otherwise render the volume in between the camera and the backface
684                  * --matt */
685                 
686                 for (mi=R.render_volumes_inside.first; mi; mi=mi->next) {
687                         /* weak... */
688                         if (mi->ma == shi->mat) render_this=1;
689                 }
690                 if (!render_this) return;
691         }
692         
693
694         if (inside_volume == VOL_SHADE_INSIDE) {
695                 startco = shi->camera_co;
696                 endco = shi->co;
697                 
698                 if (trace_behind) {
699                         if (!ztransp)
700                                 /* trace behind the volume object */
701                                 vol_trace_behind(shi, shi->vlr, endco, col);
702                 }
703                 else {
704                         /* we're tracing through the volume between the camera 
705                          * and a solid surface, so use that pre-shaded radiance */
706                         copy_v4_v4(col, shr->combined);
707                 }
708                 
709                 /* shade volume from 'camera' to 1st hit point */
710                 volumeintegrate(shi, col, startco, endco);
711         }
712         /* trace to find a backface, the other side bounds of the volume */
713         /* (ray intersect ignores front faces here) */
714         else if (vol_get_bounds(shi, shi->co, shi->view, hitco, &is, VOL_BOUNDS_DEPTH)) {
715                 VlakRen *vlr = (VlakRen *)is.hit.face;
716                 
717                 startco = shi->co;
718                 endco = hitco;
719                 
720                 if (!ztransp) {
721                         /* if it's another face in the same material */
722                         if (vlr->mat == shi->mat) {
723                                 /* trace behind the 2nd (raytrace) hit point */
724                                 vol_trace_behind(shi, (VlakRen *)is.hit.face, endco, col);
725                         }
726                         else {
727                                 shade_intersection(shi, col, &is);
728                         }
729                 }
730                 
731                 /* shade volume from 1st hit point to 2nd hit point */
732                 volumeintegrate(shi, col, startco, endco);
733         }
734         
735         if (ztransp)
736                 col[3] = col[3]>1.f?1.f:col[3];
737         else
738                 col[3] = 1.f;
739         
740         copy_v3_v3(shr->combined, col);
741         shr->alpha = col[3];
742         
743         copy_v3_v3(shr->diff, shr->combined);
744 }
745
746 /* Traces a shadow through the object, 
747  * pretty much gets the transmission over a ray path */
748 void shade_volume_shadow(struct ShadeInput *shi, struct ShadeResult *shr, struct Isect *last_is)
749 {
750         float hitco[3];
751         float tr[3] = {1.0,1.0,1.0};
752         Isect is= {{0}};
753         float *startco, *endco;
754
755         memset(shr, 0, sizeof(ShadeResult));
756         
757         /* if 1st hit normal is facing away from the camera, 
758          * then we're inside the volume already. */
759         if (shi->flippednor) {
760                 startco = last_is->start;
761                 endco = shi->co;
762         }
763         
764         /* trace to find a backface, the other side bounds of the volume */
765         /* (ray intersect ignores front faces here) */
766         else if (vol_get_bounds(shi, shi->co, shi->view, hitco, &is, VOL_BOUNDS_DEPTH)) {
767                 startco = shi->co;
768                 endco = hitco;
769         }
770         else {
771                 shr->combined[0] = shr->combined[1] = shr->combined[2] = 0.f;
772                 shr->alpha = shr->combined[3] = 1.f;
773                 return;
774         }
775
776         vol_get_transmittance(shi, tr, startco, endco);
777
778         
779         /* if we hit another face in the same volume bounds */
780         /* shift raytrace coordinates to the hit point, to avoid shading volume twice */
781         /* due to idiosyncracy in ray_trace_shadow_tra() */
782         if (is.hit.ob == shi->obi) {
783                 copy_v3_v3(shi->co, hitco);
784                 last_is->dist -= is.dist;
785                 shi->vlr = (VlakRen *)is.hit.face;
786         }
787
788         
789         copy_v3_v3(shr->combined, tr);
790         shr->combined[3] = 1.0f - luminance(tr);
791         shr->alpha = shr->combined[3];
792 }
793
794
795 /* delivers a fully filled in ShadeResult, for all passes */
796 void shade_volume_outside(ShadeInput *shi, ShadeResult *shr)
797 {
798         memset(shr, 0, sizeof(ShadeResult));
799         volume_trace(shi, shr, VOL_SHADE_OUTSIDE);
800 }
801
802
803 void shade_volume_inside(ShadeInput *shi, ShadeResult *shr)
804 {
805         MatInside *m;
806         Material *mat_backup;
807         ObjectInstanceRen *obi_backup;
808         float prev_alpha = shr->alpha;
809
810         /* XXX: extend to multiple volumes perhaps later */
811         mat_backup = shi->mat;
812         obi_backup = shi->obi;
813         
814         m = R.render_volumes_inside.first;
815         shi->mat = m->ma;
816         shi->obi = m->obi;
817         shi->obr = m->obi->obr;
818         
819         volume_trace(shi, shr, VOL_SHADE_INSIDE);
820         
821         shr->alpha = shr->alpha + prev_alpha;
822         CLAMP(shr->alpha, 0.0f, 1.0f);
823
824         shi->mat = mat_backup;
825         shi->obi = obi_backup;
826         shi->obr = obi_backup->obr;
827 }
828
829