Blame synfig-core/src/modules/lyr_std/clamp.cpp

Carlos Lopez a09598
/* === S Y N F I G ========================================================= */
Carlos Lopez a09598
/*!	\file clamp.cpp
Carlos Lopez a09598
**	\brief Implementation of the "Clamp" layer
Carlos Lopez a09598
**
Carlos Lopez a09598
**	$Id$
Carlos Lopez a09598
**
Carlos Lopez a09598
**	\legal
Carlos Lopez a09598
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
Carlos Lopez e83454
**	Copyright (c) 2011-2013 Carlos Lรณpez
Carlos Lopez a09598
**
Carlos Lopez a09598
**	This package is free software; you can redistribute it and/or
Carlos Lopez a09598
**	modify it under the terms of the GNU General Public License as
Carlos Lopez a09598
**	published by the Free Software Foundation; either version 2 of
Carlos Lopez a09598
**	the License, or (at your option) any later version.
Carlos Lopez a09598
**
Carlos Lopez a09598
**	This package is distributed in the hope that it will be useful,
Carlos Lopez a09598
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
Carlos Lopez a09598
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Carlos Lopez a09598
**	General Public License for more details.
Carlos Lopez a09598
**	\endlegal
Carlos Lopez a09598
*/
Carlos Lopez a09598
/* ========================================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
/* === H E A D E R S ======================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
#ifdef USING_PCH
Carlos Lopez a09598
#	include "pch.h"
Carlos Lopez a09598
#else
Carlos Lopez a09598
#ifdef HAVE_CONFIG_H
Carlos Lopez a09598
#	include <config.h></config.h>
Carlos Lopez a09598
#endif
Carlos Lopez a09598
Carlos Lopez a09598
#include "clamp.h"
bw 94d8a6
bw 94d8a6
#include <synfig localization.h=""></synfig>
bw 94d8a6
#include <synfig general.h=""></synfig>
bw 94d8a6
Carlos Lopez a09598
#include <synfig string.h=""></synfig>
Carlos Lopez a09598
#include <synfig time.h=""></synfig>
Carlos Lopez a09598
#include <synfig context.h=""></synfig>
Carlos Lopez a09598
#include <synfig paramdesc.h=""></synfig>
Carlos Lopez a09598
#include <synfig renddesc.h=""></synfig>
Carlos Lopez a09598
#include <synfig surface.h=""></synfig>
Carlos Lopez a09598
#include <synfig value.h=""></synfig>
Carlos Lopez a09598
#include <synfig valuenode.h=""></synfig>
Carlos Lopez a09598
93caa9
#include <synfig rendering="" software="" surfacesw.h=""></synfig>
a94d49
Carlos Lopez a09598
#endif
Carlos Lopez a09598
Carlos Lopez a09598
/* === U S I N G =========================================================== */
Carlos Lopez a09598
Carlos Lopez a09598
using namespace std;
9f3c68
using namespace etl;
Carlos Lopez a09598
using namespace synfig;
144d3f
using namespace modules;
9f3c68
using namespace lyr_std;
Carlos Lopez a09598
Carlos Lopez a09598
/* === G L O B A L S ======================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
SYNFIG_LAYER_INIT(Layer_Clamp);
Carlos Lopez a09598
SYNFIG_LAYER_SET_NAME(Layer_Clamp,"clamp");
Carlos Lopez a09598
SYNFIG_LAYER_SET_LOCAL_NAME(Layer_Clamp,N_("Clamp"));
Carlos Lopez a09598
SYNFIG_LAYER_SET_CATEGORY(Layer_Clamp,N_("Filters"));
Carlos Lopez a09598
SYNFIG_LAYER_SET_VERSION(Layer_Clamp,"0.2");
Carlos Lopez a09598
SYNFIG_LAYER_SET_CVS_ID(Layer_Clamp,"$Id$");
Carlos Lopez a09598
Carlos Lopez a09598
/* === P R O C E D U R E S ================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
/* === M E T H O D S ======================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
/* === E N T R Y P O I N T ================================================= */
Carlos Lopez a09598
5e2754
rendering::Task::Token TaskClamp::token(
5e2754
	DescAbstract<taskclamp>("Clamp") );</taskclamp>
5e2754
rendering::Task::Token TaskClampSW::token(
5e2754
	DescReal<taskclampsw, taskclamp="">("ClampSW") );</taskclampsw,>
