526c03557f7063256faa2cac82739a92e86be496
[blender.git] / intern / cycles / kernel / osl / osl_closures.h
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 #ifndef __OSL_CLOSURES_H__
34 #define __OSL_CLOSURES_H__
35
36 #include "util_types.h"
37 #include "kernel_types.h"
38
39 #include <OSL/oslclosure.h>
40 #include <OSL/oslexec.h>
41 #include <OSL/genclosure.h>
42
43 CCL_NAMESPACE_BEGIN
44
45 OSL::ClosureParam *closure_emission_params();
46 OSL::ClosureParam *closure_background_params();
47 OSL::ClosureParam *closure_holdout_params();
48 OSL::ClosureParam *closure_ambient_occlusion_params();
49 OSL::ClosureParam *closure_bsdf_diffuse_ramp_params();
50 OSL::ClosureParam *closure_bsdf_phong_ramp_params();
51 OSL::ClosureParam *closure_bssrdf_cubic_params();
52 OSL::ClosureParam *closure_bssrdf_gaussian_params();
53 OSL::ClosureParam *closure_bssrdf_burley_params();
54 OSL::ClosureParam *closure_henyey_greenstein_volume_params();
55
56 void closure_emission_prepare(OSL::RendererServices *, int id, void *data);
57 void closure_background_prepare(OSL::RendererServices *, int id, void *data);
58 void closure_holdout_prepare(OSL::RendererServices *, int id, void *data);
59 void closure_ambient_occlusion_prepare(OSL::RendererServices *, int id, void *data);
60 void closure_bsdf_diffuse_ramp_prepare(OSL::RendererServices *, int id, void *data);
61 void closure_bsdf_phong_ramp_prepare(OSL::RendererServices *, int id, void *data);
62 void closure_bssrdf_cubic_prepare(OSL::RendererServices *, int id, void *data);
63 void closure_bssrdf_gaussian_prepare(OSL::RendererServices *, int id, void *data);
64 void closure_bssrdf_burley_prepare(OSL::RendererServices *, int id, void *data);
65 void closure_henyey_greenstein_volume_prepare(OSL::RendererServices *, int id, void *data);
66
67 #define CCLOSURE_PREPARE(name, classname)          \
68 void name(RendererServices *, int id, void *data) \
69 {                                                 \
70         memset(data, 0, sizeof(classname));           \
71         new (data) classname();                       \
72 }
73
74 #define CCLOSURE_PREPARE_STATIC(name, classname) static CCLOSURE_PREPARE(name, classname)
75
76 #define CLOSURE_FLOAT3_PARAM(st, fld) \
77         { TypeDesc::TypeVector, (int)reckless_offsetof(st, fld), NULL, sizeof(OSL::Vec3) }
78
79 #define TO_VEC3(v) OSL::Vec3(v.x, v.y, v.z)
80 #define TO_COLOR3(v) OSL::Color3(v.x, v.y, v.z)
81 #define TO_FLOAT3(v) make_float3(v[0], v[1], v[2])
82
83 #if OSL_LIBRARY_VERSION_CODE < 10700
84 #  undef CLOSURE_STRING_KEYPARAM
85 #  define CLOSURE_STRING_KEYPARAM(st, fld, key) { TypeDesc::TypeString, 0, key, 0 }
86 #endif
87
88 /* Closure */
89
90 class CClosurePrimitive {
91 public:
92         enum Category {
93                 BSDF,             ///< Reflective and/or transmissive surface
94                 BSSRDF,           ///< Sub-surface light transfer
95                 Emissive,         ///< Light emission
96                 Background,       ///< Background emission
97                 Volume,           ///< Volume scattering
98                 Holdout,          ///< Holdout from alpha
99                 AmbientOcclusion, ///< Ambient occlusion
100         };
101
102         CClosurePrimitive (Category category_) : category (category_) {}
103         virtual ~CClosurePrimitive() {}
104         virtual void setup() {}
105
106         Category category;
107
108 #if OSL_LIBRARY_VERSION_CODE >= 10700
109         OSL::ustring label;
110 #endif
111 };
112
113 /* BSDF */
114
115 class CBSDFClosure : public CClosurePrimitive {
116 public:
117         ShaderClosure sc;
118
119         CBSDFClosure(int scattering) : CClosurePrimitive(BSDF),
120           m_scattering_label(scattering), m_shaderdata_flag(0)
121         {}
122
123         int scattering() const { return m_scattering_label; }
124         int shaderdata_flag() const { return m_shaderdata_flag; }
125
126         virtual void blur(float roughness) = 0;
127         virtual float3 eval_reflect(const float3 &omega_out, const float3 &omega_in, float &pdf) const = 0;
128         virtual float3 eval_transmit(const float3 &omega_out, const float3 &omega_in, float &pdf) const = 0;
129
130         virtual int sample(const float3 &Ng,
131                            const float3 &omega_out, const float3 &domega_out_dx, const float3 &domega_out_dy,
132                            float randu, float randv,
133                            float3 &omega_in, float3 &domega_in_dx, float3 &domega_in_dy,
134                            float &pdf, float3 &eval) const = 0;
135
136 protected:
137         int m_scattering_label;
138         int m_shaderdata_flag;
139 };
140
141 #define BSDF_CLOSURE_CLASS_BEGIN(Upper, lower, svmlower, TYPE) \
142 \
143 class Upper##Closure : public CBSDFClosure { \
144 public: \
145         Upper##Closure() : CBSDFClosure(TYPE) \
146         { \
147         } \
148 \
149         void setup() \
150         { \
151                 sc.prim = NULL; \
152                 m_shaderdata_flag = bsdf_##lower##_setup(&sc); \
153         } \
154 \
155         void blur(float roughness) \
156         { \
157         } \
158 \
159         float3 eval_reflect(const float3 &omega_out, const float3 &omega_in, float& pdf) const \
160         { \
161                 pdf = 0.0f; \
162                 return make_float3(0.0f, 0.0f, 0.0f); \
163         } \
164 \
165         float3 eval_transmit(const float3 &omega_out, const float3 &omega_in, float& pdf) const \
166         { \
167                 pdf = 0.0f; \
168                 return make_float3(0.0f, 0.0f, 0.0f); \
169         } \
170 \
171         int sample(const float3 &Ng, \
172                    const float3 &omega_out, const float3 &domega_out_dx, const float3 &domega_out_dy, \
173                    float randu, float randv, \
174                    float3 &omega_in, float3 &domega_in_dx, float3 &domega_in_dy, \
175                    float &pdf, float3 &eval) const \
176         { \
177                 pdf = 0; \
178                 return LABEL_NONE; \
179         } \
180 }; \
181 \
182 static ClosureParam *bsdf_##lower##_params() \
183 { \
184         static ClosureParam params[] = {
185
186 /* parameters */
187
188 #define BSDF_CLOSURE_CLASS_END(Upper, lower) \
189                 CLOSURE_STRING_KEYPARAM(Upper##Closure, label, "label"), \
190                 CLOSURE_FINISH_PARAM(Upper##Closure) \
191         }; \
192         return params; \
193 } \
194 \
195 CCLOSURE_PREPARE_STATIC(bsdf_##lower##_prepare, Upper##Closure)
196
197
198 /* Volume */
199
200 class CVolumeClosure : public CClosurePrimitive {
201 public:
202         ShaderClosure sc;
203
204         CVolumeClosure(int scattering) : CClosurePrimitive(Volume),
205           m_scattering_label(scattering), m_shaderdata_flag(0)
206         {}
207         ~CVolumeClosure() { }
208
209         int scattering() const { return m_scattering_label; }
210         int shaderdata_flag() const { return m_shaderdata_flag; }
211
212 protected:
213         int m_scattering_label;
214         int m_shaderdata_flag;
215 };
216
217 #define VOLUME_CLOSURE_CLASS_BEGIN(Upper, lower, TYPE) \
218 \
219 class Upper##Closure : public CVolumeClosure { \
220 public: \
221         Upper##Closure() : CVolumeClosure(TYPE) {} \
222 \
223         void setup() \
224         { \
225                 sc.prim = NULL; \
226                 m_shaderdata_flag = volume_##lower##_setup(&sc); \
227         } \
228 }; \
229 \
230 static ClosureParam *volume_##lower##_params() \
231 { \
232         static ClosureParam params[] = {
233
234 /* parameters */
235
236 #define VOLUME_CLOSURE_CLASS_END(Upper, lower) \
237                 CLOSURE_STRING_KEYPARAM(Upper##Closure, label, "label"), \
238                 CLOSURE_FINISH_PARAM(Upper##Closure) \
239         }; \
240         return params; \
241 } \
242 \
243 CCLOSURE_PREPARE_STATIC(volume_##lower##_prepare, Upper##Closure)
244
245 CCL_NAMESPACE_END
246
247 #endif /* __OSL_CLOSURES_H__ */
248