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