synfig-core/src/modules/mod_filter/blur.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file mod_filter/blur.cpp
   3 **      \brief Implementation of the "Blur" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 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 "blur.h"
  34
  35 #include <synfig/string.h>
  36 #include <synfig/time.h>
  37 #include <synfig/context.h>
  38 #include <synfig/paramdesc.h>
  39 #include <synfig/renddesc.h>
  40 #include <synfig/surface.h>
  41 #include <synfig/value.h>
  42 #include <synfig/valuenode.h>
  43 #include <synfig/segment.h>
  44
  45 #include <cstring>
  46 #include <ETL/pen>
  47
  48 #endif
  49
  50 using namespace synfig;
  51 using namespace etl;
  52 using namespace std;
  53
  54 /*#define TYPE_BOX                      0
  55 #define TYPE_FASTGUASSIAN       1
  56 #define TYPE_FASTGAUSSIAN       1
  57 #define TYPE_CROSS                      2
  58 #define TYPE_GUASSIAN           3
  59 #define TYPE_GAUSSIAN           3
  60 #define TYPE_DISC                       4
  61 */
  62
  63 /* -- G L O B A L S --------------------------------------------------------- */
  64
  65 SYNFIG_LAYER_INIT(Blur_Layer);
  66 SYNFIG_LAYER_SET_NAME(Blur_Layer,"blur");
  67 SYNFIG_LAYER_SET_LOCAL_NAME(Blur_Layer,N_("Blur"));
  68 SYNFIG_LAYER_SET_CATEGORY(Blur_Layer,N_("Blurs"));
  69 SYNFIG_LAYER_SET_VERSION(Blur_Layer,"0.2");
  70 SYNFIG_LAYER_SET_CVS_ID(Blur_Layer,"$Id$");
  71
  72 /* -- F U N C T I O N S ----------------------------------------------------- */
  73
  74 inline void clamp(synfig::Vector &v)
  75 {
  76         if(v[0]<0.0)v[0]=0.0;
  77         if(v[1]<0.0)v[1]=0.0;
  78 }
  79
  80 Blur_Layer::Blur_Layer():
  81         Layer_Composite(1.0,Color::BLEND_STRAIGHT),
  82         size(0.1,0.1),
  83         type(Blur::FASTGAUSSIAN)
  84 {
  85         Layer::Vocab voc(get_param_vocab());
  86         Layer::fill_static(voc);
  87         set_param_static("blend_method", true);
  88 }
  89
  90 bool
  91 Blur_Layer::set_param(const String &param, const ValueBase &value)
  92 {
  93         IMPORT_PLUS(size,clamp(size));
  94         IMPORT(type);
  95
  96         return Layer_Composite::set_param(param,value);
  97 }
  98
  99 ValueBase
 100 Blur_Layer::get_param(const String &param)const
 101 {
 102         EXPORT(size);
 103         EXPORT(type);
 104
 105         EXPORT_NAME();
 106         EXPORT_VERSION();
 107
 108         return Layer_Composite::get_param(param);
 109 }
 110
 111 Color
 112 Blur_Layer::get_color(Context context, const Point &pos)const
 113 {
 114         Point blurpos = Blur(size,type)(pos);
 115
 116         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
 117                 return context.get_color(blurpos);
 118
 119         if(get_amount()==0.0)
 120                 return context.get_color(pos);
 121
 122         return Color::blend(context.get_color(blurpos),context.get_color(pos),get_amount(),get_blend_method());
 123 }
 124
 125 bool
 126 Blur_Layer::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 127 {
 128         // don't do anything at quality 10
 129         if (quality == 10)
 130                 return context.accelerated_render(surface,quality,renddesc,cb);
 131
 132         // int x,y;
 133         SuperCallback stageone(cb,0,5000,10000);
 134         SuperCallback stagetwo(cb,5000,10000,10000);
 135
 136         const int       w = renddesc.get_w(),
 137                                 h = renddesc.get_h();
 138         const Real      pw = renddesc.get_pw(),
 139                                 ph = renddesc.get_ph();
 140
 141         RendDesc        workdesc(renddesc);
 142         Surface         worksurface,blurred;
 143
 144         //callbacks depend on how long the blur takes
 145         if(size[0] || size[1])
 146         {
 147                 if(type == Blur::DISC)
 148                 {
 149                         stageone = SuperCallback(cb,0,5000,10000);
 150                         stagetwo = SuperCallback(cb,5000,10000,10000);
 151                 }
 152                 else
 153                 {
 154                         stageone = SuperCallback(cb,0,9000,10000);
 155                         stagetwo = SuperCallback(cb,9000,10000,10000);
 156                 }
 157         }
 158         else
 159         {
 160                 stageone = SuperCallback(cb,0,9999,10000);
 161                 stagetwo = SuperCallback(cb,9999,10000,10000);
 162         }
 163
 164         //expand the working surface to accommodate the blur
 165
 166         //the expanded size = 1/2 the size in each direction rounded up
 167         int     halfsizex = (int) (abs(size[0]*.5/pw) + 3),
 168                 halfsizey = (int) (abs(size[1]*.5/ph) + 3);
 169
 170         //expand by 1/2 size in each direction on either side
 171         switch(type)
 172         {
 173                 case Blur::DISC:
 174                 case Blur::BOX:
 175                 case Blur::CROSS:
 176                 {
 177                         workdesc.set_subwindow(-max(1,halfsizex),-max(1,halfsizey),w+2*max(1,halfsizex),h+2*max(1,halfsizey));
 178                         break;
 179                 }
 180                 case Blur::FASTGAUSSIAN:
 181                 {
 182                         if(quality < 4)
 183                         {
 184                                 halfsizex*=2;
 185                                 halfsizey*=2;
 186                         }
 187                         workdesc.set_subwindow(-max(1,halfsizex),-max(1,halfsizey),w+2*max(1,halfsizex),h+2*max(1,halfsizey));
 188                         break;
 189                 }
 190                 case Blur::GAUSSIAN:
 191                 {
 192                 #define GAUSSIAN_ADJUSTMENT             (0.05)
 193                         Real    pw = (Real)workdesc.get_w()/(workdesc.get_br()[0]-workdesc.get_tl()[0]);
 194                         Real    ph = (Real)workdesc.get_h()/(workdesc.get_br()[1]-workdesc.get_tl()[1]);
 195
 196                         pw=pw*pw;
 197                         ph=ph*ph;
 198
 199                         halfsizex = (int)(abs(pw)*size[0]*GAUSSIAN_ADJUSTMENT+0.5);
 200                         halfsizey = (int)(abs(ph)*size[1]*GAUSSIAN_ADJUSTMENT+0.5);
 201
 202                         halfsizex = (halfsizex + 1)/2;
 203                         halfsizey = (halfsizey + 1)/2;
 204                         workdesc.set_subwindow( -halfsizex, -halfsizey, w+2*halfsizex, h+2*halfsizey );
 205
 206                         break;
 207                 }
 208         }
 209
 210         //render the background onto the expanded surface
 211         if(!context.accelerated_render(&worksurface,quality,workdesc,&stageone))
 212                 return false;
 213
 214         //blur the image
 215         Blur(size,type,&stagetwo)(worksurface,workdesc.get_br()-workdesc.get_tl(),blurred);
 216
 217         //be sure the surface is of the correct size
 218         surface->set_wh(renddesc.get_w(),renddesc.get_h());
 219
 220         {
 221                 Surface::pen pen(surface->begin());
 222                 worksurface.blit_to(pen,halfsizex,halfsizey,renddesc.get_w(),renddesc.get_h());
 223         }
 224         {
 225                 Surface::alpha_pen pen(surface->begin());
 226                 pen.set_alpha(get_amount());
 227                 pen.set_blend_method(get_blend_method());
 228                 blurred.blit_to(pen,halfsizex,halfsizey,renddesc.get_w(),renddesc.get_h());
 229         }
 230         if(cb && !cb->amount_complete(10000,10000))
 231         {
 232                 //if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
 233                 return false;
 234         }
 235
 236         return true;
 237 }
 238
 239 Layer::Vocab
 240 Blur_Layer::get_param_vocab(void)const
 241 {
 242         Layer::Vocab ret(Layer_Composite::get_param_vocab());
 243
 244         ret.push_back(ParamDesc("size")
 245                 .set_local_name(_("Size"))
 246                 .set_description(_("Size of Blur"))
 247         );
 248         ret.push_back(ParamDesc("type")
 249                 .set_local_name(_("Type"))
 250                 .set_description(_("Type of blur to use"))
 251                 .set_hint("enum")
 252                 .add_enum_value(Blur::BOX,"box",_("Box Blur"))
 253                 .add_enum_value(Blur::FASTGAUSSIAN,"fastgaussian",_("Fast Gaussian Blur"))
 254                 .add_enum_value(Blur::CROSS,"cross",_("Cross-Hatch Blur"))
 255                 .add_enum_value(Blur::GAUSSIAN,"gaussian",_("Gaussian Blur"))
 256                 .add_enum_value(Blur::DISC,"disc",_("Disc Blur"))
 257         );
 258
 259         return ret;
 260 }
 261
 262 Rect
 263 Blur_Layer::get_full_bounding_rect(Context context)const
 264 {
 265         if(is_disabled() || Color::is_onto(get_blend_method()))
 266                 return context.get_full_bounding_rect();
 267
 268         Rect bounds(context.get_full_bounding_rect().expand_x(size[0]).expand_y(size[1]));
 269
 270         return bounds;
 271 }