Cycles / OSL:
[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 <OSL/oslclosure.h>
37 #include <OSL/oslexec.h>
38 #include <OSL/genclosure.h>
39
40 #include "kernel_types.h"
41
42 #include "util_types.h"
43
44 CCL_NAMESPACE_BEGIN
45
46 OSL::ClosureParam *closure_emission_params();
47 OSL::ClosureParam *closure_background_params();
48 OSL::ClosureParam *closure_holdout_params();
49 OSL::ClosureParam *closure_ambient_occlusion_params();
50 OSL::ClosureParam *closure_bsdf_diffuse_ramp_params();
51 OSL::ClosureParam *closure_bsdf_phong_ramp_params();
52 OSL::ClosureParam *closure_bsdf_diffuse_toon_params();
53 OSL::ClosureParam *closure_bsdf_specular_toon_params();
54 OSL::ClosureParam *closure_westin_backscatter_params();
55 OSL::ClosureParam *closure_westin_sheen_params();
56 OSL::ClosureParam *closure_bssrdf_params();
57
58 void closure_emission_prepare(OSL::RendererServices *, int id, void *data);
59 void closure_background_prepare(OSL::RendererServices *, int id, void *data);
60 void closure_holdout_prepare(OSL::RendererServices *, int id, void *data);
61 void closure_ambient_occlusion_prepare(OSL::RendererServices *, int id, void *data);
62 void closure_bsdf_diffuse_ramp_prepare(OSL::RendererServices *, int id, void *data);
63 void closure_bsdf_phong_ramp_prepare(OSL::RendererServices *, int id, void *data);
64 void closure_bsdf_diffuse_toon_prepare(OSL::RendererServices *, int id, void *data);
65 void closure_bsdf_specular_toon_prepare(OSL::RendererServices *, int id, void *data);
66 void closure_westin_backscatter_prepare(OSL::RendererServices *, int id, void *data);
67 void closure_westin_sheen_prepare(OSL::RendererServices *, int id, void *data);
68 void closure_bssrdf_prepare(OSL::RendererServices *, int id, void *data);
69
70 enum {
71         AmbientOcclusion = 100
72 };
73
74 #define CLOSURE_PREPARE(name, classname)          \
75 void name(RendererServices *, int id, void *data) \
76 {                                                 \
77         memset(data, 0, sizeof(classname));           \
78         new (data) classname();                       \
79 }
80
81 #define CLOSURE_PREPARE_STATIC(name, classname) static CLOSURE_PREPARE(name, classname)
82
83 #define CLOSURE_FLOAT3_PARAM(st, fld) \
84     { TypeDesc::TypeVector, reckless_offsetof(st, fld), NULL, sizeof(OSL::Vec3) }
85
86 #define TO_VEC3(v) OSL::Vec3(v.x, v.y, v.z)
87 #define TO_COLOR3(v) OSL::Color3(v.x, v.y, v.z)
88 #define TO_FLOAT3(v) make_float3(v[0], v[1], v[2])
89
90 /* BSDF */
91
92 class CBSDFClosure : public OSL::ClosurePrimitive {
93 public:
94         ShaderClosure sc;
95
96         CBSDFClosure(int scattering) : OSL::ClosurePrimitive(BSDF),
97           m_scattering_label(scattering), m_shaderdata_flag(0) { }
98         ~CBSDFClosure() { }
99
100         int scattering() const { return m_scattering_label; }
101         int shaderdata_flag() const { return m_shaderdata_flag; }
102
103         virtual void blur(float roughness) = 0;
104         virtual float3 eval_reflect(const float3 &omega_out, const float3 &omega_in, float &pdf) const = 0;
105         virtual float3 eval_transmit(const float3 &omega_out, const float3 &omega_in, float &pdf) const = 0;
106
107         virtual int sample(const float3 &Ng,
108                            const float3 &omega_out, const float3 &domega_out_dx, const float3 &domega_out_dy,
109                            float randu, float randv,
110                            float3 &omega_in, float3 &domega_in_dx, float3 &domega_in_dy,
111                            float &pdf, float3 &eval) const = 0;
112
113 protected:
114         int m_scattering_label;
115         int m_shaderdata_flag;
116 };
117
118 #define BSDF_CLOSURE_CLASS_BEGIN(Upper, lower, svmlower, TYPE) \
119 \
120 class Upper##Closure : public CBSDFClosure { \
121 public: \
122         Upper##Closure() : CBSDFClosure(TYPE) {} \
123         size_t memsize() const { return sizeof(*this); } \
124         const char *name() const { return #lower; } \
125 \
126         void setup() \
127         { \
128                 sc.prim = NULL; \
129                 m_shaderdata_flag = bsdf_##lower##_setup(&sc); \
130         } \
131 \
132         bool mergeable(const ClosurePrimitive *other) const \
133         { \
134                 return false; \
135         } \
136         \
137         void blur(float roughness) \
138         { \
139                 bsdf_##svmlower##_blur(&sc, roughness); \
140         } \
141 \
142         void print_on(std::ostream &out) const \
143         { \
144                 out << name() << " ((" << sc.N[0] << ", " << sc.N[1] << ", " << sc.N[2] << "))"; \
145         } \
146 \
147         float3 eval_reflect(const float3 &omega_out, const float3 &omega_in, float& pdf) const \
148         { \
149                 return bsdf_##svmlower##_eval_reflect(&sc, omega_out, omega_in, &pdf); \
150         } \
151 \
152         float3 eval_transmit(const float3 &omega_out, const float3 &omega_in, float& pdf) const \
153         { \
154                 return bsdf_##svmlower##_eval_transmit(&sc, omega_out, omega_in, &pdf); \
155         } \
156 \
157         int sample(const float3 &Ng, \
158                    const float3 &omega_out, const float3 &domega_out_dx, const float3 &domega_out_dy, \
159                    float randu, float randv, \
160                    float3 &omega_in, float3 &domega_in_dx, float3 &domega_in_dy, \
161                    float &pdf, float3 &eval) const \
162         { \
163                 return bsdf_##svmlower##_sample(&sc, Ng, omega_out, domega_out_dx, domega_out_dy, \
164                         randu, randv, &eval, &omega_in, &domega_in_dx, &domega_in_dy, &pdf); \
165         } \
166 }; \
167 \
168 static ClosureParam *bsdf_##lower##_params() \
169 { \
170         static ClosureParam params[] = {
171
172 /* parameters */
173
174 #define BSDF_CLOSURE_CLASS_END(Upper, lower) \
175                 CLOSURE_STRING_KEYPARAM("label"), \
176             CLOSURE_FINISH_PARAM(Upper##Closure) \
177         }; \
178         return params; \
179 } \
180 \
181 CLOSURE_PREPARE_STATIC(bsdf_##lower##_prepare, Upper##Closure)
182
183 CCL_NAMESPACE_END
184
185 #endif /* __OSL_CLOSURES_H__ */
186