Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / intern / cycles / kernel / osl / bsdf_ward.cpp
1 /*
2  * Adapted from Open Shading Language with this license:
3  *
4  * Copyright (c) 2009-2010 Sony Pictures Imageworks Inc., et al.
5  * All Rights Reserved.
6  *
7  * Modifications Copyright 2011, Blender Foundation.
8  * 
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are
11  * met:
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in the
16  *   documentation and/or other materials provided with the distribution.
17  * * Neither the name of Sony Pictures Imageworks nor the names of its
18  *   contributors may be used to endorse or promote products derived from
19  *   this software without specific prior written permission.
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #include <OpenImageIO/fmath.h>
34
35 #include <OSL/genclosure.h>
36
37 #include "osl_closures.h"
38
39 #include "util_math.h"
40
41 CCL_NAMESPACE_BEGIN
42
43 using namespace OSL;
44
45 // anisotropic ward - leaks energy at grazing angles
46 // see http://www.graphics.cornell.edu/~bjw/wardnotes.pdf 
47 class WardClosure : public BSDFClosure {
48 public:
49     Vec3 m_N;
50     Vec3 m_T;
51     float m_ax, m_ay;
52     WardClosure() : BSDFClosure(Labels::GLOSSY) { }
53
54     void setup()
55         {
56                 m_ax = clamp(m_ax, 1e-5f, 1.0f);
57                 m_ay = clamp(m_ay, 1e-5f, 1.0f);
58         }
59
60     bool mergeable (const ClosurePrimitive *other) const {
61         const WardClosure *comp = (const WardClosure *)other;
62         return m_N == comp->m_N && m_T == comp->m_T &&
63             m_ax == comp->m_ax && m_ay == comp->m_ay &&
64             BSDFClosure::mergeable(other);
65     }
66
67     size_t memsize () const { return sizeof(*this); }
68
69     const char *name () const { return "ward"; }
70
71     void print_on (std::ostream &out) const {
72         out << name() << " ((";
73         out << m_N[0] << ", " << m_N[1] << ", " << m_N[2] << "), (";
74         out << m_T[0] << ", " << m_T[1] << ", " << m_T[2] << "), ";
75         out << m_ax << ", " << m_ay << ")";
76     }
77
78     float albedo (const Vec3 &omega_out) const
79     {
80         return 1.0f;
81     }
82
83     Color3 eval_reflect (const Vec3 &omega_out, const Vec3 &omega_in, float& pdf) const
84     {
85         float cosNO = m_N.dot(omega_out);
86         float cosNI = m_N.dot(omega_in);
87         if (cosNI > 0 && cosNO > 0) {
88             // get half vector and get x,y basis on the surface for anisotropy
89             Vec3 H = omega_in + omega_out;
90             H.normalize();  // normalize needed for pdf
91             Vec3 X, Y;
92             make_orthonormals(m_N, m_T, X, Y);
93             // eq. 4
94             float dotx = H.dot(X) / m_ax;
95             float doty = H.dot(Y) / m_ay;
96             float dotn = H.dot(m_N);
97             float exp_arg = (dotx * dotx + doty * doty) / (dotn * dotn);
98             float denom = (4 * (float) M_PI * m_ax * m_ay * sqrtf(cosNO * cosNI));
99             float exp_val = expf(-exp_arg);
100             float out = cosNI * exp_val / denom;
101             float oh = H.dot(omega_out);
102             denom = 4 * (float) M_PI * m_ax * m_ay * oh * dotn * dotn * dotn;
103             pdf = exp_val / denom;
104             return Color3 (out, out, out);
105         }
106         return Color3 (0, 0, 0);
107     }
108
109     Color3 eval_transmit (const Vec3 &omega_out, const Vec3 &omega_in, float& pdf) const
110     {
111         return Color3 (0, 0, 0);
112     }
113
114     ustring sample (const Vec3 &Ng,
115                  const Vec3 &omega_out, const Vec3 &domega_out_dx, const Vec3 &domega_out_dy,
116                  float randu, float randv,
117                  Vec3 &omega_in, Vec3 &domega_in_dx, Vec3 &domega_in_dy,
118                  float &pdf, Color3 &eval) const
119     {
120         float cosNO = m_N.dot(omega_out);
121         if (cosNO > 0) {
122             // get x,y basis on the surface for anisotropy
123             Vec3 X, Y;
124             make_orthonormals(m_N, m_T, X, Y);
125             // generate random angles for the half vector
126             // eq. 7 (taking care around discontinuities to keep
127             //        output angle in the right quadrant)
128             // we take advantage of cos(atan(x)) == 1/sqrt(1+x^2)
129             //                  and sin(atan(x)) == x/sqrt(1+x^2)
130             float alphaRatio = m_ay / m_ax;
131             float cosPhi, sinPhi;
132             if (randu < 0.25f) {
133                 float val = 4 * randu;
134                 float tanPhi = alphaRatio * tanf((float) M_PI_2 * val);
135                 cosPhi = 1 / sqrtf(1 + tanPhi * tanPhi);
136                 sinPhi = tanPhi * cosPhi;
137             } else if (randu < 0.5) {
138                 float val = 1 - 4 * (0.5f - randu);
139                 float tanPhi = alphaRatio * tanf((float) M_PI_2 * val);
140                 // phi = (float) M_PI - phi;
141                 cosPhi = -1 / sqrtf(1 + tanPhi * tanPhi);
142                 sinPhi = -tanPhi * cosPhi;
143             } else if (randu < 0.75f) {
144                 float val = 4 * (randu - 0.5f);
145                 float tanPhi = alphaRatio * tanf((float) M_PI_2 * val);
146                 //phi = (float) M_PI + phi;
147                 cosPhi = -1 / sqrtf(1 + tanPhi * tanPhi);
148                 sinPhi = tanPhi * cosPhi;
149             } else {
150                 float val = 1 - 4 * (1 - randu);
151                 float tanPhi = alphaRatio * tanf((float) M_PI_2 * val);
152                 // phi = 2 * (float) M_PI - phi;
153                 cosPhi = 1 / sqrtf(1 + tanPhi * tanPhi);
154                 sinPhi = -tanPhi * cosPhi;
155             }
156             // eq. 6
157             // we take advantage of cos(atan(x)) == 1/sqrt(1+x^2)
158             //                  and sin(atan(x)) == x/sqrt(1+x^2)
159             float thetaDenom = (cosPhi * cosPhi) / (m_ax * m_ax) + (sinPhi * sinPhi) / (m_ay * m_ay);
160             float tanTheta2 = -logf(1 - randv) / thetaDenom;
161             float cosTheta  = 1 / sqrtf(1 + tanTheta2);
162             float sinTheta  = cosTheta * sqrtf(tanTheta2);
163
164             Vec3 h; // already normalized becaused expressed from spherical coordinates
165             h.x = sinTheta * cosPhi;
166             h.y = sinTheta * sinPhi;
167             h.z = cosTheta;
168             // compute terms that are easier in local space
169             float dotx = h.x / m_ax;
170             float doty = h.y / m_ay;
171             float dotn = h.z;
172             // transform to world space
173             h = h.x * X + h.y * Y + h.z * m_N;
174             // generate the final sample
175             float oh = h.dot(omega_out);
176             omega_in.x = 2 * oh * h.x - omega_out.x;
177             omega_in.y = 2 * oh * h.y - omega_out.y;
178             omega_in.z = 2 * oh * h.z - omega_out.z;
179             if (Ng.dot(omega_in) > 0) {
180                 float cosNI = m_N.dot(omega_in);
181                 if (cosNI > 0) {
182                     // eq. 9
183                     float exp_arg = (dotx * dotx + doty * doty) / (dotn * dotn);
184                     float denom = 4 * (float) M_PI * m_ax * m_ay * oh * dotn * dotn * dotn;
185                     pdf = expf(-exp_arg) / denom;
186                     // compiler will reuse expressions already computed
187                     denom = (4 * (float) M_PI * m_ax * m_ay * sqrtf(cosNO * cosNI));
188                     float power = cosNI * expf(-exp_arg) / denom;
189                     eval.setValue(power, power, power);
190                     domega_in_dx = (2 * m_N.dot(domega_out_dx)) * m_N - domega_out_dx;
191                     domega_in_dy = (2 * m_N.dot(domega_out_dy)) * m_N - domega_out_dy;
192
193                                         /* disabled for now - gives texture filtering problems */
194 #if 0
195                     // Since there is some blur to this reflection, make the
196                     // derivatives a bit bigger. In theory this varies with the
197                     // roughness but the exact relationship is complex and
198                     // requires more ops than are practical.
199                     domega_in_dx *= 10;
200                     domega_in_dy *= 10;
201 #endif
202                 }
203             }
204         }
205         return Labels::REFLECT;
206     }
207 };
208
209
210
211 ClosureParam bsdf_ward_params[] = {
212     CLOSURE_VECTOR_PARAM(WardClosure, m_N),
213     CLOSURE_VECTOR_PARAM(WardClosure, m_T),
214     CLOSURE_FLOAT_PARAM (WardClosure, m_ax),
215     CLOSURE_FLOAT_PARAM (WardClosure, m_ay),
216     CLOSURE_STRING_KEYPARAM("label"),
217     CLOSURE_FINISH_PARAM(WardClosure) };
218
219 CLOSURE_PREPARE(bsdf_ward_prepare, WardClosure)
220
221 CCL_NAMESPACE_END
222