Added copyright lines for files I've edited this year.
[synfig.git] / synfig-core / trunk / src / synfig / layer_pastecanvas.cpp
index dc95141..b161412 100644 (file)
@@ -1,11 +1,12 @@
 /* === S Y N F I G ========================================================= */
 /*!    \file layer_pastecanvas.cpp
-**     \brief Template Header
+**     \brief Implementation of the "Paste Canvas" layer
 **
 **     $Id$
 **
 **     \legal
 **     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
+**     Copyright (c) 2007, 2008 Chris Moore
 **
 **     This package is free software; you can redistribute it and/or
 **     modify it under the terms of the GNU General Public License as
@@ -52,8 +53,11 @@ using namespace synfig;
 
 #define MAX_DEPTH 10
 
+// if this isn't defined, the 'dead heads' in examples/pirates.sifz don't render properly
+#define SYNFIG_CLIP_PASTECANVAS
+
 //#ifdef __APPLE__
-//#define SYNFIG_NO_CLIP
+//#undef SYNFIG_CLIP_PASTECANVAS
 //#endif
 
 /* === C L A S S E S ======================================================= */
@@ -70,8 +74,8 @@ public:
 
 SYNFIG_LAYER_INIT(Layer_PasteCanvas);
 SYNFIG_LAYER_SET_NAME(Layer_PasteCanvas,"PasteCanvas"); // todo: use paste_canvas
-SYNFIG_LAYER_SET_LOCAL_NAME(Layer_PasteCanvas,_("Paste Canvas"));
-SYNFIG_LAYER_SET_CATEGORY(Layer_PasteCanvas,_("Other"));
+SYNFIG_LAYER_SET_LOCAL_NAME(Layer_PasteCanvas,N_("Paste Canvas"));
+SYNFIG_LAYER_SET_CATEGORY(Layer_PasteCanvas,N_("Other"));
 SYNFIG_LAYER_SET_VERSION(Layer_PasteCanvas,"0.1");
 SYNFIG_LAYER_SET_CVS_ID(Layer_PasteCanvas,"$Id$");
 
@@ -81,7 +85,8 @@ Layer_PasteCanvas::Layer_PasteCanvas():
        origin(0,0),
        depth(0),
        zoom(0),
-       time_offset(0)
+       time_offset(0),
+       extra_reference(false)
 {
        children_lock=false;
        muck_with_time_=true;
@@ -99,6 +104,7 @@ Layer_PasteCanvas::~Layer_PasteCanvas()
        set_sub_canvas(0);
 
        //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       //if(extra_reference)
        //      canvas->unref();
 }
 
@@ -146,16 +152,32 @@ Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
 {
        IMPORT(origin);
 
+       // IMPORT(canvas);
        if(param=="canvas" && value.same_type_as(Canvas::Handle()))
        {
                set_sub_canvas(value.get(Canvas::Handle()));
                return true;
        }
 
-//     IMPORT(canvas);
+       //! \todo this introduces bug 1844764 if enabled; it was introduced in r954, but I can't see if it's useful
+#if 0
+       if (param=="time_offset" && value.same_type_as(time_offset))
+       {
+               if (time_offset != value.get(Time()))
+               {
+                       value.put(&time_offset);
+                       // notify that the time_offset has changed so we can update the
+                       // waypoint positions in parent layers
+                       changed();
+               }
+               return true;
+       }
+#else
+       IMPORT(time_offset);
+#endif
+
        IMPORT(children_lock);
        IMPORT(zoom);
-       IMPORT(time_offset);
 
        return Layer_Composite::set_param(param,value);
 }
@@ -166,7 +188,8 @@ Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
        if(canvas && muck_with_time_)
                remove_child(canvas.get());
 
-       if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       // if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       if (extra_reference)
                canvas->unref();
 
        child_changed_connection.disconnect();
@@ -182,13 +205,19 @@ Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
                );
        */
        if(canvas)
