1 /* === S Y N F I G ========================================================= */
3 ** \brief Implementation of the "Warp" layer
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
11 ** This package is free software; you can redistribute it and/or
12 ** modify it under the terms of the GNU General Public License as
13 ** published by the Free Software Foundation; either version 2 of
14 ** the License, or (at your option) any later version.
16 ** This package is distributed in the hope that it will be useful,
17 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ** General Public License for more details.
22 ** === N O T E S ===========================================================
24 ** ========================================================================= */
26 /* === H E A D E R S ======================================================= */
36 #include <synfig/string.h>
37 #include <synfig/time.h>
38 #include <synfig/context.h>
39 #include <synfig/paramdesc.h>
40 #include <synfig/renddesc.h>
41 #include <synfig/surface.h>
42 #include <synfig/value.h>
43 #include <synfig/valuenode.h>
44 #include <synfig/transform.h>
49 /* === M A C R O S ========================================================= */
51 /* === G L O B A L S ======================================================= */
53 SYNFIG_LAYER_INIT(Warp);
54 SYNFIG_LAYER_SET_NAME(Warp,"warp");
55 SYNFIG_LAYER_SET_LOCAL_NAME(Warp,N_("Warp"));
56 SYNFIG_LAYER_SET_CATEGORY(Warp,N_("Distortions"));
57 SYNFIG_LAYER_SET_VERSION(Warp,"0.1");
58 SYNFIG_LAYER_SET_CVS_ID(Warp,"$Id$");
60 /* === P R O C E D U R E S ================================================= */
62 /* === M E T H O D S ======================================================= */
64 /* === E N T R Y P O I N T ================================================= */
84 Warp::transform_forward(const Point& p)const
87 (inv_matrix[0][0]*p[0] + inv_matrix[0][1]*p[1] + inv_matrix[0][2])/(inv_matrix[2][0]*p[0] + inv_matrix[2][1]*p[1] + inv_matrix[2][2]),
88 (inv_matrix[1][0]*p[0] + inv_matrix[1][1]*p[1] + inv_matrix[1][2])/(inv_matrix[2][0]*p[0] + inv_matrix[2][1]*p[1] + inv_matrix[2][2])
93 Warp::transform_backward(const Point& p)const
96 (matrix[0][0]*p[0] + matrix[0][1]*p[1] + matrix[0][2])/(matrix[2][0]*p[0] + matrix[2][1]*p[1] + matrix[2][2]),
97 (matrix[1][0]*p[0] + matrix[1][1]*p[1] + matrix[1][2])/(matrix[2][0]*p[0] + matrix[2][1]*p[1] + matrix[2][2])
102 Warp::transform_forward_z(const Point& p)const
104 return inv_matrix[2][0]*p[0] + inv_matrix[2][1]*p[1] + inv_matrix[2][2];
108 Warp::transform_backward_z(const Point& p)const
110 return matrix[2][0]*p[0] + matrix[2][1]*p[1] + matrix[2][2];
114 #define transform_forward(p) Point( \
115 cache_a*p[0] + cache_b*p[1] + cache_c*p[0]*p[1] + cache_d, \
116 cache_e*p[0] + cache_f*p[1] + cache_i*p[0]*p[1] + cache_j )
118 #define transform_backward(p) Point( \
119 cache_a*p[0] + cache_b*p[1] + cache_c*p[0]*p[1] + cache_d, \
120 cache_e*p[0] + cache_f*p[1] + cache_i*p[0]*p[1] + cache_j )
123 #define triangle_area(a,b,c) (0.5*(-b[0]*a[1]+c[0]*a[1]+a[0]*b[1]-c[0]*b[1]-a[0]*c[1]+b[0]*c[1]))
124 #define quad_area(a,b,c,d) (triangle_area(a,b,c)+triangle_area(a,c,d))
126 Real mat3_determinant(Real matrix[3][3])
130 ret = (matrix[0][0] *
131 (matrix[1][1] * matrix[2][2] -
132 matrix[1][2] * matrix[2][1]));
133 ret -= (matrix[1][0] *
134 (matrix[0][1] * matrix[2][2] -
135 matrix[0][2] * matrix[2][1]));
136 ret += (matrix[2][0] *
137 (matrix[0][1] * matrix[1][2] -
138 matrix[0][2] * matrix[1][1]));
143 void mat3_invert(Real in[3][3], Real out[3][3])
145 Real det(mat3_determinant(in));
152 out[0][0] = (in[1][1] * in[2][2] -
153 in[1][2] * in[2][1]) * det;
155 out[1][0] = - (in[1][0] * in[2][2] -
156 in[1][2] * in[2][0]) * det;
158 out[2][0] = (in[1][0] * in[2][1] -
159 in[1][1] * in[2][0]) * det;
161 out[0][1] = - (in[0][1] * in[2][2] -
162 in[0][2] * in[2][1]) * det;
164 out[1][1] = (in[0][0] * in[2][2] -
165 in[0][2] * in[2][0]) * det;
167 out[2][1] = - (in[0][0] * in[2][1] -
168 in[0][1] * in[2][0]) * det;
170 out[0][2] = (in[0][1] * in[1][2] -
171 in[0][2] * in[1][1]) * det;
173 out[1][2] = - (in[0][0] * in[1][2] -
174 in[0][2] * in[1][0]) * det;
176 out[2][2] = (in[0][0] * in[1][1] -
177 in[0][1] * in[1][0]) * det;
184 /* cache_a=(-dest_tl[0]+dest_tr[0])/(src_br[1]-src_tl[1]);
185 cache_b=(-dest_tl[0]+dest_bl[0])/(src_br[0]-src_tl[0]);
186 cache_c=(dest_tl[0]-dest_tr[0]+dest_br[0]-dest_bl[0])/((src_br[1]-src_tl[1])*(src_br[0]-src_tl[0]));
189 cache_e=(-dest_tl[1]+dest_tr[1])/(src_br[0]-src_tl[0]);
190 cache_f=(-dest_tl[1]+dest_bl[1])/(src_br[1]-src_tl[1]);
191 cache_i=(dest_tl[1]-dest_tr[1]+dest_br[1]-dest_bl[1])/((src_br[1]-src_tl[1])*(src_br[0]-src_tl[0]));
195 /* matrix[2][0]=(dest_tl[0]-dest_tr[0]+dest_br[0]-dest_bl[0])/((src_br[1]-src_tl[1])*(src_br[0]-src_tl[0]));
196 matrix[2][1]=(dest_tl[1]-dest_tr[1]+dest_br[1]-dest_bl[1])/((src_br[1]-src_tl[1])*(src_br[0]-src_tl[0]));
197 matrix[2][2]=quad_area(dest_tl,dest_tr,dest_br,dest_bl)/((src_br[1]-src_tl[1])*(src_br[0]-src_tl[0]));
199 matrix[0][0]=-(-dest_tl[1]+dest_tr[1])/(src_br[0]-src_tl[0]);
200 matrix[0][1]=-(-dest_tl[1]+dest_bl[1])/(src_br[1]-src_tl[1]);
202 matrix[1][0]=-(-dest_tl[0]+dest_tr[0])/(src_br[1]-src_tl[1]);
203 matrix[1][1]=-(-dest_tl[0]+dest_bl[0])/(src_br[0]-src_tl[0]);
205 matrix[0][2]=matrix[0][0]*dest_tl[0] + matrix[0][1]*dest_tl[1];
206 matrix[1][2]=matrix[1][0]*dest_tl[0] + matrix[1][1]*dest_tl[1];
212 const Real& x1(min(src_br[0],src_tl[0]));
213 const Real& y1(min(src_br[1],src_tl[1]));
214 const Real& x2(max(src_br[0],src_tl[0]));
215 const Real& y2(max(src_br[1],src_tl[1]));
217 Real tx1(dest_bl[0]);
218 Real ty1(dest_bl[1]);
219 Real tx2(dest_br[0]);
220 Real ty2(dest_br[1]);
221 Real tx3(dest_tl[0]);
222 Real ty3(dest_tl[1]);
223 Real tx4(dest_tr[0]);
224 Real ty4(dest_tr[1]);
226 if(src_br[0]<src_tl[0])
227 swap(tx3,tx4),swap(ty3,ty4),swap(tx1,tx2),swap(ty1,ty2);
229 if(src_br[1]>src_tl[1])
230 swap(tx3,tx1),swap(ty3,ty1),swap(tx4,tx2),swap(ty4,ty2);
235 scalex = scaley = 1.0;
238 scalex = 1.0 / (Real) (x2 - x1);
241 scaley = 1.0 / (Real) (y2 - y1);
243 /* Determine the perspective transform that maps from
244 * the unit cube to the transformed coordinates
247 Real dx1, dx2, dx3, dy1, dy2, dy3;
251 dx3 = tx1 - tx2 + tx4 - tx3;
255 dy3 = ty1 - ty2 + ty4 - ty3;
257 /* Is the mapping affine? */
258 if ((dx3 == 0.0) && (dy3 == 0.0))
260 matrix[0][0] = tx2 - tx1;
261 matrix[0][1] = tx4 - tx2;
263 matrix[1][0] = ty2 - ty1;
264 matrix[1][1] = ty4 - ty2;
273 det1 = dx3 * dy2 - dy3 * dx2;
274 det2 = dx1 * dy2 - dy1 * dx2;
276 if (det1 == 0.0 && det2 == 0.0)
279 matrix[2][0] = det1 / det2;
281 det1 = dx1 * dy3 - dy1 * dx3;
283 if (det1 == 0.0 && det2 == 0.0)
286 matrix[2][1] = det1 / det2;
288 matrix[0][0] = tx2 - tx1 + matrix[2][0] * tx2;
289 matrix[0][1] = tx3 - tx1 + matrix[2][1] * tx3;
292 matrix[1][0] = ty2 - ty1 + matrix[2][0] * ty2;
293 matrix[1][1] = ty3 - ty1 + matrix[2][1] * ty3;
301 Real scaletrans[3][3]={
302 { scalex, 0, -x1*scalex },
303 { 0, scaley, -y1*scaley },
309 for (int i = 0; i < 3; i++)
315 for (int j = 0; j < 3; j++)
317 matrix[i][j] = t1 * scaletrans[0][j];
318 matrix[i][j] += t2 * scaletrans[1][j];
319 matrix[i][j] += t3 * scaletrans[2][j];
323 mat3_invert(matrix, inv_matrix);
325 gimp_matrix3_identity (result);
326 gimp_matrix3_translate (result, -x1, -y1);
327 gimp_matrix3_scale (result, scalex, scaley);
328 gimp_matrix3_mult (&matrix, result);
333 Warp::set_param(const String & param, const ValueBase &value)
335 IMPORT_PLUS(src_tl,sync());
336 IMPORT_PLUS(src_br,sync());
337 IMPORT_PLUS(dest_tl,sync());
338 IMPORT_PLUS(dest_tr,sync());
339 IMPORT_PLUS(dest_bl,sync());
340 IMPORT_PLUS(dest_br,sync());
348 Warp::get_param(const String ¶m)const
366 Warp::get_param_vocab()const
370 ret.push_back(ParamDesc("src_tl")
371 .set_local_name(_("Source TL"))
375 ret.push_back(ParamDesc("src_br")
376 .set_local_name(_("Source BR"))
379 ret.push_back(ParamDesc("dest_tl")
380 .set_local_name(_("Dest TL"))
381 .set_connect("dest_tr")
384 ret.push_back(ParamDesc("dest_tr")
385 .set_local_name(_("Dest TR"))
386 .set_connect("dest_br")
389 ret.push_back(ParamDesc("dest_br")
390 .set_local_name(_("Dest BR"))
391 .set_connect("dest_bl")
394 ret.push_back(ParamDesc("dest_bl")
395 .set_local_name(_("Dest BL"))
396 .set_connect("dest_tl")
399 ret.push_back(ParamDesc("clip")
400 .set_local_name(_("Clip"))
403 ret.push_back(ParamDesc("horizon")
404 .set_local_name(_("Horizon"))
411 class Warp_Trans : public Transform
413 etl::handle<const Warp> layer;
415 Warp_Trans(const Warp* x):Transform(x->get_guid()),layer(x) { }
417 synfig::Vector perform(const synfig::Vector& x)const
419 return layer->transform_backward(x);
420 //Point pos(x-layer->origin);
421 //return Point(layer->cos_val*pos[0]-layer->sin_val*pos[1],layer->sin_val*pos[0]+layer->cos_val*pos[1])+layer->origin;
424 synfig::Vector unperform(const synfig::Vector& x)const
427 return layer->transform_forward(x);
428 //Point pos(x-layer->origin);
429 //return Point(layer->cos_val*pos[0]+layer->sin_val*pos[1],-layer->sin_val*pos[0]+layer->cos_val*pos[1])+layer->origin;
432 etl::handle<Transform>
433 Warp::get_transform()const
435 return new Warp_Trans(this);
438 synfig::Layer::Handle
439 Warp::hit_check(synfig::Context context, const synfig::Point &p)const
441 Point newpos(transform_forward(p));
445 Rect rect(src_tl,src_br);
446 if(!rect.is_inside(newpos))
450 return context.hit_check(newpos);
454 Warp::get_color(Context context, const Point &p)const
456 Point newpos(transform_forward(p));
460 Rect rect(src_tl,src_br);
461 if(!rect.is_inside(newpos))
462 return Color::alpha();
465 const float z(transform_backward_z(newpos));
467 return context.get_color(newpos);
469 return Color::alpha();
472 //#define ACCEL_WARP_IS_BROKEN 1
475 Warp::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
477 SuperCallback stageone(cb,0,9000,10000);
478 SuperCallback stagetwo(cb,9000,10000,10000);
480 Real pw=(renddesc.get_w())/(renddesc.get_br()[0]-renddesc.get_tl()[0]);
481 Real ph=(renddesc.get_h())/(renddesc.get_br()[1]-renddesc.get_tl()[1]);
483 if(cb && !cb->amount_complete(0,10000))
486 Point tl(renddesc.get_tl());
487 Point br(renddesc.get_br());
491 Rect render_rect(tl,br);
492 Rect clip_rect(Rect::full_plane());
493 Rect dest_rect(dest_tl,dest_br); dest_rect.expand(dest_tr).expand(dest_bl);
495 Real zoom_factor(1.0);
497 // Quick exclusion clip, if necessary
498 if(clip && !intersect(render_rect,dest_rect))
500 surface->set_wh(renddesc.get_w(),renddesc.get_h());
506 Rect other(render_rect);
510 Point min(other.get_min());
511 Point max(other.get_max());
513 bool init_point_set=false;
515 // Point trans_point[4];
518 Real z,minz(10000000000000.0f),maxz(0);
520 //! \todo checking the 4 corners for 0<=z<horizon*2 and using
521 //! only 4 corners which satisfy this condition isn't the
522 //! right thing to do. It's possible that none of the 4
523 //! corners fall within that range, and yet content of the
525 p=transform_forward(min);
526 z=transform_backward_z(p);
527 if(z>0 && z<horizon*2)
530 bounding_rect.expand(p);
532 bounding_rect=Rect(p);
534 maxz=std::max(maxz,z);
535 minz=std::min(minz,z);
538 p=transform_forward(max);
539 z=transform_backward_z(p);
540 if(z>0 && z<horizon*2)
543 bounding_rect.expand(p);
545 bounding_rect=Rect(p);
547 maxz=std::max(maxz,z);
548 minz=std::min(minz,z);
553 p=transform_forward(min);
554 z=transform_backward_z(p);
555 if(z>0 && z<horizon*2)
558 bounding_rect.expand(p);
560 bounding_rect=Rect(p);
562 maxz=std::max(maxz,z);
563 minz=std::min(minz,z);
566 p=transform_forward(max);
567 z=transform_backward_z(p);
568 if(z>0 && z<horizon*2)
571 bounding_rect.expand(p);
573 bounding_rect=Rect(p);
575 maxz=std::max(maxz,z);
576 minz=std::min(minz,z);
581 surface->set_wh(renddesc.get_w(),renddesc.get_h());
585 zoom_factor=(1+(maxz-minz));
589 #ifdef ACCEL_WARP_IS_BROKEN
590 return Layer::accelerated_render(context,surface,quality,renddesc, cb);
595 .expand(transform_forward(tl))
596 .expand(transform_forward(br))
600 //synfig::warning("given window: [%f,%f]-[%f,%f] %dx%d",tl[0],tl[1],br[0],br[1],renddesc.get_w(),renddesc.get_h());
601 //synfig::warning("Projected: [%f,%f]-[%f,%f]",bounding_rect.get_min()[0],bounding_rect.get_min()[1],bounding_rect.get_max()[0],bounding_rect.get_max()[1]);
603 // If we are clipping, then go ahead and clip to the
606 clip_rect&=Rect(src_tl,src_br);
608 // Bound ourselves to the bounding rectangle of
610 clip_rect&=context.get_full_bounding_rect();//.expand_x(abs(zoom_factor/pw)).expand_y(abs(zoom_factor/ph));
612 bounding_rect&=clip_rect;
614 Point min_point(bounding_rect.get_min());
615 Point max_point(bounding_rect.get_max());
617 // we're going to divide by the difference of these pairs soon;
618 // if they're the same, we'll be dividing by zero, and we don't
620 // \todo what should we do in this case?
621 if (min_point[0] == max_point[0]) max_point[0] += 0.001;
622 if (min_point[1] == max_point[1]) max_point[1] += 0.001;
647 const int tmp_d(max(renddesc.get_w(),renddesc.get_h()));
648 Real src_pw=(tmp_d*zoom_factor)/(br[0]-tl[0]);
649 Real src_ph=(tmp_d*zoom_factor)/(br[1]-tl[1]);
652 RendDesc desc(renddesc);
654 //desc.set_flags(RendDesc::PX_ASPECT);
657 desc.set_wh(ceil_to_int(src_pw*(br[0]-tl[0])),ceil_to_int(src_ph*(br[1]-tl[1])));
659 //synfig::warning("surface to render: [%f,%f]-[%f,%f] %dx%d",desc.get_tl()[0],desc.get_tl()[1],desc.get_br()[0],desc.get_br()[1],desc.get_w(),desc.get_h());
660 if(desc.get_w()==0 && desc.get_h()==0)
662 surface->set_wh(renddesc.get_w(),renddesc.get_h());
667 // Recalculate the pixel widths for the src renddesc
668 src_pw=(desc.get_w())/(desc.get_br()[0]-desc.get_tl()[0]);
669 src_ph=(desc.get_h())/(desc.get_br()[1]-desc.get_tl()[1]);
673 source.set_wh(desc.get_w(),desc.get_h());
675 if(!context.accelerated_render(&source,quality,desc,&stageone))
678 surface->set_wh(renddesc.get_w(),renddesc.get_h());
681 Surface::pen pen(surface->begin());
689 for(y=0,point[1]=renddesc.get_tl()[1];y<surface->get_h();y++,pen.inc_y(),pen.dec_x(x),point[1]+=1.0/ph)
691 for(x=0,point[0]=renddesc.get_tl()[0];x<surface->get_w();x++,pen.inc_x(),point[0]+=1.0/pw)
693 tmp=transform_forward(point);
694 const float z(transform_backward_z(tmp));
695 if(!clip_rect.is_inside(tmp) || !(z>0 && z<horizon))
697 (*surface)[y][x]=Color::alpha();
701 u=(tmp[0]-tl[0])*src_pw;
702 v=(tmp[1]-tl[1])*src_ph;
704 if(u<0 || v<0 || u>=source.get_w() || v>=source.get_h() || isnan(u) || isnan(v))
705 (*surface)[y][x]=context.get_color(tmp);
707 (*surface)[y][x]=source.cubic_sample(u,v);
711 if(!stagetwo.amount_complete(y,surface->get_h()))
719 // INTERPOLATION_LINEAR
723 for(y=0,point[1]=renddesc.get_tl()[1];y<surface->get_h();y++,pen.inc_y(),pen.dec_x(x),point[1]+=1.0/ph)
725 for(x=0,point[0]=renddesc.get_tl()[0];x<surface->get_w();x++,pen.inc_x(),point[0]+=1.0/pw)
727 tmp=transform_forward(point);
728 const float z(transform_backward_z(tmp));
729 if(!clip_rect.is_inside(tmp) || !(z>0 && z<horizon))
731 (*surface)[y][x]=Color::alpha();
735 u=(tmp[0]-tl[0])*src_pw;
736 v=(tmp[1]-tl[1])*src_ph;
738 if(u<0 || v<0 || u>=source.get_w() || v>=source.get_h() || isnan(u) || isnan(v))
739 (*surface)[y][x]=context.get_color(tmp);
741 (*surface)[y][x]=source.linear_sample(u,v);
745 if(!stagetwo.amount_complete(y,surface->get_h()))
756 for(y=0,point[1]=renddesc.get_tl()[1];y<surface->get_h();y++,pen.inc_y(),pen.dec_x(x),point[1]+=1.0/ph)
758 for(x=0,point[0]=renddesc.get_tl()[0];x<surface->get_w();x++,pen.inc_x(),point[0]+=1.0/pw)
760 tmp=transform_forward(point);
761 const float z(transform_backward_z(tmp));
762 if(!clip_rect.is_inside(tmp) || !(z>0 && z<horizon))
764 (*surface)[y][x]=Color::alpha();
768 u=(tmp[0]-tl[0])*src_pw;
769 v=(tmp[1]-tl[1])*src_ph;
771 if(u<0 || v<0 || u>=source.get_w() || v>=source.get_h() || isnan(u) || isnan(v))
772 (*surface)[y][x]=context.get_color(tmp);
774 //pen.set_value(source[v][u]);
775 (*surface)[y][x]=source[floor_to_int(v)][floor_to_int(u)];
779 if(!stagetwo.amount_complete(y,surface->get_h()))
787 if(cb && !cb->amount_complete(10000,10000)) return false;
793 Warp::get_bounding_rect()const
795 return Rect::full_plane();
799 Warp::get_full_bounding_rect(Context context)const
801 // return Rect::full_plane();
803 Rect under(context.get_full_bounding_rect());
807 under&=Rect(src_tl,src_br);
810 return get_transform()->perform(under);
813 Rect under(context.get_full_bounding_rect());
814 Rect ret(Rect::zero());
816 if(under.area()==HUGE_VAL)
817 return Rect::full_plane();
846 if(ret.area()==HUGE_VAL)
847 return Rect::full_plane();