Cycles OSL: phong_ramp(N, exponent, colors[8]) closure added, which works like

a specular ramp shader. Note this is OSL only still, for experimenting.

Patch by Thomas.

9 files changed, 276 insertions, 1 deletions

diff --git a/intern/cycles/kernel/CMakeLists.txt b/intern/cycles/kernel/CMakeLists.txt
index 82b0605ab6b..5a570328948 100644
--- a/intern/cycles/kernel/CMakeLists.txt
+++ b/intern/cycles/kernel/CMakeLists.txt
@@ -51,6 +51,7 @@ set(SRC_CLOSURE_HEADERS
 	closure/bsdf_diffuse.h
 	closure/bsdf_microfacet.h
 	closure/bsdf_oren_nayar.h
+	closure/bsdf_phong_ramp.h
 	closure/bsdf_reflection.h
 	closure/bsdf_refraction.h
 	closure/bsdf_transparent.h
diff --git a/intern/cycles/kernel/closure/bsdf_phong_ramp.h b/intern/cycles/kernel/closure/bsdf_phong_ramp.h
new file mode 100644
index 00000000000..a2df77c2d2b
--- /dev/null
+++ b/intern/cycles/kernel/closure/bsdf_phong_ramp.h
@@ -0,0 +1,140 @@
+/*
+ * Adapted from Open Shading Language with this license:
+ *
+ * Copyright (c) 2009-2010 Sony Pictures Imageworks Inc., et al.
+ * All Rights Reserved.
+ *
+ * Modifications Copyright 2012, Blender Foundation.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of Sony Pictures Imageworks nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __BSDF_PHONG_RAMP_H__
+#define __BSDF_PHONG_RAMP_H__
+
+CCL_NAMESPACE_BEGIN
+
+__device float3 bsdf_phong_ramp_get_color(const ShaderClosure *sc, const float3 colors[8], float pos)
+{
+	int MAXCOLORS = 8;
+	
+	float npos = pos * (float)(MAXCOLORS - 1);
+	int ipos = (int)npos;
+	if (ipos >= (MAXCOLORS - 1))
+		return colors[MAXCOLORS - 1];
+	float offset = npos - (float)ipos;
+	return colors[ipos] * (1.0f - offset) + colors[ipos+1] * offset;
+}
+
+__device int bsdf_phong_ramp_setup(ShaderClosure *sc)
+{
+	sc->type = CLOSURE_BSDF_PHONG_RAMP_ID;
+	return SD_BSDF | SD_BSDF_HAS_EVAL | SD_BSDF_GLOSSY;
+}
+
+__device void bsdf_phong_ramp_blur(ShaderClosure *sc, float roughness)
+{
+}
+
+__device float3 bsdf_phong_ramp_eval_reflect(const ShaderClosure *sc, const float3 colors[8], const float3 I, const float3 omega_in, float *pdf)
+{
+	float m_exponent = sc->data0;
+	float cosNI = dot(sc->N, omega_in);
+	float cosNO = dot(sc->N, I);
+	
+	if (cosNI > 0 && cosNO > 0) {
+		// reflect the view vector
+		float3 R = (2 * cosNO) * sc->N - I;
+		float cosRI = dot(R, omega_in);
+		if (cosRI > 0) {
+			float cosp = powf(cosRI, m_exponent);
+			float common = 0.5f * (float) M_1_PI_F * cosp;
+			float out = cosNI * (m_exponent + 2) * common;
+			*pdf = (m_exponent + 1) * common;
+			return bsdf_phong_ramp_get_color(sc, colors, cosp) * out;
+		}
+	}
+	
+	return make_float3(0.0f, 0.0f, 0.0f);
+}
+
+__device float3 bsdf_phong_ramp_eval_transmit(const ShaderClosure *sc, const float3 colors[8], const float3 I, const float3 omega_in, float *pdf)
+{
+	return make_float3(0.0f, 0.0f, 0.0f);
+}
+
+__device int bsdf_phong_ramp_sample(const ShaderClosure *sc, const float3 colors[8], float3 Ng, float3 I, float3 dIdx, float3 dIdy, float randu, float randv, float3 *eval, float3 *omega_in, float3 *domega_in_dx, float3 *domega_in_dy, float *pdf)
+{
+	float cosNO = dot(sc->N, I);
+	float m_exponent = sc->data0;
+	
+	if (cosNO > 0) {
+		// reflect the view vector
+		float3 R = (2 * cosNO) * sc->N - I;
+
+#ifdef __RAY_DIFFERENTIALS__
+		*domega_in_dx = (2 * dot(sc->N, dIdx)) * sc->N - dIdx;
+		*domega_in_dy = (2 * dot(sc->N, dIdy)) * sc->N - dIdy;
+#endif
+		
+		float3 T, B;
+		make_orthonormals (R, &T, &B);
+		float phi = 2 * M_PI_F * randu;
+		float cosTheta = powf(randv, 1 / (m_exponent + 1));
+		float sinTheta2 = 1 - cosTheta * cosTheta;
+		float sinTheta = sinTheta2 > 0 ? sqrtf(sinTheta2) : 0;
+		*omega_in = (cosf(phi) * sinTheta) * T +
+				   (sinf(phi) * sinTheta) * B +
+				   (            cosTheta) * R;
+		if (dot(Ng, *omega_in) > 0.0f)
+		{
+			// common terms for pdf and eval
+			float cosNI = dot(sc->N, *omega_in);
+			// make sure the direction we chose is still in the right hemisphere
+			if (cosNI > 0)
+			{
+				float cosp = powf(cosTheta, m_exponent);
+				float common = 0.5f * M_1_PI_F * cosp;
+				*pdf = (m_exponent + 1) * common;
+				float out = cosNI * (m_exponent + 2) * common;
+				*eval = bsdf_phong_ramp_get_color(sc, colors, cosp) * out;
+				
+#ifdef __RAY_DIFFERENTIALS__
+				// Since there is some blur to this reflection, make the
+				// derivatives a bit bigger. In theory this varies with the
+				// exponent but the exact relationship is complex and
+				// requires more ops than are practical.
+				*domega_in_dx *= 10;
+				*domega_in_dy *= 10;
+#endif
+			}
+		}
+	}
+	return LABEL_REFLECT;
+}
+
+
+CCL_NAMESPACE_END
+
+#endif /* __BSDF_PHONG_RAMP_H__ */
diff --git a/intern/cycles/kernel/osl/CMakeLists.txt b/intern/cycles/kernel/osl/CMakeLists.txt
index 8938b16a48f..1b1bb558bc9 100644
--- a/intern/cycles/kernel/osl/CMakeLists.txt
+++ b/intern/cycles/kernel/osl/CMakeLists.txt
@@ -14,6 +14,7 @@ set(INC_SYS
 
 set(SRC
 	background.cpp
+	bsdf_phong_ramp.cpp
 	emissive.cpp
 	osl_closures.cpp
 	osl_services.cpp
diff --git a/intern/cycles/kernel/osl/bsdf_phong_ramp.cpp b/intern/cycles/kernel/osl/bsdf_phong_ramp.cpp
new file mode 100644
index 00000000000..fb144be7e50
--- /dev/null
+++ b/intern/cycles/kernel/osl/bsdf_phong_ramp.cpp
@@ -0,0 +1,115 @@
+/*
+ * Adapted from Open Shading Language with this license:
+ *
+ * Copyright (c) 2009-2010 Sony Pictures Imageworks Inc., et al.
+ * All Rights Reserved.
+ *
+ * Modifications Copyright 2011, Blender Foundation.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of Sony Pictures Imageworks nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <OpenImageIO/fmath.h>
+
+#include <OSL/genclosure.h>
+
+#include "osl_closures.h"
+
+#include "kernel_types.h"
+#include "closure/bsdf_phong_ramp.h"
+
+CCL_NAMESPACE_BEGIN
+
+using namespace OSL;
+
+class PhongRampClosure : public CBSDFClosure {
+public:
+	PhongRampClosure() : CBSDFClosure(LABEL_GLOSSY) {}
+	Color3 colors[8];
+	float3 fcolors[8];
+
+	size_t memsize() const { return sizeof(*this); }
+	const char *name() const { return "phong_ramp"; }
+
+	void setup()
+	{
+		sc.N = TO_FLOAT3(N);
+		m_shaderdata_flag = bsdf_phong_ramp_setup(&sc);
+
+		for(int i = 0; i < 8; i++)
+			fcolors[i] = TO_FLOAT3(colors[i]);
+	}
+
+	bool mergeable(const ClosurePrimitive *other) const
+	{
+		return false;
+	}
+
+	void blur(float roughness)
+	{
+		bsdf_phong_ramp_blur(&sc, roughness);
+	}
+
+	void print_on(std::ostream &out) const
+	{
+		out << name() << " ((" << sc.N[0] << ", " << sc.N[1] << ", " << sc.N[2] << "))";
+	}
+
+	float3 eval_reflect(const float3 &omega_out, const float3 &omega_in, float& pdf) const
+	{
+		return bsdf_phong_ramp_eval_reflect(&sc, fcolors, omega_out, omega_in, &pdf);
+	}
+
+	float3 eval_transmit(const float3 &omega_out, const float3 &omega_in, float& pdf) const
+	{
+		return bsdf_phong_ramp_eval_transmit(&sc, fcolors, omega_out, omega_in, &pdf);
+	}
+
+	int sample(const float3 &Ng,
+	           const float3 &omega_out, const float3 &domega_out_dx, const float3 &domega_out_dy,
+	           float randu, float randv,
+	           float3 &omega_in, float3 &domega_in_dx, float3 &domega_in_dy,
+	           float &pdf, float3 &eval) const
+	{
+		return bsdf_phong_ramp_sample(&sc, fcolors, Ng, omega_out, domega_out_dx, domega_out_dy,
+			randu, randv, &eval, &omega_in, &domega_in_dx, &domega_in_dy, &pdf);
+	}
+};
+
+ClosureParam *closure_bsdf_phong_ramp_params()
+{
+	static ClosureParam params[] = {
+		CLOSURE_VECTOR_PARAM(PhongRampClosure, N),
+		CLOSURE_FLOAT_PARAM(PhongRampClosure, sc.data0),
+		CLOSURE_COLOR_ARRAY_PARAM(PhongRampClosure, colors, 8),
+		CLOSURE_STRING_KEYPARAM("label"),
+	    CLOSURE_FINISH_PARAM(PhongRampClosure)
+	};
+	return params;
+}
+
+CLOSURE_PREPARE(closure_bsdf_phong_ramp_prepare, PhongRampClosure)
+
+CCL_NAMESPACE_END
+
diff --git a/intern/cycles/kernel/osl/osl_closures.cpp b/intern/cycles/kernel/osl/osl_closures.cpp
index de572d0e585..d42d65608c8 100644
--- a/intern/cycles/kernel/osl/osl_closures.cpp
+++ b/intern/cycles/kernel/osl/osl_closures.cpp
@@ -48,6 +48,7 @@
 #include "closure/bsdf_diffuse.h"
 #include "closure/bsdf_microfacet.h"
 #include "closure/bsdf_oren_nayar.h"
+#include "closure/bsdf_phong_ramp.h"
 #include "closure/bsdf_reflection.h"
 #include "closure/bsdf_refraction.h"
 #include "closure/bsdf_transparent.h"
@@ -192,6 +193,8 @@ void OSLShader::register_closures(OSL::ShadingSystem *ss)
 		closure_holdout_params(), closure_holdout_prepare);
 	register_closure(ss, "ambient_occlusion", id++,
 		closure_ambient_occlusion_params(), closure_ambient_occlusion_prepare);
+	register_closure(ss, "phong_ramp", id++,
+		closure_bsdf_phong_ramp_params(), closure_bsdf_phong_ramp_prepare);
 }
 
 CCL_NAMESPACE_END
diff --git a/intern/cycles/kernel/osl/osl_closures.h b/intern/cycles/kernel/osl/osl_closures.h
index 9137bad58d3..71e9e5ae4fd 100644
--- a/intern/cycles/kernel/osl/osl_closures.h
+++ b/intern/cycles/kernel/osl/osl_closures.h
@@ -47,11 +47,13 @@ OSL::ClosureParam *closure_emission_params();
 OSL::ClosureParam *closure_background_params();
 OSL::ClosureParam *closure_holdout_params();
 OSL::ClosureParam *closure_ambient_occlusion_params();
+OSL::ClosureParam *closure_bsdf_phong_ramp_params();
 
 void closure_emission_prepare(OSL::RendererServices *, int id, void *data);
 void closure_background_prepare(OSL::RendererServices *, int id, void *data);
 void closure_holdout_prepare(OSL::RendererServices *, int id, void *data);
 void closure_ambient_occlusion_prepare(OSL::RendererServices *, int id, void *data);
+void closure_bsdf_phong_ramp_prepare(OSL::RendererServices *, int id, void *data);
 
 enum {
 	AmbientOcclusion = 100
diff --git a/intern/cycles/kernel/shaders/stdosl.h b/intern/cycles/kernel/shaders/stdosl.h
index c55def2b47a..24c3a50e6f6 100644
--- a/intern/cycles/kernel/shaders/stdosl.h
+++ b/intern/cycles/kernel/shaders/stdosl.h
@@ -433,6 +433,7 @@ string concat (string a, string b, string c, string d, string e, string f) {
 
 closure color diffuse(normal N) BUILTIN;
 closure color oren_nayar(normal N, float sigma) BUILTIN;
+closure color phong_ramp(normal N, float exponent, color colors[8]) BUILTIN;
 closure color translucent(normal N) BUILTIN;
 closure color reflection(normal N) BUILTIN;
 closure color refraction(normal N, float eta) BUILTIN;
diff --git a/intern/cycles/kernel/svm/svm_bsdf.h b/intern/cycles/kernel/svm/svm_bsdf.h
index 07c20231d54..373710446e5 100644
--- a/intern/cycles/kernel/svm/svm_bsdf.h
+++ b/intern/cycles/kernel/svm/svm_bsdf.h
@@ -19,6 +19,7 @@
 #include "../closure/bsdf_ashikhmin_velvet.h"
 #include "../closure/bsdf_diffuse.h"
 #include "../closure/bsdf_oren_nayar.h"
+#include "../closure/bsdf_phong_ramp.h"
 #include "../closure/bsdf_microfacet.h"
 #include "../closure/bsdf_reflection.h"
 #include "../closure/bsdf_refraction.h"
@@ -44,6 +45,10 @@ __device int svm_bsdf_sample(const ShaderData *sd, const ShaderClosure *sc, floa
 			label = bsdf_oren_nayar_sample(sc, sd->Ng, sd->I, sd->dI.dx, sd->dI.dy, randu, randv,
 				eval, omega_in, &domega_in->dx, &domega_in->dy, pdf);
 			break;
+		/*case CLOSURE_BSDF_PHONG_RAMP_ID:
+			label = bsdf_phong_ramp_sample(sc, sd->Ng, sd->I, sd->dI.dx, sd->dI.dy, randu, randv,
+				eval, omega_in, &domega_in->dx, &domega_in->dy, pdf);
+			break;*/
 		case CLOSURE_BSDF_TRANSLUCENT_ID:
 			label = bsdf_translucent_sample(sc, sd->Ng, sd->I, sd->dI.dx, sd->dI.dy, randu, randv,
 				eval, omega_in, &domega_in->dx, &domega_in->dy, pdf);
@@ -110,6 +115,9 @@ __device float3 svm_bsdf_eval(const ShaderData *sd, const ShaderClosure *sc, con
 			case CLOSURE_BSDF_OREN_NAYAR_ID:
 				eval = bsdf_oren_nayar_eval_reflect(sc, sd->I, omega_in, pdf);
 				break;
+			/*case CLOSURE_BSDF_PHONG_RAMP_ID:
+				eval = bsdf_phong_ramp_eval_reflect(sc, sd->I, omega_in, pdf);
+				break;*/
 			case CLOSURE_BSDF_TRANSLUCENT_ID:
 				eval = bsdf_translucent_eval_reflect(sc, sd->I, omega_in, pdf);
 				break;
@@ -213,6 +221,9 @@ __device void svm_bsdf_blur(ShaderClosure *sc, float roughness)
 		case CLOSURE_BSDF_OREN_NAYAR_ID:
 			bsdf_oren_nayar_blur(sc, roughness);
 			break;
+		/*case CLOSURE_BSDF_PHONG_RAMP_ID:
+			bsdf_phong_ramp_blur(sc, roughness);
+			break;*/
 		case CLOSURE_BSDF_TRANSLUCENT_ID:
 			bsdf_translucent_blur(sc, roughness);
 			break;
diff --git a/intern/cycles/kernel/svm/svm_types.h b/intern/cycles/kernel/svm/svm_types.h
index 54767f3c87f..b41e34ab407 100644
--- a/intern/cycles/kernel/svm/svm_types.h
+++ b/intern/cycles/kernel/svm/svm_types.h
@@ -320,6 +320,7 @@ typedef enum ClosureType {
 	CLOSURE_BSDF_WARD_ID,
 	CLOSURE_BSDF_ASHIKHMIN_VELVET_ID,
 	CLOSURE_BSDF_WESTIN_SHEEN_ID,
+	CLOSURE_BSDF_PHONG_RAMP_ID,
 
 	CLOSURE_BSDF_TRANSMISSION_ID,
 	CLOSURE_BSDF_TRANSLUCENT_ID,
@@ -351,7 +352,7 @@ typedef enum ClosureType {
 /* watch this, being lazy with memory usage */
 #define CLOSURE_IS_BSDF(type) (type <= CLOSURE_BSDF_TRANSPARENT_ID)
 #define CLOSURE_IS_BSDF_DIFFUSE(type) (type >= CLOSURE_BSDF_DIFFUSE_ID && type <= CLOSURE_BSDF_OREN_NAYAR_ID)
-#define CLOSURE_IS_BSDF_GLOSSY(type) (type >= CLOSURE_BSDF_GLOSSY_ID && type <= CLOSURE_BSDF_WESTIN_SHEEN_ID)
+#define CLOSURE_IS_BSDF_GLOSSY(type) (type >= CLOSURE_BSDF_GLOSSY_ID && type <= CLOSURE_BSDF_PHONG_RAMP_ID)
 #define CLOSURE_IS_BSDF_TRANSMISSION(type) (type >= CLOSURE_BSDF_TRANSMISSION_ID && type <= CLOSURE_BSDF_SHARP_GLASS_ID)
 #define CLOSURE_IS_VOLUME(type) (type >= CLOSURE_VOLUME_ID && type <= CLOSURE_VOLUME_ISOTROPIC_ID)
 #define CLOSURE_IS_EMISSION(type) (type == CLOSURE_EMISSION_ID)