synfig-core/trunk/src/synfig/layer_pastecanvas.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layer_pastecanvas.cpp
   3 **      \brief Implementation of the "Paste Canvas" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007, 2008 Chris Moore
  10 **
  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.
  15 **
  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.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "layer_pastecanvas.h"
  34 #include "string.h"
  35 #include "time.h"
  36 #include "context.h"
  37 #include "paramdesc.h"
  38 #include "renddesc.h"
  39 #include "surface.h"
  40 #include "value.h"
  41 #include "valuenode.h"
  42 #include "canvas.h"
  43
  44 #endif
  45
  46 /* === U S I N G =========================================================== */
  47
  48 using namespace etl;
  49 using namespace std;
  50 using namespace synfig;
  51
  52 /* === M A C R O S ========================================================= */
  53
  54 #define MAX_DEPTH 10
  55
  56 // if this isn't defined, the 'dead heads' in examples/pirates.sifz don't render properly
  57 #define SYNFIG_CLIP_PASTECANVAS
  58
  59 //#ifdef __APPLE__
  60 //#undef SYNFIG_CLIP_PASTECANVAS
  61 //#endif
  62
  63 /* === C L A S S E S ======================================================= */
  64
  65 class depth_counter     // Makes our recursive depth counter exception-safe
  66 {
  67         int *depth;
  68 public:
  69         depth_counter(int &x):depth(&x) { (*depth)++; }
  70         ~depth_counter() { (*depth)--; }
  71 };
  72
  73 /* === G L O B A L S ======================================================= */
  74
  75 SYNFIG_LAYER_INIT(Layer_PasteCanvas);
  76 SYNFIG_LAYER_SET_NAME(Layer_PasteCanvas,"PasteCanvas"); // todo: use paste_canvas
  77 SYNFIG_LAYER_SET_LOCAL_NAME(Layer_PasteCanvas,N_("Paste Canvas"));
  78 SYNFIG_LAYER_SET_CATEGORY(Layer_PasteCanvas,N_("Other"));
  79 SYNFIG_LAYER_SET_VERSION(Layer_PasteCanvas,"0.1");
  80 SYNFIG_LAYER_SET_CVS_ID(Layer_PasteCanvas,"$Id$");
  81
  82 /* === M E T H O D S ======================================================= */
  83
  84 Layer_PasteCanvas::Layer_PasteCanvas():
  85         origin(0,0),
  86         depth(0),
  87         zoom(0),
  88         time_offset(0),
  89         extra_reference(false)
  90 {
  91         children_lock=false;
  92         muck_with_time_=true;
  93         curr_time=Time::begin();
  94 }
  95
  96 Layer_PasteCanvas::~Layer_PasteCanvas()
  97 {
  98 /*      if(canvas)
  99                 canvas->parent_set.erase(this);
 100 */
 101
 102         //if(canvas)DEBUGINFO(strprintf("%d",canvas->count()));
 103
 104         set_sub_canvas(0);
 105
 106         //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 107         //if(extra_reference)
 108         //      canvas->unref();
 109 }
 110
 111 String
 112 Layer_PasteCanvas::get_local_name()const
 113 {
 114         if(!canvas)     return _("Pasted Canvas");
 115         if(canvas->is_inline()) return _("Inline Canvas");
 116         if(canvas->get_root()==get_canvas()->get_root()) return '[' + canvas->get_id() + ']';
 117
 118         return '[' + canvas->get_file_name() + ']';
 119 }
 120
 121 Layer::Vocab
 122 Layer_PasteCanvas::get_param_vocab()const
 123 {
 124         Layer::Vocab ret(Layer_Composite::get_param_vocab());
 125
 126         ret.push_back(ParamDesc("origin")
 127                 .set_local_name(_("Origin"))
 128                 .set_description(_("Point where you want the origin to be"))
 129         );
 130         ret.push_back(ParamDesc("canvas")
 131                 .set_local_name(_("Canvas"))
 132                 .set_description(_("Canvas to paste"))
 133         );
 134         ret.push_back(ParamDesc("zoom")
 135                 .set_local_name(_("Zoom"))
 136                 .set_description(_("Size of canvas"))
 137         );
 138
 139         ret.push_back(ParamDesc("time_offset")
 140                 .set_local_name(_("Time Offset"))
 141         );
 142
 143         ret.push_back(ParamDesc("children_lock")
 144                 .set_local_name(_("Children Lock"))
 145         );
 146
 147         return ret;
 148 }
 149
 150 bool
 151 Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
 152 {
 153         IMPORT(origin);
 154
 155         // IMPORT(canvas);
 156         if(param=="canvas" && value.same_type_as(Canvas::Handle()))
 157         {
 158                 set_sub_canvas(value.get(Canvas::Handle()));
 159                 return true;
 160         }
 161
 162         //! \todo this introduces bug 1844764 if enabled; it was introduced in r954, but I can't see if it's useful
 163 #if 0
 164         if (param=="time_offset" && value.same_type_as(time_offset))
 165         {
 166                 if (time_offset != value.get(Time()))
 167                 {
 168                         value.put(&time_offset);
 169                         // notify that the time_offset has changed so we can update the
 170                         // waypoint positions in parent layers
 171                         changed();
 172                 }
 173                 return true;
 174         }
 175 #else
 176         IMPORT(time_offset);
 177 #endif
 178
 179         IMPORT(children_lock);
 180         IMPORT(zoom);
 181
 182         return Layer_Composite::set_param(param,value);
 183 }
 184
 185 void
 186 Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
 187 {
 188         if(canvas && muck_with_time_)
 189                 remove_child(canvas.get());
 190
 191         // if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 192         if (extra_reference)
 193                 canvas->unref();
 194
 195         child_changed_connection.disconnect();
 196
 197         canvas=x;
 198
 199         /*if(canvas)
 200                 child_changed_connection=canvas->signal_changed().connect(
 201                         sigc::mem_fun(
 202                                 *this,
 203                                 &Layer_PasteCanvas::changed
 204                         )
 205                 );
 206         */
 207         if(canvas)
 208                 bounds = ((canvas->get_context().get_full_bounding_rect() - canvas->rend_desc().get_focus()) * exp(zoom) +
 209                                   origin + canvas->rend_desc().get_focus());
 210
 211         if(canvas && muck_with_time_)
 212                 add_child(canvas.get());
 213
 214         if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 215         {
 216                 canvas->ref();
 217                 extra_reference = true;
 218         }
 219         else
 220                 extra_reference = false;
 221
 222         if(canvas)
 223                 on_canvas_set();
 224 }
 225
 226 // This is called whenever the parent canvas gets set/changed
 227 void
 228 Layer_PasteCanvas::on_canvas_set()
 229 {
 230         //synfig::info("before count()=%d",count());
 231         if(get_canvas() && canvas && canvas->is_inline() && canvas->parent()!=get_canvas())
 232         {
 233                 //synfig::info("during count()=%d",count());
 234                 canvas->set_inline(get_canvas());
 235         }
 236         //synfig::info("after count()=%d",count());
 237 }
 238
 239 ValueBase
 240 Layer_PasteCanvas::get_param(const String& param)const
 241 {
 242         EXPORT(origin);
 243         EXPORT(canvas);
 244         EXPORT(zoom);
 245         EXPORT(time_offset);
 246         EXPORT(children_lock);
 247
 248         EXPORT_NAME();
 249         EXPORT_VERSION();
 250
 251         return Layer_Composite::get_param(param);
 252 }
 253
 254 void
 255 Layer_PasteCanvas::set_time(Context context, Time time)const
 256 {
 257         if(depth==MAX_DEPTH)return;depth_counter counter(depth);
 258         curr_time=time;
 259
 260         context.set_time(time);
 261         if(canvas)
 262         {
 263                 canvas->set_time(time+time_offset);
 264
 265                 bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
 266         }
 267         else
 268                 bounds=Rect::zero();
 269 }
 270
 271 synfig::Layer::Handle
 272 Layer_PasteCanvas::hit_check(synfig::Context context, const synfig::Point &pos)const
 273 {
 274         if(depth==MAX_DEPTH)return 0;depth_counter counter(depth);
 275
 276         if (canvas) {
 277                 Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
 278
 279                 if(canvas && get_amount() && canvas->get_context().get_color(target_pos).get_a()>=0.25)
 280                 {
 281                         if(!children_lock)
 282                         {
 283                                 return canvas->get_context().hit_check(target_pos);
 284                         }
 285                         return const_cast<Layer_PasteCanvas*>(this);
 286                 }
 287         }
 288         return context.hit_check(pos);
 289 }
 290
 291 Color
 292 Layer_PasteCanvas::get_color(Context context, const Point &pos)const
 293 {
 294         if(!canvas || !get_amount())
 295                 return context.get_color(pos);
 296
 297         if(depth==MAX_DEPTH)return Color::alpha();depth_counter counter(depth);
 298
 299         Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
 300
 301         return Color::blend(canvas->get_context().get_color(target_pos),context.get_color(pos),get_amount(),get_blend_method());
 302 }
 303
 304
 305 bool
 306 Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 307 {
 308         if(cb && !cb->amount_complete(0,10000)) return false;
 309
 310         if(depth==MAX_DEPTH)
 311                 // if we are at the extent of our depth,
 312                 // then we should just return whatever is under us.
 313                 return context.accelerated_render(surface,quality,renddesc,cb);
 314
 315         depth_counter counter(depth);
 316
 317         if(!canvas || !get_amount())
 318                 return context.accelerated_render(surface,quality,renddesc,cb);
 319
 320         if(muck_with_time_ && curr_time!=Time::begin() && canvas->get_time()!=curr_time+time_offset)
 321                 canvas->set_time(curr_time+time_offset);
 322
 323         SuperCallback stageone(cb,0,4500,10000);
 324         SuperCallback stagetwo(cb,4500,9000,10000);
 325         SuperCallback stagethree(cb,9000,9999,10000);
 326
 327         RendDesc desc(renddesc);
 328         Vector::value_type zoomfactor=1.0/exp(zoom);
 329         desc.clear_flags();
 330         desc.set_tl((desc.get_tl()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
 331         desc.set_br((desc.get_br()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
 332         desc.set_flags(RendDesc::PX_ASPECT);
 333
 334         if (is_solid_color() || context->empty())
 335         {
 336                 surface->set_wh(renddesc.get_w(),renddesc.get_h());
 337                 surface->clear();
 338         }
 339         else if (!context.accelerated_render(surface,quality,renddesc,&stageone))
 340                 return false;
 341
 342         Color::BlendMethod blend_method(get_blend_method());
 343         const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
 344
 345         bool blend_using_straight = false; // use 'straight' just for the central blit
 346
 347         // sometimes the user changes the parameters while we're
 348         // rendering, causing our pasted canvas' bounding box to shrink
 349         // and no longer overlap with our tile.  if that has happened,
 350         // let's just stop now - we'll be refreshing soon anyway
 351         //! \todo shouldn't a mutex ensure this isn't needed?
 352         // http://synfig.org/images/d/d2/Bbox-change.sifz is an example
 353         // that shows this happening - open the encapsulation, select the
 354         // 'shade', and toggle the 'invert' parameter quickly.
 355         // Occasionally you'll see:
 356         //   error: Context::accelerated_render(): Layer "shade" threw a bad_alloc exception!
 357         // where the shade layer tries to allocate itself a canvas of
 358         // negative proportions, due to changing bounding boxes.
 359         if (!etl::intersect(desc.get_rect(), full_bounding_rect))
 360         {
 361                 warning("%s:%d bounding box shrank while rendering?", __FILE__, __LINE__);
 362                 return true;
 363         }
 364
 365         // we have rendered what's under us, if necessary
 366         if(context->empty())
 367         {
 368                 // if there's nothing under us, and we're blending 'onto', then we've finished
 369                 if (Color::is_onto(blend_method)) return true;
 370
 371                 // there's nothing under us, so using straight blending is
 372                 // faster than and equivalent to using composite, but we don't
 373                 // want to blank the surrounding areas
 374                 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
 375         }
 376
 377         if (!etl::intersect(context.get_full_bounding_rect(),full_bounding_rect+origin))
 378         {
 379                 // if there's no intersection between the context and our surface, and we're rendering 'onto', then we're done
 380                 if (Color::is_onto(blend_method)) return true;
 381
 382                 /* 'straight' is faster than 'composite' and has the same
 383                  * effect if the affected area of the lower layer is
 384                  * transparent;  however, if we're not clipping the blit to
 385                  * just the bounding rectangle, the affected area is the whole
 386                  * tile, so we can't use this optimisation.  if we are
 387                  * clipping, then we can use 'straight' to blit the clipped
 388                  * rectangle, but we shouldn't set blend_method to 'straight',
 389                  * or the surrounding areas will be blanked, which we don't
 390                  * want.
 391                  */
 392 #ifdef SYNFIG_CLIP_PASTECANVAS
 393                 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
 394 #endif  // SYNFIG_CLIP_PASTECANVAS
 395         }
 396
 397 #ifdef SYNFIG_CLIP_PASTECANVAS
 398         Rect area(desc.get_rect() & full_bounding_rect);
 399
 400         Point min(area.get_min());
 401         Point max(area.get_max());
 402
 403         if (desc.get_tl()[0] > desc.get_br()[0]) swap(min[0], max[0]);
 404         if (desc.get_tl()[1] > desc.get_br()[1]) swap(min[1], max[1]);
 405
 406         const int x(floor_to_int((min[0] - desc.get_tl()[0]) / desc.get_pw()));
 407         const int y(floor_to_int((min[1] - desc.get_tl()[1]) / desc.get_ph()));
 408         const int w( ceil_to_int((max[0] - desc.get_tl()[0]) / desc.get_pw()) - x);
 409         const int h( ceil_to_int((max[1] - desc.get_tl()[1]) / desc.get_ph()) - y);
 410
 411         const int tw = desc.get_w();
 412         const int th = desc.get_h();
 413
 414         desc.set_subwindow(x,y,w,h);
 415
 416         // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
 417         //               it was causing bug #1809480 (Zoom in beyond 8.75 in nested canvases fails)
 418         if(desc.get_w()==0 || desc.get_h()==0)
 419         {
 420                 if(cb && !cb->amount_complete(10000,10000)) return false;
 421                 return true;
 422         }
 423
 424         // SYNFIG_CLIP_PASTECANVAS is defined, so we are only touching the
 425         // pixels within the affected rectangle.  If the blend method is
 426         // 'straight', then we need to blend transparent pixels with the
 427         // clipped areas of this tile, because with the 'straight' blend
 428         // method, even transparent pixels have an effect on the layers below
 429         if (Color::is_straight(blend_method))
 430         {
 431                 Surface clearsurface;
 432
 433                 Surface::alpha_pen apen(surface->begin());
 434                 apen.set_alpha(get_amount());
 435
 436                 // the area we're about to blit is transparent, so it doesn't
 437                 // matter whether we use 'straight' or 'straight onto' here
 438                 if (blend_method == Color::BLEND_ALPHA_BRIGHTEN)
 439                         apen.set_blend_method(blend_method);
 440                 else
 441                         apen.set_blend_method(Color::BLEND_STRAIGHT);
 442
 443                 /* This represents the area we're pasting into the tile,
 444                  * within the tile as a whole.  Areas (A), (B), (C) and (D)
 445                  * need blending with the underlying context if they're not
 446                  * zero-sized:
 447                  *
 448                  *               0         x             x+w      tw
 449                  *       0       +------------------------+
 450                  *               |                                                |
 451                  *               |                      (A)                       |
 452                  *               |                                                |
 453                  *       y       | - - +----------+ - - - |
 454                  *               |         |              |               |
 455                  *               | (C) |  w by h  |      (D)  |
 456                  *               |         |              |               |
 457                  *       y+h | - - +----------+ - - - |
 458                  *               |                                                |
 459                  *               |                      (B)                       |
 460                  *               |                                                |
 461                  *       tw      +------------------------+
 462                  */
 463
 464                 if (y > 0)                              // draw the full-width strip above the rectangle (A)
 465                 { apen.move_to(0,0);   clearsurface.set_wh(tw,y);        clearsurface.clear(); clearsurface.blit_to(apen); }
 466                 if (y+h < th)                   // draw the full-width strip below the rectangle (B)
 467                 { apen.move_to(0,y+h); clearsurface.set_wh(tw,th-(y+h)); clearsurface.clear(); clearsurface.blit_to(apen); }
 468                 if (x > 0)                              // draw the box directly left of the rectangle (C)
 469                 { apen.move_to(0,y);   clearsurface.set_wh(x,h);         clearsurface.clear(); clearsurface.blit_to(apen); }
 470                 if (x+w < tw)                   // draw the box directly right of the rectangle (D)
 471                 { apen.move_to(x+w,y); clearsurface.set_wh(tw-(x+w),h);  clearsurface.clear(); clearsurface.blit_to(apen); }
 472         }
 473 #endif  // SYNFIG_CLIP_PASTECANVAS
 474
 475         // render the canvas to be pasted onto pastesurface
 476         Surface pastesurface;
 477         if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
 478                 return false;
 479
 480 #ifdef SYNFIG_CLIP_PASTECANVAS
 481         Surface::alpha_pen apen(surface->get_pen(x,y));
 482 #else  // SYNFIG_CLIP_PASTECANVAS
 483         Surface::alpha_pen apen(surface->begin());
 484 #endif  // SYNFIG_CLIP_PASTECANVAS
 485
 486         apen.set_alpha(get_amount());
 487         apen.set_blend_method(blend_using_straight ? Color::BLEND_STRAIGHT : blend_method);
 488         pastesurface.blit_to(apen);
 489
 490         if(cb && !cb->amount_complete(10000,10000)) return false;
 491
 492         return true;
 493 }
 494
 495 Rect
 496 Layer_PasteCanvas::get_bounding_rect()const
 497 {
 498         return bounds;
 499 }
 500
 501 void Layer_PasteCanvas::get_times_vfunc(Node::time_set &set) const
 502 {
 503         Node::time_set tset;
 504         if(canvas) tset = canvas->get_times();
 505
 506         Node::time_set::iterator i = tset.begin(), end = tset.end();
 507
 508         //Make sure we offset the time...
 509         //! \todo: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
 510         //                 (recursing down the tree needs to take this into account too...)
 511         for(; i != end; ++i)
 512                 set.insert(*i
 513 #ifdef ADJUST_WAYPOINTS_FOR_TIME_OFFSET // see node.h
 514                                    - time_offset
 515 #endif
 516                         );
 517
 518         Layer::get_times_vfunc(set);
 519 }