93caa9
93caa9
93caa9
void
93caa9
TaskClampSW::clamp_pixel(Color &dst, const Color &src) const
93caa9
{
93caa9
	if (fabs(src.get_a()) < 1e-8)
93caa9
		{ dst = Color::alpha(); return; }
93caa9
93caa9
	dst = src;
93caa9
93caa9
	if (invert_negative)
93caa9
	{
93caa9
		if (dst.get_a() < floor)
93caa9
			dst = -dst;
93caa9
93caa9
		if(dst.get_r() < floor)
93caa9
		{
93caa9
			dst.set_g(dst.get_g() - dst.get_r());
93caa9
			dst.set_b(dst.get_b() - dst.get_r());
93caa9
			dst.set_r(floor);
93caa9
		}
93caa9
93caa9
		if(dst.get_g() < floor)
93caa9
		{
93caa9
			dst.set_r(dst.get_r() - dst.get_g());
93caa9
			dst.set_b(dst.get_b() - dst.get_g());
93caa9
			dst.set_g(floor);
93caa9
		}
93caa9
93caa9
		if(dst.get_b() < floor)
93caa9
		{
93caa9
			dst.set_g(dst.get_g() - dst.get_b());
93caa9
			dst.set_r(dst.get_r() - dst.get_b());
93caa9
			dst.set_b(floor);
93caa9
		}
93caa9
	}
93caa9
	else
93caa9
	if (clamp_floor)
93caa9
	{
93caa9
		if (dst.get_r() < floor) dst.set_r(floor);
93caa9
		if (dst.get_g() < floor) dst.set_g(floor);
93caa9
		if (dst.get_b() < floor) dst.set_b(floor);
93caa9
		if (dst.get_a() < floor) dst.set_a(floor);
93caa9
	}
93caa9
93caa9
	if (clamp_ceiling)
93caa9
	{
93caa9
		if (dst.get_r() > ceiling) dst.set_r(ceiling);
93caa9
		if (dst.get_g() > ceiling) dst.set_g(ceiling);
93caa9
		if (dst.get_b() > ceiling) dst.set_b(ceiling);
93caa9
		if (dst.get_a() > ceiling) dst.set_a(ceiling);
93caa9
	}
93caa9
}
93caa9
93caa9
bool
5e2754
TaskClampSW::run(RunParams&) const
93caa9
{
5e2754
	RectInt r = target_rect;
5e2754
	if (!r.valid())
93caa9
	{
93caa9
		VectorInt offset = get_offset();
5e2754
		RectInt ra = sub_task()->target_rect + r.get_min() + get_offset();
93caa9
		if (ra.valid())
93caa9
		{
93caa9
			etl::set_intersect(ra, ra, r);
93caa9
			if (ra.valid())
93caa9
			{
5e2754
				LockWrite ldst(this);
5e2754
				if (!ldst) return false;
5e2754
				LockRead lsrc(sub_task());
5e2754
				if (!lsrc) return false;
5e2754
5e2754
				const synfig::Surface &a = lsrc->get_surface();
5e2754
				synfig::Surface &c = ldst->get_surface();
5e2754
93caa9
				for(int y = ra.miny; y < ra.maxy; ++y)
93caa9
				{
93caa9
					const Color *ca = &a[y - r.miny + offset[1]][ra.minx - r.minx + offset[0]];
93caa9
					Color *cc = &c[y][ra.minx];
93caa9
					for(int x = ra.minx; x < ra.maxx; ++x, ++ca, ++cc)
93caa9
						clamp_pixel(*cc, *ca);
93caa9
				}
93caa9
			}
93caa9
		}
93caa9
	}
93caa9
93caa9
	return true;
93caa9
}
93caa9
93caa9
Carlos Lopez a09598
Layer_Clamp::Layer_Clamp():
Carlos Lopez 46a82d
	param_invert_negative(ValueBase(false)),
Carlos Lopez 46a82d
	param_clamp_ceiling(ValueBase(true)),
Carlos Lopez 46a82d
	param_ceiling(ValueBase(Real(1.0f))),
Carlos Lopez 46a82d
	param_floor(ValueBase(Real(0.0f)))
