commit before doing some hefty shapekey change, will break compilation
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include <math.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <float.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BLI_blenlib.h"
37 #include "BLI_arithb.h"
38 #include "BLI_rand.h"
39 #include "BLI_voxel.h"
40
41 #include "RE_shader_ext.h"
42 #include "RE_raytrace.h"
43
44 #include "DNA_material_types.h"
45 #include "DNA_group_types.h"
46 #include "DNA_lamp_types.h"
47 #include "DNA_meta_types.h"
48
49 #include "BKE_global.h"
50
51 #include "render_types.h"
52 #include "pixelshading.h"
53 #include "shading.h"
54 #include "shadbuf.h"
55 #include "texture.h"
56 #include "volumetric.h"
57 #include "volume_precache.h"
58
59 #if defined( _MSC_VER ) && !defined( __cplusplus )
60 # define inline __inline
61 #endif // defined( _MSC_VER ) && !defined( __cplusplus )
62
63 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
64 /* defined in pipeline.c, is hardcopy of active dynamic allocated Render */
65 /* only to be used here in this file, it's for speed */
66 extern struct Render R;
67 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
68
69 /* luminance rec. 709 */
70 inline float luminance(float* col)
71 {
72         return (0.212671f*col[0] + 0.71516f*col[1] + 0.072169f*col[2]);
73 }
74
75 /* tracing */
76 static float vol_get_shadow(ShadeInput *shi, LampRen *lar, float *co)
77 {
78         float visibility = 1.f;
79         
80         if(lar->shb) {
81                 float dxco[3]={0.f, 0.f, 0.f}, dyco[3]={0.f, 0.f, 0.f};
82                 
83                 visibility = testshadowbuf(&R, lar->shb, co, dxco, dyco, 1.0, 0.0);             
84         } else if (lar->mode & LA_SHAD_RAY) {
85                 /* trace shadow manually, no good lamp api atm */
86                 Isect is;
87                 
88                 VecCopyf(is.start, co);
89                 if(lar->type==LA_SUN || lar->type==LA_HEMI) {
90                         is.vec[0] = -lar->vec[0];
91                         is.vec[1] = -lar->vec[1];
92                         is.vec[2] = -lar->vec[2];
93                         is.labda = R.maxdist;
94                 } else {
95                         VECSUB( is.vec, lar->co, is.start );
96                         is.labda = VecLength( is.vec );
97                 }
98
99                 is.mode = RE_RAY_MIRROR;
100                 is.skip = RE_SKIP_VLR_RENDER_CHECK | RE_SKIP_VLR_NON_SOLID_MATERIAL;
101                 
102                 if(lar->mode & (LA_LAYER|LA_LAYER_SHADOW))
103                         is.lay= lar->lay;       
104                 else
105                         is.lay= -1;
106                         
107                 is.orig.ob = NULL;
108                 is.orig.face = NULL;
109                 is.last_hit = lar->last_hit[shi->thread];
110                 
111                 if(RE_rayobject_raycast(R.raytree,&is)) {
112                         visibility = 0.f;
113                 }
114                 
115                 lar->last_hit[shi->thread]= is.last_hit;
116         }
117         return visibility;
118 }
119
120 static int vol_get_bounds(ShadeInput *shi, float *co, float *vec, float *hitco, Isect *isect, int intersect_type)
121 {
122         /* XXX TODO - get raytrace max distance from object instance's bounding box */
123         /* need to account for scaling only, but keep coords in camera space...
124          * below code is WIP and doesn't work!
125         VecSubf(bb_dim, shi->obi->obr->boundbox[1], shi->obi->obr->boundbox[2]);
126         Mat3MulVecfl(shi->obi->nmat, bb_dim);
127         maxsize = VecLength(bb_dim);
128         */
129         
130         VECCOPY(isect->start, co);
131         VECCOPY(isect->vec, vec );
132         isect->labda = FLT_MAX;
133         isect->mode= RE_RAY_MIRROR;
134         isect->last_hit = NULL;
135         isect->lay= -1;
136         
137         if (intersect_type == VOL_BOUNDS_DEPTH) {
138                 isect->skip = RE_SKIP_VLR_NEIGHBOUR;
139                 isect->orig.face = (void*)shi->vlr;
140                 isect->orig.ob = (void*)shi->obi;
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         {
149                 hitco[0] = isect->start[0] + isect->labda*isect->vec[0];
150                 hitco[1] = isect->start[1] + isect->labda*isect->vec[1];
151                 hitco[2] = isect->start[2] + isect->labda*isect->vec[2];
152                 return 1;
153         } else {
154                 return 0;
155         }
156 }
157
158 static void shade_intersection(ShadeInput *shi, float *col, 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         VECCOPY(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         VecCopyf(col, shr_new.combined);
188         col[3] = shr_new.alpha;
189 }
190
191 static void vol_trace_behind(ShadeInput *shi, VlakRen *vlr, float *co, float *col)
192 {
193         Isect isect;
194         
195         VECCOPY(isect.start, co);
196         VECCOPY(isect.vec, shi->view);
197         isect.labda = FLT_MAX;
198         
199         isect.mode= RE_RAY_MIRROR;
200         isect.skip = RE_SKIP_VLR_NEIGHBOUR | RE_SKIP_VLR_RENDER_CHECK;
201         isect.orig.ob = (void*) shi->obi;
202         isect.orig.face = (void*)vlr;
203         isect.last_hit = NULL;
204         isect.lay= -1;
205         
206         /* check to see if there's anything behind the volume, otherwise shade the sky */
207         if(RE_rayobject_raycast(R.raytree, &isect)) {
208                 shade_intersection(shi, col, &isect);
209         } else {
210                 shadeSkyView(col, co, shi->view, NULL, shi->thread);
211                 shadeSunView(col, shi->view);
212         }
213 }
214
215
216 /* trilinear interpolation */
217 static void vol_get_precached_scattering(ShadeInput *shi, float *scatter_col, float *co)
218 {
219         VolumePrecache *vp = shi->obi->volume_precache;
220         float bbmin[3], bbmax[3], dim[3];
221         float sample_co[3];
222         
223         if (!vp) return;
224         
225         /* convert input coords to 0.0, 1.0 */
226         VECCOPY(bbmin, shi->obi->obr->boundbox[0]);
227         VECCOPY(bbmax, shi->obi->obr->boundbox[1]);
228         VecSubf(dim, bbmax, bbmin);
229
230         sample_co[0] = ((co[0] - bbmin[0]) / dim[0]);
231         sample_co[1] = ((co[1] - bbmin[1]) / dim[1]);
232         sample_co[2] = ((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         Mat4MulMat4(mat, ob->obmat, R.viewmat);
250         Mat4Invert(imat, mat);
251         Mat4MulVecfl(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                 QuatToMat3(ml->quat, bmat);
259                 Mat3Transp(bmat);       // rot.only, so inverse == transpose
260                 Mat3MulVecfl(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 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 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 colour, 
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 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 float vol_get_phasefunc(ShadeInput *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 * Inpf(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 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] *= exp(-tau[0]);
426         tr[1] *= exp(-tau[1]);
427         tr[2] *= exp(-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(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         VecMulf(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, co);
453                 
454                 tau[0] += stepd * sigma_t[0];
455                 tau[1] += stepd * sigma_t[1];
456                 tau[2] += stepd * sigma_t[2];
457                 
458                 VecAddf(p, 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 void vol_shade_one_lamp(struct ShadeInput *shi, float *co, 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.0) return;
477         
478         if ((visifac= lamp_get_visibility(lar, co, lv, &lampdist)) == 0.f) return;
479         
480         VecCopyf(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         VecMulf(lacol, visifac);
488
489         if (ELEM(lar->type, LA_SUN, LA_HEMI))
490                 VECCOPY(lv, lar->vec);
491         VecMulf(lv, -1.0f);
492         
493         if (shi->mat->vol.shade_type == MA_VOL_SHADE_SHADOWED) {
494                 VecMulf(lacol, vol_get_shadow(shi, lar, co));
495         }
496         else if (shi->mat->vol.shade_type == MA_VOL_SHADE_SHADED)
497         {
498                 Isect is;
499                 
500                 if (shi->mat->vol.shadeflag & MA_VOL_RECV_EXT_SHADOW) {
501                         VecMulf(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 = VecLenf(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                         VecMulVecf(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         p = vol_get_phasefunc(shi, shi->mat->vol.asymmetry, shi->view, lv);
538         
539         /* physically based scattering with non-physically based RGB gain */
540         vol_get_reflection_color(shi, ref_col, co);
541         
542         lacol[0] *= p * ref_col[0];
543         lacol[1] *= p * ref_col[1];
544         lacol[2] *= p * ref_col[2];
545 }
546
547 /* single scattering only for now */
548 void vol_get_scattering(ShadeInput *shi, float *scatter_col, float *co)
549 {
550         ListBase *lights;
551         GroupObject *go;
552         LampRen *lar;
553         
554         scatter_col[0] = scatter_col[1] = scatter_col[2] = 0.f;
555         
556         lights= get_lights(shi);
557         for(go=lights->first; go; go= go->next)
558         {
559                 float lacol[3] = {0.f, 0.f, 0.f};
560                 lar= go->lampren;
561                 
562                 if (lar) {
563                         vol_shade_one_lamp(shi, co, lar, lacol);
564                         VecAddf(scatter_col, scatter_col, lacol);
565                 }
566         }
567 }
568
569         
570 /*
571 The main volumetric integrator, using an emission/absorption/scattering model.
572
573 Incoming radiance = 
574
575 outgoing radiance from behind surface * beam transmittance/attenuation
576 + added radiance from all points along the ray due to participating media
577         --> radiance for each segment = 
578                 (radiance added by scattering + radiance added by emission) * beam transmittance/attenuation
579 */
580
581 /* For ease of use, I've also introduced a 'reflection' and 'reflection color' parameter, which isn't 
582  * physically correct. This works as an RGB tint/gain on out-scattered light, but doesn't affect the light 
583  * that is transmitted through the volume. While having wavelength dependent absorption/scattering is more correct,
584  * it also makes it harder to control the overall look of the volume since colouring the outscattered light results
585  * in the inverse colour being transmitted through the rest of the volume.
586  */
587 static void volumeintegrate(struct ShadeInput *shi, float *col, float *co, float *endco)
588 {
589         float radiance[3] = {0.f, 0.f, 0.f};
590         float tr[3] = {1.f, 1.f, 1.f};
591         float p[3] = {co[0], co[1], co[2]};
592         float step_vec[3] = {endco[0] - co[0], endco[1] - co[1], endco[2] - co[2]};
593         const float stepsize = shi->mat->vol.stepsize;
594         
595         float t0 = 0.f;
596         float pt0 = t0;
597         float t1 = Normalize(step_vec); /* returns vector length */
598         
599         t0 += stepsize * ((shi->mat->vol.stepsize_type == MA_VOL_STEP_CONSTANT) ? 0.5f : BLI_thread_frand(shi->thread));
600         p[0] += t0 * step_vec[0];
601         p[1] += t0 * step_vec[1];
602         p[2] += t0 * step_vec[2];
603         VecMulf(step_vec, stepsize);
604         
605         for (; t0 < t1; pt0 = t0, t0 += stepsize) {
606                 const float density = vol_get_density(shi, p);
607                 
608                 if (density > 0.01f) {
609                         float scatter_col[3], emit_col[3];
610                         const float stepd = (t0 - pt0) * density;
611                         
612                         /* transmittance component (alpha) */
613                         vol_get_transmittance_seg(shi, tr, stepsize, co, density);
614                         
615                         if (luminance(tr) < shi->mat->vol.depth_cutoff) break;
616                         
617                         vol_get_emission(shi, emit_col, p);
618                         
619                         if (shi->obi->volume_precache) {
620                                 float p2[3];
621                                 
622                                 p2[0] = p[0] + (step_vec[0] * 0.5);
623                                 p2[1] = p[1] + (step_vec[1] * 0.5);
624                                 p2[2] = p[2] + (step_vec[2] * 0.5);
625                                 
626                                 vol_get_precached_scattering(shi, scatter_col, p2);
627                         } else
628                                 vol_get_scattering(shi, scatter_col, p);
629                         
630                         radiance[0] += stepd * tr[0] * (emit_col[0] + scatter_col[0]);
631                         radiance[1] += stepd * tr[1] * (emit_col[1] + scatter_col[1]);
632                         radiance[2] += stepd * tr[2] * (emit_col[2] + scatter_col[2]);
633                 }
634                 VecAddf(p, p, step_vec);
635         }
636         
637         /* multiply original color (from behind volume) with transmittance over entire distance */
638         VecMulVecf(col, tr, col);
639         VecAddf(col, col, radiance);
640         
641         /* alpha <-- transmission luminance */
642         col[3] = 1.0f - luminance(tr);
643 }
644
645 /* the main entry point for volume shading */
646 static void volume_trace(struct ShadeInput *shi, struct ShadeResult *shr, int inside_volume)
647 {
648         float hitco[3], col[4] = {0.f,0.f,0.f,0.f};
649         float *startco, *endco;
650         int trace_behind = 1;
651         const int ztransp= ((shi->depth==0) && (shi->mat->mode & MA_TRANSP) && (shi->mat->mode & MA_ZTRANSP));
652         Isect is;
653
654         /* check for shading an internal face a volume object directly */
655         if (inside_volume == VOL_SHADE_INSIDE)
656                 trace_behind = 0;
657         else if (inside_volume == VOL_SHADE_OUTSIDE) {
658                 if (shi->flippednor)
659                         inside_volume = VOL_SHADE_INSIDE;
660         }
661         
662         if (ztransp && inside_volume == VOL_SHADE_INSIDE) {
663                 MatInside *mi;
664                 int render_this=0;
665                 
666                 /* don't render the backfaces of ztransp volume materials.
667                  
668                  * volume shading renders the internal volume from between the
669                  * ' view intersection of the solid volume to the
670                  * intersection on the other side, as part of the shading of
671                  * the front face.
672                  
673                  * Because ztransp renders both front and back faces independently
674                  * this will double up, so here we prevent rendering the backface as well, 
675                  * which would otherwise render the volume in between the camera and the backface
676                  * --matt */
677                 
678                 for (mi=R.render_volumes_inside.first; mi; mi=mi->next) {
679                         /* weak... */
680                         if (mi->ma == shi->mat) render_this=1;
681                 }
682                 if (!render_this) return;
683         }
684         
685
686         if (inside_volume == VOL_SHADE_INSIDE)
687         {
688                 startco = shi->camera_co;
689                 endco = shi->co;
690                 
691                 if (trace_behind) {
692                         if (!ztransp)
693                                 /* trace behind the volume object */
694                                 vol_trace_behind(shi, shi->vlr, endco, col);
695                 } else {
696                         /* we're tracing through the volume between the camera 
697                          * and a solid surface, so use that pre-shaded radiance */
698                         QUATCOPY(col, shr->combined);
699                 }
700                 
701                 /* shade volume from 'camera' to 1st hit point */
702                 volumeintegrate(shi, col, startco, endco);
703         }
704         /* trace to find a backface, the other side bounds of the volume */
705         /* (ray intersect ignores front faces here) */
706         else if (vol_get_bounds(shi, shi->co, shi->view, hitco, &is, VOL_BOUNDS_DEPTH))
707         {
708                 VlakRen *vlr = (VlakRen *)is.hit.face;
709                 
710                 startco = shi->co;
711                 endco = hitco;
712                 
713                 if (!ztransp) {
714                         /* if it's another face in the same material */
715                         if (vlr->mat == shi->mat) {
716                                 /* trace behind the 2nd (raytrace) hit point */
717                                 vol_trace_behind(shi, (VlakRen *)is.hit.face, endco, col);
718                         } else {
719                                 shade_intersection(shi, col, &is);
720                         }
721                 }
722                 
723                 /* shade volume from 1st hit point to 2nd hit point */
724                 volumeintegrate(shi, col, startco, endco);
725         }
726         
727         if (ztransp)
728                 col[3] = col[3]>1.f?1.f:col[3];
729         else
730                 col[3] = 1.f;
731         
732         VecCopyf(shr->combined, col);
733         shr->alpha = col[3];
734         
735         VECCOPY(shr->diff, shr->combined);
736 }
737
738 /* Traces a shadow through the object, 
739  * pretty much gets the transmission over a ray path */
740 void shade_volume_shadow(struct ShadeInput *shi, struct ShadeResult *shr, struct Isect *last_is)
741 {
742         float hitco[3];
743         float tr[3] = {1.0,1.0,1.0};
744         Isect is;
745         float *startco, *endco;
746         float density=0.f;
747
748         memset(shr, 0, sizeof(ShadeResult));
749         
750         /* if 1st hit normal is facing away from the camera, 
751          * then we're inside the volume already. */
752         if (shi->flippednor) {
753                 startco = last_is->start;
754                 endco = shi->co;
755         }
756         /* trace to find a backface, the other side bounds of the volume */
757         /* (ray intersect ignores front faces here) */
758         else if (vol_get_bounds(shi, shi->co, shi->view, hitco, &is, VOL_BOUNDS_DEPTH)) {
759                 startco = shi->co;
760                 endco = hitco;
761         }
762         else {
763                 shr->combined[0] = shr->combined[1] = shr->combined[2] = 0.f;
764                 shr->alpha = shr->combined[3] = 1.f;
765                 return;
766         }
767         
768         density = vol_get_density(shi, startco);
769         vol_get_transmittance(shi, tr, startco, endco);
770         
771         VecCopyf(shr->combined, tr);
772         shr->combined[3] = 1.0f - luminance(tr);
773 }
774
775
776 /* delivers a fully filled in ShadeResult, for all passes */
777 void shade_volume_outside(ShadeInput *shi, ShadeResult *shr)
778 {
779         memset(shr, 0, sizeof(ShadeResult));
780         volume_trace(shi, shr, VOL_SHADE_OUTSIDE);
781 }
782
783
784 void shade_volume_inside(ShadeInput *shi, ShadeResult *shr)
785 {
786         MatInside *m;
787         Material *mat_backup;
788         ObjectInstanceRen *obi_backup;
789         float prev_alpha = shr->alpha;
790         
791         //if (BLI_countlist(&R.render_volumes_inside) == 0) return;
792         
793         /* XXX: extend to multiple volumes perhaps later */
794         mat_backup = shi->mat;
795         obi_backup = shi->obi;
796         
797         m = R.render_volumes_inside.first;
798         shi->mat = m->ma;
799         shi->obi = m->obi;
800         shi->obr = m->obi->obr;
801         
802         volume_trace(shi, shr, VOL_SHADE_INSIDE);
803         shr->alpha += prev_alpha;
804         CLAMP(shr->alpha, 0.f, 1.f);
805         
806         shi->mat = mat_backup;
807         shi->obi = obi_backup;
808         shi->obr = obi_backup->obr;
809 }