style cleanup: follow style guide for formatting of if/for/while loops, and else...
[blender.git] / source / blender / render / intern / source / sunsky.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/render/intern/source/sunsky.c
22  *  \ingroup render
23  *
24  * This feature comes from Preetham paper on "A Practical Analytic Model for Daylight"
25  * and example code from Brian Smits, another author of that paper in
26  * http://www.cs.utah.edu/vissim/papers/sunsky/code/
27  */
28
29
30
31 #include "sunsky.h"
32 #include "math.h"
33 #include "BLI_math.h"
34 #include "BKE_global.h"
35
36 /**
37  * These macros are defined for vector operations
38  * */
39
40 /**
41  * compute v1 = v2 op v3
42  * v1, v2 and v3 are vectors contains 3 float
43  * */
44 #define vec3opv(v1, v2, op, v3) \
45         v1[0] = (v2[0] op v3[0]); \
46         v1[1] = (v2[1] op v3[1]);\
47         v1[2] = (v2[2] op v3[2]);
48
49 /**
50  * compute v1 = v2 op f1
51  * v1, v2 are vectors contains 3 float
52  * and f1 is a float
53  * */
54 #define vec3opf(v1, v2, op, f1)\
55         v1[0] = (v2[0] op (f1));\
56         v1[1] = (v2[1] op (f1));\
57         v1[2] = (v2[2] op (f1));
58
59 /**
60  * compute v1 = f1 op v2
61  * v1, v2 are vectors contains 3 float
62  * and f1 is a float
63  * */
64 #define fopvec3(v1, f1, op, v2)\
65         v1[0] = ((f1) op v2[0]);\
66         v1[1] = ((f1) op v2[1]);\
67         v1[2] = ((f1) op v2[2]);
68
69 /**
70  * ClipColor:
71  * clip a color to range [0,1];
72  * */
73 void ClipColor(float c[3])
74 {
75         if (c[0] > 1.0f) c[0] = 1.0f;
76         if (c[0] < 0.0f) c[0] = 0.0f;
77         if (c[1] > 1.0f) c[1] = 1.0f;
78         if (c[1] < 0.0f) c[1] = 0.0f;
79         if (c[2] > 1.0f) c[2] = 1.0f;
80         if (c[2] < 0.0f) c[2] = 0.0f;
81 }
82
83 /**
84  * AngleBetween:
85  * compute angle between to direction 
86  * all angles are in radians
87  * */
88 static float AngleBetween(float thetav, float phiv, float theta, float phi)
89 {
90         float cospsi = sin(thetav) * sin(theta) * cos(phi - phiv) + cos(thetav) * cos(theta);
91
92         if (cospsi > 1.0f)
93                 return 0;
94         if (cospsi < -1.0f)
95                 return M_PI;
96
97         return acos(cospsi);
98 }
99
100 /**
101  * DirectionToThetaPhi:
102  * this function convert a direction to it's theta and phi value
103  * parameters:
104  * toSun: contains direction information
105  * theta, phi, are return values from this conversion
106  * */
107 static void DirectionToThetaPhi(float *toSun, float *theta, float *phi)
108 {
109         *theta = acos(toSun[2]);
110         if (fabs(*theta) < 1e-5)
111                 *phi = 0;
112         else
113                 *phi = atan2(toSun[1], toSun[0]);
114 }
115
116 /**
117  * PerezFunction:
118  * compute perez function value based on input paramters
119  * */
120 static float PerezFunction(struct SunSky *sunsky, const float *lam, float theta, float gamma, float lvz)
121 {
122         float den, num;
123         
124         den = ((1 + lam[0] * expf(lam[1])) *
125                    (1 + lam[2] * expf(lam[3] * sunsky->theta) + lam[4] * cosf(sunsky->theta) * cosf(sunsky->theta)));
126         
127         num = ((1 + lam[0] * expf(lam[1] / cosf(theta))) *
128                    (1 + lam[2] * expf(lam[3] * gamma) + lam[4] * cosf(gamma) * cosf(gamma)));
129         
130         return(lvz * num / den);}
131
132 /**
133  * InitSunSky:
134  * this function compute some sun,sky parameters according to input parameters and also initiate some other sun, sky parameters
135  * parameters:
136  * sunSky, is a structure that contains information about sun, sky and atmosphere, in this function, most of its values initiated
137  * turb, is atmosphere turbidity
138  * toSun, contains sun direction
139  * horizon_brighness, controls the brightness of the horizon colors
140  * spread, controls colors spreed at horizon
141  * sun_brightness, controls sun's brightness
142  * sun_size, controls sun's size
143  * back_scatter, controls back scatter light
144  * */
145 void InitSunSky(struct SunSky *sunsky, float turb, float *toSun, float horizon_brightness, 
146                                 float spread,float sun_brightness, float sun_size, float back_scatter,
147                                 float skyblendfac, short skyblendtype, float sky_exposure, float sky_colorspace)
148 {
149         float theta2;
150         float theta3;
151         float T;
152         float T2;
153         float chi;
154
155         sunsky->turbidity = turb;
156
157         sunsky->horizon_brightness = horizon_brightness;
158         sunsky->spread = spread;
159         sunsky->sun_brightness = sun_brightness;
160         sunsky->sun_size = sun_size;
161         sunsky->backscattered_light = back_scatter;
162         sunsky->skyblendfac= skyblendfac;
163         sunsky->skyblendtype= skyblendtype;
164         sunsky->sky_exposure= -sky_exposure;
165         sunsky->sky_colorspace= sky_colorspace;
166         
167         sunsky->toSun[0] = toSun[0];
168         sunsky->toSun[1] = toSun[1];
169         sunsky->toSun[2] = toSun[2];
170
171         DirectionToThetaPhi(sunsky->toSun, &sunsky->theta, &sunsky->phi);
172
173         sunsky->sunSolidAngle = 0.25 * M_PI * 1.39 * 1.39 / (150 * 150);   // = 6.7443e-05
174
175         theta2 = sunsky->theta*sunsky->theta;
176         theta3 = theta2 * sunsky->theta;
177         T = turb;
178         T2 = turb*turb;
179
180         chi = (4.0f / 9.0f - T / 120.0f) * ((float)M_PI - 2.0f * sunsky->theta);
181         sunsky->zenith_Y = (4.0453f * T - 4.9710f) * tanf(chi) - 0.2155f * T + 2.4192f;
182         sunsky->zenith_Y *= 1000;   // conversion from kcd/m^2 to cd/m^2
183
184         if (sunsky->zenith_Y<=0)
185                 sunsky->zenith_Y = 1e-6;
186         
187         sunsky->zenith_x =
188                 ( + 0.00165f * theta3 - 0.00374f * theta2 + 0.00208f * sunsky->theta + 0.0f) * T2 +
189                 ( -0.02902f * theta3 + 0.06377f * theta2 - 0.03202f * sunsky->theta + 0.00394f) * T +
190                 ( + 0.11693f * theta3 - 0.21196f * theta2 + 0.06052f * sunsky->theta + 0.25885f);
191
192         sunsky->zenith_y =
193                 ( + 0.00275f * theta3 - 0.00610f * theta2 + 0.00316f * sunsky->theta + 0.0f) * T2 +
194                 ( -0.04214f * theta3 + 0.08970f * theta2 - 0.04153f * sunsky->theta + 0.00515f) * T +
195                 ( + 0.15346f * theta3 - 0.26756f * theta2 + 0.06669f * sunsky->theta + 0.26688f);
196
197         
198         sunsky->perez_Y[0] = 0.17872f * T - 1.46303f;
199         sunsky->perez_Y[1] = -0.35540f * T + 0.42749f;
200         sunsky->perez_Y[2] = -0.02266f * T + 5.32505f;
201         sunsky->perez_Y[3] = 0.12064f * T - 2.57705f;
202         sunsky->perez_Y[4] = -0.06696f * T + 0.37027f;
203
204         sunsky->perez_x[0] = -0.01925f * T - 0.25922f;
205         sunsky->perez_x[1] = -0.06651f * T + 0.00081f;
206         sunsky->perez_x[2] = -0.00041f * T + 0.21247f;
207         sunsky->perez_x[3] = -0.06409f * T - 0.89887f;
208         sunsky->perez_x[4] = -0.00325f * T + 0.04517f;
209
210         sunsky->perez_y[0] = -0.01669f * T - 0.26078f;
211         sunsky->perez_y[1] = -0.09495f * T + 0.00921f;
212         sunsky->perez_y[2] = -0.00792f * T + 0.21023f;
213         sunsky->perez_y[3] = -0.04405f * T - 1.65369f;
214         sunsky->perez_y[4] = -0.01092f * T + 0.05291f;
215         
216         /* suggested by glome in 
217          * http://projects.blender.org/tracker/?func=detail&atid=127&aid=8063&group_id=9*/
218         sunsky->perez_Y[0] *= sunsky->horizon_brightness;
219         sunsky->perez_x[0] *= sunsky->horizon_brightness;
220         sunsky->perez_y[0] *= sunsky->horizon_brightness;
221         
222         sunsky->perez_Y[1] *= sunsky->spread;
223         sunsky->perez_x[1] *= sunsky->spread;
224         sunsky->perez_y[1] *= sunsky->spread;
225
226         sunsky->perez_Y[2] *= sunsky->sun_brightness;
227         sunsky->perez_x[2] *= sunsky->sun_brightness;
228         sunsky->perez_y[2] *= sunsky->sun_brightness;
229         
230         sunsky->perez_Y[3] *= sunsky->sun_size;
231         sunsky->perez_x[3] *= sunsky->sun_size;
232         sunsky->perez_y[3] *= sunsky->sun_size;
233         
234         sunsky->perez_Y[4] *= sunsky->backscattered_light;
235         sunsky->perez_x[4] *= sunsky->backscattered_light;
236         sunsky->perez_y[4] *= sunsky->backscattered_light;
237 }
238
239 /**
240  * GetSkyXYZRadiance:
241  * this function compute sky radiance according to a view parameters `theta' and `phi'and sunSky values
242  * parameters:
243  * sunSky, sontains sun and sky parameters
244  * theta, is sun's theta
245  * phi, is sun's phi
246  * color_out, is computed color that shows sky radiance in XYZ color format
247  * */
248 void GetSkyXYZRadiance(struct SunSky* sunsky, float theta, float phi, float color_out[3])
249 {
250         float gamma;
251         float x,y,Y,X,Z;
252         float hfade=1, nfade=1;
253
254
255         if (theta>(0.5f*(float)M_PI)) {
256                 hfade = 1.0f-(theta*(float)M_1_PI-0.5f)*2.0f;
257                 hfade = hfade*hfade*(3.0f-2.0f*hfade);
258                 theta = 0.5*M_PI;
259         }
260
261         if (sunsky->theta>(0.5f*(float)M_PI)) {
262                 if (theta<=0.5f*(float)M_PI) {
263                         nfade = 1.0f-(0.5f-theta*(float)M_1_PI)*2.0f;
264                         nfade *= 1.0f-(sunsky->theta*(float)M_1_PI-0.5f)*2.0f;
265                         nfade = nfade*nfade*(3.0f-2.0f*nfade);
266                 }
267         }
268
269         gamma = AngleBetween(theta, phi, sunsky->theta, sunsky->phi);
270         
271         // Compute xyY values
272         x = PerezFunction(sunsky, sunsky->perez_x, theta, gamma, sunsky->zenith_x);
273         y = PerezFunction(sunsky, sunsky->perez_y, theta, gamma, sunsky->zenith_y);
274         Y = 6.666666667e-5f * nfade * hfade * PerezFunction(sunsky, sunsky->perez_Y, theta, gamma, sunsky->zenith_Y);
275
276         if (sunsky->sky_exposure!=0.0f)
277                 Y = 1.0 - exp(Y*sunsky->sky_exposure);
278         
279         X = (x / y) * Y;
280         Z = ((1 - x - y) / y) * Y;
281
282         color_out[0] = X;
283         color_out[1] = Y;
284         color_out[2] = Z;
285 }
286
287 /**
288  * GetSkyXYZRadiancef:
289  * this function compute sky radiance according to a view direction `varg' and sunSky values
290  * parameters:
291  * sunSky, sontains sun and sky parameters
292  * varg, shows direction
293  * color_out, is computed color that shows sky radiance in XYZ color format
294  * */
295 void GetSkyXYZRadiancef(struct SunSky* sunsky, const float varg[3], float color_out[3])
296 {
297         float   theta, phi;
298         float   v[3];
299
300         copy_v3_v3(v, (float*)varg);
301         normalize_v3(v);
302
303         if (v[2] < 0.001f) {
304                 v[2] = 0.001f;
305                 normalize_v3(v);
306         }
307
308         DirectionToThetaPhi(v, &theta, &phi);
309         GetSkyXYZRadiance(sunsky, theta, phi, color_out);
310 }
311
312 /**
313  * ComputeAttenuatedSunlight:
314  * this function compute attenuated sun light based on sun's theta and atmosphere turbidity
315  * parameters:
316  * theta, is sun's theta
317  * turbidity: is atmosphere turbidity
318  * fTau: contains computed attenuated sun light
319  * */
320 static void ComputeAttenuatedSunlight(float theta, int turbidity, float fTau[3])
321 {
322         float fBeta;
323         float fTauR, fTauA;
324         float m;
325         float fAlpha;
326
327         int i;
328         float fLambda[3]; 
329         fLambda[0] = 0.65f;     
330         fLambda[1] = 0.57f;     
331         fLambda[2] = 0.475f;
332
333         fAlpha = 1.3f;
334         fBeta = 0.04608365822050f * turbidity - 0.04586025928522f;
335         
336         m =  1.0f/(cosf(theta) + 0.15f*powf(93.885f-theta/(float)M_PI*180.0f,-1.253f));
337
338         for (i = 0; i < 3; i++)
339         {
340                 // Rayleigh Scattering
341                 fTauR = expf( -m * 0.008735f * powf(fLambda[i], (float)(-4.08f)));
342
343                 // Aerosal (water + dust) attenuation
344                 fTauA = exp(-m * fBeta * powf(fLambda[i], -fAlpha));
345
346                 fTau[i] = fTauR * fTauA; 
347         }
348 }
349
350 /**
351  * InitAtmosphere:
352  * this function initiate sunSky structure with user input parameters.
353  * parameters:
354  * sunSky, contains information about sun, and in this function some atmosphere parameters will initiated
355  * sun_intens, shows sun intensity value
356  * mief, Mie scattering factor this factor currently call with 1.0 
357  * rayf, Rayleigh scattering factor, this factor currently call with 1.0
358  * inscattf, inscatter light factor that range from 0.0 to 1.0, 0.0 means no inscatter light and 1.0 means full inscatter light
359  * extincf, extinction light factor that range from 0.0 to 1.0, 0.0 means no extinction and 1.0 means full extinction
360  * disf, is distance factor, multiplyed to pixle's z value to compute each pixle's distance to camera, 
361  * */
362 void InitAtmosphere(struct SunSky *sunSky, float sun_intens, float mief, float rayf,
363                                                         float inscattf, float extincf, float disf)
364 {
365         const float pi = 3.14159265358f;
366         const float n = 1.003f; // refractive index
367         const float N = 2.545e25;
368         const float pn = 0.035f;
369         const float T = 2.0f;
370         float fTemp, fTemp2, fTemp3, fBeta, fBetaDash;
371         float c = (6.544f*T - 6.51f)*1e-17f;
372         float K[3] = {0.685f, 0.679f, 0.670f};
373         float vBetaMieTemp[3];
374         
375         float fLambda[3],fLambda2[3], fLambda4[3];
376         float vLambda2[3];
377         float vLambda4[3];
378         
379         int i;
380
381         sunSky->atm_SunIntensity = sun_intens;
382         sunSky->atm_BetaMieMultiplier  = mief;
383         sunSky->atm_BetaRayMultiplier = rayf;
384         sunSky->atm_InscatteringMultiplier = inscattf;
385         sunSky->atm_ExtinctionMultiplier = extincf;
386         sunSky->atm_DistanceMultiplier = disf;
387                 
388         sunSky->atm_HGg=0.8;
389
390         fLambda[0]  = 1/650e-9f; 
391         fLambda[1]  = 1/570e-9f;
392         fLambda[2]  = 1/475e-9f;
393         for (i=0; i < 3; i++)
394         {
395                 fLambda2[i] = fLambda[i]*fLambda[i];
396                 fLambda4[i] = fLambda2[i]*fLambda2[i];
397         }
398
399         vLambda2[0] = fLambda2[0];
400         vLambda2[1] = fLambda2[1];
401         vLambda2[2] = fLambda2[2];
402  
403         vLambda4[0] = fLambda4[0];
404         vLambda4[1] = fLambda4[1];
405         vLambda4[2] = fLambda4[2];
406
407         // Rayleigh scattering constants.
408         fTemp = pi*pi*(n*n-1)*(n*n-1)*(6+3*pn)/(6-7*pn)/N;
409         fBeta = 8*fTemp*pi/3;
410                 
411         vec3opf(sunSky->atm_BetaRay, vLambda4, *, fBeta);
412         fBetaDash = fTemp/2;
413         vec3opf(sunSky->atm_BetaDashRay, vLambda4,*, fBetaDash);
414         
415
416         // Mie scattering constants.
417         fTemp2 = 0.434f*c*(2*pi)*(2*pi)*0.5f;
418         vec3opf(sunSky->atm_BetaDashMie, vLambda2, *, fTemp2);
419         
420         fTemp3 = 0.434f*c*pi*(2*pi)*(2*pi);
421         
422         vec3opv(vBetaMieTemp, K, *, fLambda);
423         vec3opf(sunSky->atm_BetaMie, vBetaMieTemp,*, fTemp3);
424         
425 }
426
427 /**
428  * AtmospherePixleShader:
429  * this function apply atmosphere effect on a pixle color `rgb' at distance `s'
430  * parameters:
431  * sunSky, contains information about sun parameters and user values
432  * view, is camera view vector
433  * s, is distance 
434  * rgb, contains rendered color value for a pixle
435  * */
436 void AtmospherePixleShader( struct SunSky* sunSky, float view[3], float s, float rgb[3])
437 {
438         float costheta;
439         float Phase_1;
440         float Phase_2;
441         float sunColor[3];
442         
443         float E[3];
444         float E1[3];
445         
446         
447         float I[3];
448         float fTemp;
449         float vTemp1[3], vTemp2[3];
450
451         float sunDirection[3];
452         
453         s *= sunSky->atm_DistanceMultiplier;
454         
455         sunDirection[0] = sunSky->toSun[0];
456         sunDirection[1] = sunSky->toSun[1];
457         sunDirection[2] = sunSky->toSun[2];
458         
459         costheta = dot_v3v3(view, sunDirection); // cos(theta)
460         Phase_1 = 1 + (costheta * costheta); // Phase_1
461         
462         vec3opf(sunSky->atm_BetaRay, sunSky->atm_BetaRay, *, sunSky->atm_BetaRayMultiplier);
463         vec3opf(sunSky->atm_BetaMie, sunSky->atm_BetaMie, *, sunSky->atm_BetaMieMultiplier);
464         vec3opv(sunSky->atm_BetaRM, sunSky->atm_BetaRay, +, sunSky->atm_BetaMie);
465         
466         //e^(-(beta_1 + beta_2) * s) = E1
467         vec3opf(E1, sunSky->atm_BetaRM, *, -s/(float)M_LN2);
468         E1[0] = exp(E1[0]);
469         E1[1] = exp(E1[1]);
470         E1[2] = exp(E1[2]);
471
472         copy_v3_v3(E, E1);
473                 
474         //Phase2(theta) = (1-g^2)/(1+g-2g*cos(theta))^(3/2)
475         fTemp = 1 + sunSky->atm_HGg - 2 * sunSky->atm_HGg * costheta;
476         fTemp = fTemp * sqrtf(fTemp);
477         Phase_2 = (1 - sunSky->atm_HGg * sunSky->atm_HGg)/fTemp;
478         
479         vec3opf(vTemp1, sunSky->atm_BetaDashRay, *, Phase_1);
480         vec3opf(vTemp2, sunSky->atm_BetaDashMie, *, Phase_2);   
481
482         vec3opv(vTemp1, vTemp1, +, vTemp2);
483         fopvec3(vTemp2, 1.0f, -, E1);
484         vec3opv(vTemp1, vTemp1, *, vTemp2);
485
486         fopvec3(vTemp2, 1.0f, / , sunSky->atm_BetaRM);
487
488         vec3opv(I, vTemp1, *, vTemp2);
489                 
490         vec3opf(I, I, *, sunSky->atm_InscatteringMultiplier);
491         vec3opf(E, E, *, sunSky->atm_ExtinctionMultiplier);
492                 
493         //scale to color sun
494         ComputeAttenuatedSunlight(sunSky->theta, sunSky->turbidity, sunColor);
495         vec3opv(E, E, *, sunColor);
496
497         vec3opf(I, I, *, sunSky->atm_SunIntensity);
498
499         vec3opv(rgb, rgb, *, E);
500         vec3opv(rgb, rgb, +, I);
501 }
502
503 #undef vec3opv
504 #undef vec3opf
505 #undef fopvec3
506
507 /* EOF */