Carlos Lopez a09598
{
Carlos Lopez b3fcc2
	SET_INTERPOLATION_DEFAULTS();
Carlos Lopez b3fcc2
	SET_STATIC_DEFAULTS();
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
inline Color
Carlos Lopez a09598
Layer_Clamp::clamp_color(const Color &in)const
Carlos Lopez a09598
{
Carlos Lopez 46a82d
	bool invert_negative=param_invert_negative.get(bool());
Carlos Lopez 46a82d
	bool clamp_ceiling=param_clamp_ceiling.get(bool());
9f3c68
	Real ceiling=param_ceiling.get(Real());
9f3c68
	Real floor=param_floor.get(Real());
Carlos Lopez 46a82d
	
Carlos Lopez a09598
	Color ret(in);
Carlos Lopez a09598
Carlos Lopez a09598
	if(ret.get_a()==0)
Carlos Lopez a09598
		return Color::alpha();
Carlos Lopez a09598
Carlos Lopez a09598
	if(invert_negative)
Carlos Lopez a09598
	{
Carlos Lopez a09598
		if(ret.get_a()
Carlos Lopez a09598
			ret=-ret;
Carlos Lopez a09598
Carlos Lopez a09598
		if(ret.get_r()
Carlos Lopez a09598
		{
Carlos Lopez a09598
			ret.set_g(ret.get_g()-ret.get_r());
Carlos Lopez a09598
			ret.set_b(ret.get_b()-ret.get_r());
Carlos Lopez a09598
			ret.set_r(floor);
Carlos Lopez a09598
		}
Carlos Lopez a09598
		if(ret.get_g()
Carlos Lopez a09598
		{
Carlos Lopez a09598
			ret.set_r(ret.get_r()-ret.get_g());
Carlos Lopez a09598
			ret.set_b(ret.get_b()-ret.get_g());
Carlos Lopez a09598
			ret.set_g(floor);
Carlos Lopez a09598
		}
Carlos Lopez a09598
		if(ret.get_b()
Carlos Lopez a09598
		{
Carlos Lopez a09598
			ret.set_g(ret.get_g()-ret.get_b());
Carlos Lopez a09598
			ret.set_r(ret.get_r()-ret.get_b());
Carlos Lopez a09598
			ret.set_b(floor);
Carlos Lopez a09598
		}
Carlos Lopez a09598
	}
Carlos Lopez a09598
	else
Carlos Lopez a09598
	{
Carlos Lopez a09598
		if(ret.get_r()
Carlos Lopez a09598
		if(ret.get_g()
Carlos Lopez a09598
		if(ret.get_b()
Carlos Lopez a09598
		if(ret.get_a()
Carlos Lopez a09598
	}
Carlos Lopez a09598
Carlos Lopez a09598
	if(clamp_ceiling)
Carlos Lopez a09598
	{
Carlos Lopez a09598
		if(ret.get_r()>ceiling) ret.set_r(ceiling);
Carlos Lopez a09598
		if(ret.get_g()>ceiling) ret.set_g(ceiling);
Carlos Lopez a09598
		if(ret.get_b()>ceiling) ret.set_b(ceiling);
Carlos Lopez a09598
		if(ret.get_a()>ceiling) ret.set_a(ceiling);
Carlos Lopez a09598
	}
Carlos Lopez a09598
	return ret;
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
bool
Carlos Lopez a09598
Layer_Clamp::set_param(const String & param, const ValueBase &value)
Carlos Lopez a09598
{
Carlos Lopez 46a82d
	IMPORT_VALUE(param_invert_negative);
Carlos Lopez 46a82d
	IMPORT_VALUE(param_clamp_ceiling);
Carlos Lopez 46a82d
	IMPORT_VALUE(param_ceiling);
Carlos Lopez 46a82d
	IMPORT_VALUE(param_floor);
Carlos Lopez a09598
Carlos Lopez a09598
	return false;
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
ValueBase
Carlos Lopez a09598
Layer_Clamp::get_param(const String ¶m)const
Carlos Lopez a09598
{
Carlos Lopez 46a82d
	EXPORT_VALUE(param_invert_negative);
Carlos Lopez 46a82d
	EXPORT_VALUE(param_clamp_ceiling);
Carlos Lopez 46a82d
	EXPORT_VALUE(param_ceiling);
Carlos Lopez 46a82d
	EXPORT_VALUE(param_floor);
Carlos Lopez a09598
Carlos Lopez a09598
	EXPORT_NAME();
Carlos Lopez a09598
	EXPORT_VERSION();
Carlos Lopez a09598
Carlos Lopez a09598
	return ValueBase();
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
Layer::Vocab
Carlos Lopez a09598
Layer_Clamp::get_param_vocab()const
Carlos Lopez a09598
{
Carlos Lopez a09598
	Layer::Vocab ret;
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("invert_negative")
Carlos Lopez a09598
		.set_local_name(_("Invert Negative"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("clamp_ceiling")
Carlos Lopez a09598
		.set_local_name(_("Clamp Ceiling"))
Carlos Lopez 42e8f2
		.set_description(_("When checked the Ceiling value is used"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("ceiling")
Carlos Lopez a09598
		.set_local_name(_("Ceiling"))
Carlos Lopez 42e8f2
		.set_description(_("Upper boundary of the clamping"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("floor")
Carlos Lopez a09598
		.set_local_name(_("Floor"))
Carlos Lopez 42e8f2
		.set_description(_("Lower boundary of the clamping"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	return ret;
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
Color
Carlos Lopez a09598
Layer_Clamp::get_color(Context context, const Point &pos)const
Carlos Lopez a09598
{
Carlos Lopez a09598
	return clamp_color(context.get_color(pos));
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
Rect
Carlos Lopez a09598
Layer_Clamp::get_full_bounding_rect(Context context)const
Carlos Lopez a09598
{
Carlos Lopez a09598
	return context.get_full_bounding_rect();
Carlos Lopez a09598
}
a94d49
a94d49
rendering::Task::Handle
a94d49
Layer_Clamp::build_rendering_task_vfunc(Context context)const
a94d49
{
93caa9
	TaskClamp::Handle task_clamp(new TaskClamp());
a94d49
	task_clamp->invert_negative = param_invert_negative.get(bool());
a94d49
	task_clamp->clamp_ceiling = param_clamp_ceiling.get(bool());
a94d49
	task_clamp->floor = param_floor.get(Real());
a94d49
	task_clamp->ceiling = param_ceiling.get(Real());
a94d49
	task_clamp->sub_task() = context.build_rendering_task();
a94d49
	return task_clamp;
a94d49
}