Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / intern / cycles / kernel / osl / bsdf_westin.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 class WestinBackscatterClosure : public BSDFClosure {
46 public:
47     Vec3 m_N;
48     float m_roughness;
49     float m_invroughness;
50     WestinBackscatterClosure() : BSDFClosure(Labels::GLOSSY) { }
51
52     void setup()
53     {
54                 m_roughness = clamp(m_roughness, 1e-5f, 1.0f);
55         m_invroughness = m_roughness > 0 ? 1 / m_roughness : 0;
56     }
57
58     bool mergeable (const ClosurePrimitive *other) const {
59         const WestinBackscatterClosure *comp = (const WestinBackscatterClosure *)other;
60         return m_N == comp->m_N && m_roughness == comp->m_roughness &&
61             BSDFClosure::mergeable(other);
62     }
63
64     size_t memsize () const { return sizeof(*this); }
65
66     const char *name () const { return "westin_backscatter"; }
67
68     void print_on (std::ostream &out) const
69     {
70         out << name() << " (";
71         out << "(" << m_N[0] << ", " << m_N[1] << ", " << m_N[2] << "), ";
72         out << m_roughness;
73         out << ")";
74     }
75
76     float albedo (const Vec3 &omega_out) const
77     {
78         return 1.0f;
79     }
80
81     Color3 eval_reflect (const Vec3 &omega_out, const Vec3 &omega_in, float &pdf) const
82     {
83         // pdf is implicitly 0 (no indirect sampling)
84         float cosNO = m_N.dot(omega_out);
85         float cosNI = m_N.dot(omega_in);
86         if (cosNO > 0 && cosNI > 0) {
87             float cosine = omega_out.dot(omega_in);
88             pdf = cosine > 0 ? (m_invroughness + 1) * powf(cosine, m_invroughness) : 0;
89             pdf *= 0.5f * float(M_1_PI);
90             return Color3 (pdf, pdf, pdf);
91         }
92         return Color3 (0, 0, 0);
93     }
94
95     Color3 eval_transmit (const Vec3 &omega_out, const Vec3 &omega_in, float &pdf) const
96     {
97         return Color3 (0, 0, 0);
98     }
99
100     ustring sample (const Vec3 &Ng,
101                  const Vec3 &omega_out, const Vec3 &domega_out_dx, const Vec3 &domega_out_dy,
102                  float randu, float randv,
103                  Vec3 &omega_in, Vec3 &domega_in_dx, Vec3 &domega_in_dy,
104                  float &pdf, Color3 &eval) const
105     {
106         float cosNO = m_N.dot(omega_out);
107         if (cosNO > 0) {
108             domega_in_dx = domega_out_dx;
109             domega_in_dy = domega_out_dy;
110             Vec3 T, B;
111             make_orthonormals (omega_out, T, B);
112             float phi = 2 * (float) M_PI * randu;
113             float cosTheta = powf(randv, 1 / (m_invroughness + 1));
114             float sinTheta2 = 1 - cosTheta * cosTheta;
115             float sinTheta = sinTheta2 > 0 ? sqrtf(sinTheta2) : 0;
116             omega_in = (cosf(phi) * sinTheta) * T +
117                        (sinf(phi) * sinTheta) * B +
118                        (            cosTheta) * omega_out;
119             if (Ng.dot(omega_in) > 0)
120             {
121                 // common terms for pdf and eval
122                 float cosNI = m_N.dot(omega_in);
123                 // make sure the direction we chose is still in the right hemisphere
124                 if (cosNI > 0)
125                 {
126                     pdf = 0.5f * (float) M_1_PI * powf(cosTheta, m_invroughness);
127                     pdf = (m_invroughness + 1) * pdf;
128                     eval.setValue(pdf, pdf, pdf);
129                     // Since there is some blur to this reflection, make the
130                     // derivatives a bit bigger. In theory this varies with the
131                     // exponent but the exact relationship is complex and
132                     // requires more ops than are practical.
133                     domega_in_dx *= 10;
134                     domega_in_dy *= 10;
135                 }
136             }
137         }
138         return Labels::REFLECT;
139     }
140
141 };
142
143
144 class WestinSheenClosure : public BSDFClosure {
145 public:
146     Vec3 m_N;
147     float m_edginess;
148 //    float m_normalization;
149     WestinSheenClosure() : BSDFClosure(Labels::DIFFUSE) { }
150
151     void setup() {};
152
153     bool mergeable (const ClosurePrimitive *other) const {
154         const WestinSheenClosure *comp = (const WestinSheenClosure *)other;
155         return m_N == comp->m_N && m_edginess == comp->m_edginess &&
156             BSDFClosure::mergeable(other);
157     }
158
159     size_t memsize () const { return sizeof(*this); }
160
161     const char *name () const { return "westin_sheen"; }
162
163     void print_on (std::ostream &out) const
164     {
165         out << name() << " (";
166         out << "(" << m_N[0] << ", " << m_N[1] << ", " << m_N[2] << "), ";
167         out << m_edginess;
168         out << ")";
169     }
170
171     float albedo (const Vec3 &omega_out) const
172     {
173         return 1.0f;
174     }
175
176     Color3 eval_reflect (const Vec3 &omega_out, const Vec3 &omega_in, float &pdf) const
177     {
178         // pdf is implicitly 0 (no indirect sampling)
179         float cosNO = m_N.dot(omega_out);
180         float cosNI = m_N.dot(omega_in);
181         if (cosNO > 0 && cosNI > 0) {
182             float sinNO2 = 1 - cosNO * cosNO;
183             pdf = cosNI * float(M_1_PI);
184             float westin = sinNO2 > 0 ? powf(sinNO2, 0.5f * m_edginess) * pdf : 0;
185             return Color3 (westin, westin, westin);
186         }
187         return Color3 (0, 0, 0);
188     }
189
190     Color3 eval_transmit (const Vec3 &omega_out, const Vec3 &omega_in, float &pdf) const
191     {
192         return Color3 (0, 0, 0);
193     }
194
195     ustring sample (const Vec3 &Ng,
196                  const Vec3 &omega_out, const Vec3 &domega_out_dx, const Vec3 &domega_out_dy,
197                  float randu, float randv,
198                  Vec3 &omega_in, Vec3 &domega_in_dx, Vec3 &domega_in_dy,
199                  float &pdf, Color3 &eval) const
200     {
201         // we are viewing the surface from the right side - send a ray out with cosine
202         // distribution over the hemisphere
203         sample_cos_hemisphere (m_N, omega_out, randu, randv, omega_in, pdf);
204         if (Ng.dot(omega_in) > 0) {
205             // TODO: account for sheen when sampling
206             float cosNO = m_N.dot(omega_out);
207             float sinNO2 = 1 - cosNO * cosNO;
208             float westin = sinNO2 > 0 ? powf(sinNO2, 0.5f * m_edginess) * pdf : 0;
209             eval.setValue(westin, westin, westin);
210             // TODO: find a better approximation for the diffuse bounce
211             domega_in_dx = (2 * m_N.dot(domega_out_dx)) * m_N - domega_out_dx;
212             domega_in_dy = (2 * m_N.dot(domega_out_dy)) * m_N - domega_out_dy;
213             domega_in_dx *= 125;
214             domega_in_dy *= 125;
215         } else
216             pdf = 0;
217         return Labels::REFLECT;
218     }
219 };
220
221
222
223 ClosureParam bsdf_westin_backscatter_params[] = {
224     CLOSURE_VECTOR_PARAM(WestinBackscatterClosure, m_N),
225     CLOSURE_FLOAT_PARAM (WestinBackscatterClosure, m_roughness),
226     CLOSURE_STRING_KEYPARAM("label"),
227     CLOSURE_FINISH_PARAM(WestinBackscatterClosure) };
228
229 ClosureParam bsdf_westin_sheen_params[] = {
230     CLOSURE_VECTOR_PARAM(WestinSheenClosure, m_N),
231     CLOSURE_FLOAT_PARAM (WestinSheenClosure, m_edginess),
232     CLOSURE_STRING_KEYPARAM("label"),
233     CLOSURE_FINISH_PARAM(WestinSheenClosure) };
234
235 CLOSURE_PREPARE(bsdf_westin_backscatter_prepare, WestinBackscatterClosure)
236 CLOSURE_PREPARE(bsdf_westin_sheen_prepare,        WestinSheenClosure)
237
238 CCL_NAMESPACE_END
239