-               bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
+               bounds = ((canvas->get_context().get_full_bounding_rect() - canvas->rend_desc().get_focus()) * exp(zoom) +
+                                 origin + canvas->rend_desc().get_focus());
 
        if(canvas && muck_with_time_)
                add_child(canvas.get());
 
        if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       {
                canvas->ref();
+               extra_reference = true;
+       }
+       else
+               extra_reference = false;
 
        if(canvas)
                on_canvas_set();
@@ -279,21 +308,17 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        if(cb && !cb->amount_complete(0,10000)) return false;
 
        if(depth==MAX_DEPTH)
-       {
-               DEBUGPOINT();
                // if we are at the extent of our depth,
                // then we should just return whatever is under us.
                return context.accelerated_render(surface,quality,renddesc,cb);
-       }
+
        depth_counter counter(depth);
 
        if(!canvas || !get_amount())
                return context.accelerated_render(surface,quality,renddesc,cb);
 
        if(muck_with_time_ && curr_time!=Time::begin() && canvas->get_time()!=curr_time+time_offset)
-       {
                canvas->set_time(curr_time+time_offset);
-       }
 
        SuperCallback stageone(cb,0,4500,10000);
        SuperCallback stagetwo(cb,4500,9000,10000);
@@ -306,90 +331,161 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        desc.set_br((desc.get_br()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
        desc.set_flags(RendDesc::PX_ASPECT);
 
-       if(is_solid_color() || context->empty())
+       if (is_solid_color() || context->empty())
        {
                surface->set_wh(renddesc.get_w(),renddesc.get_h());
                surface->clear();
        }
-       else if(!context.accelerated_render(surface,quality,renddesc,&stageone))
+       else if (!context.accelerated_render(surface,quality,renddesc,&stageone))
                return false;
-       Color::BlendMethod blend_method(get_blend_method());
 
+       Color::BlendMethod blend_method(get_blend_method());
        const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
 
-       if(context->empty())
+       bool blend_using_straight = false; // use 'straight' just for the central blit
+
+       // sometimes the user changes the parameters while we're
+       // rendering, causing our pasted canvas' bounding box to shrink
+       // and no longer overlap with our tile.  if that has happened,
+       // let's just stop now - we'll be refreshing soon anyway
+       //! \todo shouldn't a mutex ensure this isn't needed?
+       // http://synfig.org/images/d/d2/Bbox-change.sifz is an example
+       // that shows this happening - open the encapsulation, select the
+       // 'shade', and toggle the 'invert' parameter quickly.
+       // Occasionally you'll see:
+       //   error: Context::accelerated_render(): Layer "shade" threw a bad_alloc exception!
+       // where the shade layer tries to allocate itself a canvas of
+       // negative proportions, due to changing bounding boxes.
+       if (!etl::intersect(desc.get_rect(), full_bounding_rect))
        {
-               if(Color::is_onto(blend_method))
-                       return true;
-
-               if(blend_method==Color::BLEND_COMPOSITE)
-                       blend_method=Color::BLEND_STRAIGHT;
+               warning("%s:%d bounding box shrank while rendering?", __FILE__, __LINE__);
+               return true;
        }
-       else
-       if(!etl::intersect(context.get_full_bounding_rect(),full_bounding_rect+origin))
+
+       // we have rendered what's under us, if necessary
+       if(context->empty())
        {
-               if(Color::is_onto(blend_method))
-                       return true;
+               // if there's nothing under us, and we're blending 'onto', then we've finished
+               if (Color::is_onto(blend_method)) return true;
 
-               if(blend_method==Color::BLEND_COMPOSITE)
-                       blend_method=Color::BLEND_STRAIGHT;
+               // there's nothing under us, so using straight blending is
+               // faster than and equivalent to using composite, but we don't
+               // want to blank the surrounding areas
+               if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
        }
 
-#ifndef SYNFIG_NO_CLIP
+       if (!etl::intersect(context.get_full_bounding_rect(),full_bounding_rect+origin))
        {
-               //synfig::info("PasteCanv Clip");
-               Rect area(desc.get_rect()&full_bounding_rect);
-
-               Point min(area.get_min());
-               Point max(area.get_max());
+               // if there's no intersection between the context and our surface, and we're rendering 'onto', then we're done
+               if (Color::is_onto(blend_method)) return true;
+
+               /* 'straight' is faster than 'composite' and has the same
+                * effect if the affected area of the lower layer is
+                * transparent;  however, if we're not clipping the blit to
+                * just the bounding rectangle, the affected area is the whole
+                * tile, so we can't use this optimisation.  if we are
+                * clipping, then we can use 'straight' to blit the clipped
+                * rectangle, but we shouldn't set blend_method to 'straight',
+                * or the surrounding areas will be blanked, which we don't
+                * want.
+                */
+#ifdef SYNFIG_CLIP_PASTECANVAS
+               if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
+#endif // SYNFIG_CLIP_PASTECANVAS
+       }
 
-               if(desc.get_tl()[0]>desc.get_br()[0])
-                       swap(min[0],max[0]);
-               if(desc.get_tl()[1]>desc.get_br()[1])
-                       swap(min[1],max[1]);
+#ifdef SYNFIG_CLIP_PASTECANVAS
+       Rect area(desc.get_rect() & full_bounding_rect);
 
-               const int
-                       x(floor_to_int((min[0]-desc.get_tl()[0])/desc.get_pw())),
-                       y(floor_to_int((min[1]-desc.get_tl()[1])/desc.get_ph())),
-                       w(ceil_to_int((max[0]-desc.get_tl()[0])/desc.get_pw())-x),
-                       h(ceil_to_int((max[1]-desc.get_tl()[1])/desc.get_ph())-y);
+       Point min(area.get_min());
+       Point max(area.get_max());
 
-               desc.set_subwindow(x,y,w,h);
+       if (desc.get_tl()[0] > desc.get_br()[0]) swap(min[0], max[0]);
+       if (desc.get_tl()[1] > desc.get_br()[1]) swap(min[1], max[1]);
 
-               Surface pastesurface;
+       const int x(floor_to_int((min[0] - desc.get_tl()[0]) / desc.get_pw()));
+       const int y(floor_to_int((min[1] - desc.get_tl()[1]) / desc.get_ph()));
+       const int w( ceil_to_int((max[0] - desc.get_tl()[0]) / desc.get_pw()) - x);
+       const int h( ceil_to_int((max[1] - desc.get_tl()[1]) / desc.get_ph()) - y);
 
-               if(area.area()<=0.000001 || desc.get_w()==0 || desc.get_h()==0)
-               {
-                       if(cb && !cb->amount_complete(10000,10000)) return false;
+       const int tw = desc.get_w();
+       const int th = desc.get_h();
 
-                       return true;
-               }
+       desc.set_subwindow(x,y,w,h);
 
-               if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
-                       return false;
+       // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
+       //               it was causing bug #1809480 (Zoom in beyond 8.75 in nested canvases fails)
+       if(desc.get_w()==0 || desc.get_h()==0)
+       {
+               if(cb && !cb->amount_complete(10000,10000)) return false;
+               return true;
+       }
 
-               Surface::alpha_pen apen(surface->get_pen(x,y));
+       // SYNFIG_CLIP_PASTECANVAS is defined, so we are only touching the
+       // pixels within the affected rectangle.  If the blend method is
+       // 'straight', then we need to blend transparent pixels with the
+       // clipped areas of this tile, because with the 'straight' blend
+       // method, even transparent pixels have an effect on the layers below
+       if (Color::is_straight(blend_method))
+       {
+               Surface clearsurface;
 
+               Surface::alpha_pen apen(surface->begin());
                apen.set_alpha(get_amount());
-               apen.set_blend_method(blend_method);
 
-               pastesurface.blit_to(apen);
+               // the area we're about to blit is transparent, so it doesn't
+               // matter whether we use 'straight' or 'straight onto' here
+               if (blend_method == Color::BLEND_ALPHA_BRIGHTEN)
+                       apen.set_blend_method(blend_method);
+               else
+                       apen.set_blend_method(Color::BLEND_STRAIGHT);
+
+               /* This represents the area we're pasting into the tile,
+                * within the tile as a whole.  Areas (A), (B), (C) and (D)
+                * need blending with the underlying context if they're not
+                * zero-sized:
+                *
+                *               0         x             x+w      tw
+                *       0       +------------------------+
+                *               |                                                |
+                *               |                      (A)                       |
+                *               |                                                |
+                *       y       | - - +----------+ - - - |
+                *               |         |              |               |
+                *               | (C) |  w by h  |      (D)  |
+                *               |         |              |               |
+                *       y+h | - - +----------+ - - - |
+                *               |                                                |
+                *               |                      (B)                       |
+                *               |                                                |
+                *       tw      +------------------------+
+                */
+
+               if (y > 0)                              // draw the full-width strip above the rectangle (A)
+               { apen.move_to(0,0);   clearsurface.set_wh(tw,y);        clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (y+h < th)                   // draw the full-width strip below the rectangle (B)
+               { apen.move_to(0,y+h); clearsurface.set_wh(tw,th-(y+h)); clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (x > 0)                              // draw the box directly left of the rectangle (C)
+               { apen.move_to(0,y);   clearsurface.set_wh(x,h);         clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (x+w < tw)                   // draw the box directly right of the rectangle (D)
+               { apen.move_to(x+w,y); clearsurface.set_wh(tw-(x+w),h);  clearsurface.clear(); clearsurface.blit_to(apen); }
        }
-#else
-       {
-               Surface pastesurface;
+#endif // SYNFIG_CLIP_PASTECANVAS
 
-               if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
-                       return false;
-
-               Surface::alpha_pen apen(surface->begin());
+       // render the canvas to be pasted onto pastesurface
+       Surface pastesurface;
+       if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
+               return false;
 
-               apen.set_alpha(get_amount());
-               apen.set_blend_method(blend_method);
+#ifdef SYNFIG_CLIP_PASTECANVAS
+       Surface::alpha_pen apen(surface->get_pen(x,y));
+#else  // SYNFIG_CLIP_PASTECANVAS
+       Surface::alpha_pen apen(surface->begin());
+#endif // SYNFIG_CLIP_PASTECANVAS
 
-               pastesurface.blit_to(apen);
-       }
-#endif
+       apen.set_alpha(get_amount());
+       apen.set_blend_method(blend_using_straight ? Color::BLEND_STRAIGHT : blend_method);
+       pastesurface.blit_to(apen);
 
        if(cb && !cb->amount_complete(10000,10000)) return false;
 
@@ -407,16 +503,17 @@ void Layer_PasteCanvas::get_times_vfunc(Node::time_set &set) const
        Node::time_set tset;
        if(canvas) tset = canvas->get_times();
 
-       Node::time_set::iterator        i = tset.begin(),
-                                                                       end = tset.end();
+       Node::time_set::iterator i = tset.begin(), end = tset.end();
 
        //Make sure we offset the time...
-       //TODO: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
-       //              (recursing down the tree needs to take this into account too...)
+       //! \todo: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
+       //                 (recursing down the tree needs to take this into account too...)
        for(; i != end; ++i)
-       {
-               set.insert(*i + time_offset);
-       }
+               set.insert(*i
+#ifdef ADJUST_WAYPOINTS_FOR_TIME_OFFSET // see node.h
+                                  - time_offset
+#endif
+                       );
 
        Layer::get_times_vfunc(set);
 }