src/filters/convolvematrix.cpp

   1 #define __SP_FECONVOLVEMATRIX_CPP__
   2
   3 /** \file
   4  * SVG <feConvolveMatrix> implementation.
   5  *
   6  */
   7 /*
   8  * Authors:
   9  *   Felipe Corrêa da Silva Sanches <juca@members.fsf.org>
  10  *   hugo Rodrigues <haa.rodrigues@gmail.com>
  11  *
  12  * Copyright (C) 2006 Hugo Rodrigues
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  */
  16
  17 #ifdef HAVE_CONFIG_H
  18 # include "config.h"
  19 #endif
  20
  21 #include <string.h>
  22
  23 #include <vector>
  24 #include "attributes.h"
  25 #include "svg/svg.h"
  26 #include "convolvematrix.h"
  27 #include "helper-fns.h"
  28 #include "xml/repr.h"
  29 #include "display/nr-filter-convolve-matrix.h"
  30 #include <math.h>
  31
  32 /* FeConvolveMatrix base class */
  33
  34 static void sp_feConvolveMatrix_class_init(SPFeConvolveMatrixClass *klass);
  35 static void sp_feConvolveMatrix_init(SPFeConvolveMatrix *feConvolveMatrix);
  36
  37 static void sp_feConvolveMatrix_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  38 static void sp_feConvolveMatrix_release(SPObject *object);
  39 static void sp_feConvolveMatrix_set(SPObject *object, unsigned int key, gchar const *value);
  40 static void sp_feConvolveMatrix_update(SPObject *object, SPCtx *ctx, guint flags);
  41 static Inkscape::XML::Node *sp_feConvolveMatrix_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
  42 static void sp_feConvolveMatrix_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
  43
  44 static SPFilterPrimitiveClass *feConvolveMatrix_parent_class;
  45
  46 GType
  47 sp_feConvolveMatrix_get_type()
  48 {
  49     static GType feConvolveMatrix_type = 0;
  50
  51     if (!feConvolveMatrix_type) {
  52         GTypeInfo feConvolveMatrix_info = {
  53             sizeof(SPFeConvolveMatrixClass),
  54             NULL, NULL,
  55             (GClassInitFunc) sp_feConvolveMatrix_class_init,
  56             NULL, NULL,
  57             sizeof(SPFeConvolveMatrix),
  58             16,
  59             (GInstanceInitFunc) sp_feConvolveMatrix_init,
  60             NULL,    /* value_table */
  61         };
  62         feConvolveMatrix_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeConvolveMatrix", &feConvolveMatrix_info, (GTypeFlags)0);
  63     }
  64     return feConvolveMatrix_type;
  65 }
  66
  67 static void
  68 sp_feConvolveMatrix_class_init(SPFeConvolveMatrixClass *klass)
  69 {
  70     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  71     SPFilterPrimitiveClass *sp_primitive_class = (SPFilterPrimitiveClass *)klass;
  72
  73     feConvolveMatrix_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
  74
  75     sp_object_class->build = sp_feConvolveMatrix_build;
  76     sp_object_class->release = sp_feConvolveMatrix_release;
  77     sp_object_class->write = sp_feConvolveMatrix_write;
  78     sp_object_class->set = sp_feConvolveMatrix_set;
  79     sp_object_class->update = sp_feConvolveMatrix_update;
  80
  81     sp_primitive_class->build_renderer = sp_feConvolveMatrix_build_renderer;
  82 }
  83
  84 static void
  85 sp_feConvolveMatrix_init(SPFeConvolveMatrix *feConvolveMatrix)
  86 {
  87     //Setting default values:
  88     feConvolveMatrix->order.set("3 3");
  89     feConvolveMatrix->targetX = 1;
  90     feConvolveMatrix->targetY = 1;
  91     feConvolveMatrix->edgeMode = Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_DUPLICATE;
  92     feConvolveMatrix->preserveAlpha = false;
  93
  94     //some helper variables:
  95     feConvolveMatrix->targetXIsSet = false;
  96     feConvolveMatrix->targetYIsSet = false;
  97     feConvolveMatrix->kernelMatrixIsSet = false;
  98 }
  99
 100 /**
 101  * Reads the Inkscape::XML::Node, and initializes SPFeConvolveMatrix variables.  For this to get called,
 102  * our name must be associated with a repr via "sp_object_type_register".  Best done through
 103  * sp-object-repr.cpp's repr_name_entries array.
 104  */
 105 static void
 106 sp_feConvolveMatrix_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 107 {
 108     if (((SPObjectClass *) feConvolveMatrix_parent_class)->build) {
 109         ((SPObjectClass *) feConvolveMatrix_parent_class)->build(object, document, repr);
 110     }
 111
 112     /*LOAD ATTRIBUTES FROM REPR HERE*/
 113     object->readAttr( "order");
 114     object->readAttr( "kernelMatrix");
 115     object->readAttr( "divisor");
 116     object->readAttr( "bias");
 117     object->readAttr( "targetX");
 118     object->readAttr( "targetY");
 119     object->readAttr( "edgeMode");
 120     object->readAttr( "kernelUnitLength");
 121     object->readAttr( "preserveAlpha");
 122 }
 123
 124 /**
 125  * Drops any allocated memory.
 126  */
 127 static void
 128 sp_feConvolveMatrix_release(SPObject *object)
 129 {
 130     if (((SPObjectClass *) feConvolveMatrix_parent_class)->release)
 131         ((SPObjectClass *) feConvolveMatrix_parent_class)->release(object);
 132 }
 133
 134 static Inkscape::Filters::FilterConvolveMatrixEdgeMode sp_feConvolveMatrix_read_edgeMode(gchar const *value){
 135     if (!value) return Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_DUPLICATE; //duplicate is default
 136     switch(value[0]){
 137         case 'd':
 138             if (strncmp(value, "duplicate", 9) == 0) return Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_DUPLICATE;
 139             break;
 140         case 'w':
 141             if (strncmp(value, "wrap", 4) == 0) return Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_WRAP;
 142             break;
 143         case 'n':
 144             if (strncmp(value, "none", 4) == 0) return Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_NONE;
 145             break;
 146     }
 147     return Inkscape::Filters::CONVOLVEMATRIX_EDGEMODE_DUPLICATE; //duplicate is default
 148 }
 149
 150 /**
 151  * Sets a specific value in the SPFeConvolveMatrix.
 152  */
 153 static void
 154 sp_feConvolveMatrix_set(SPObject *object, unsigned int key, gchar const *value)
 155 {
 156     SPFeConvolveMatrix *feConvolveMatrix = SP_FECONVOLVEMATRIX(object);
 157     (void)feConvolveMatrix;
 158     double read_num;
 159     int read_int;
 160     bool read_bool;
 161     Inkscape::Filters::FilterConvolveMatrixEdgeMode read_mode;
 162
 163     switch(key) {
 164         /*DEAL WITH SETTING ATTRIBUTES HERE*/
 165         case SP_ATTR_ORDER:
 166             feConvolveMatrix->order.set(value);
 167             //From SVG spec: If <orderY> is not provided, it defaults to <orderX>.
 168             if (feConvolveMatrix->order.optNumIsSet() == false)
 169                 feConvolveMatrix->order.setOptNumber(feConvolveMatrix->order.getNumber());
 170             if (feConvolveMatrix->targetXIsSet == false) feConvolveMatrix->targetX = (int) floor(feConvolveMatrix->order.getNumber()/2);
 171             if (feConvolveMatrix->targetYIsSet == false) feConvolveMatrix->targetY = (int) floor(feConvolveMatrix->order.getOptNumber()/2);
 172             object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 173             break;
 174         case SP_ATTR_KERNELMATRIX:
 175             if (value){
 176                 feConvolveMatrix->kernelMatrixIsSet = true;
 177                 feConvolveMatrix->kernelMatrix = helperfns_read_vector(value, (int) (feConvolveMatrix->order.getNumber() * feConvolveMatrix->order.getOptNumber()));
 178                 if (! feConvolveMatrix->divisorIsSet) {
 179                     feConvolveMatrix->divisor = 0;
 180                     for (unsigned int i = 0; i< feConvolveMatrix->kernelMatrix.size(); i++)
 181                         feConvolveMatrix->divisor += feConvolveMatrix->kernelMatrix[i];
 182                     if (feConvolveMatrix->divisor == 0) feConvolveMatrix->divisor = 1;
 183                 }
 184                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 185             } else {
 186                 g_warning("For feConvolveMatrix you MUST pass a kernelMatrix parameter!");
 187             }
 188             break;
 189         case SP_ATTR_DIVISOR:
 190             if (value) {
 191                 read_num = helperfns_read_number(value);
 192                 if (read_num == 0) {
 193                     // This should actually be an error, but given our UI it is more useful to simply set divisor to the default.
 194                     if (feConvolveMatrix->kernelMatrixIsSet) {
 195                         for (unsigned int i = 0; i< feConvolveMatrix->kernelMatrix.size(); i++)
 196                             read_num += feConvolveMatrix->kernelMatrix[i];
 197                     }
 198                     if (read_num == 0) read_num = 1;
 199                     if (feConvolveMatrix->divisorIsSet || feConvolveMatrix->divisor!=read_num) {
 200                         feConvolveMatrix->divisorIsSet = false;
 201                         feConvolveMatrix->divisor = read_num;
 202                         object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 203                     }
 204                 } else if (!feConvolveMatrix->divisorIsSet || feConvolveMatrix->divisor!=read_num) {
 205                     feConvolveMatrix->divisorIsSet = true;
 206                     feConvolveMatrix->divisor = read_num;
 207                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 208                 }
 209             }
 210             break;
 211         case SP_ATTR_BIAS:
 212             read_num = 0;
 213             if (value) read_num = helperfns_read_number(value);
 214             if (read_num != feConvolveMatrix->bias){
 215                 feConvolveMatrix->bias = read_num;
 216                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 217             }
 218             break;
 219         case SP_ATTR_TARGETX:
 220             if (value) {
 221                 read_int = (int) helperfns_read_number(value);
 222                 if (read_int < 0 || read_int > feConvolveMatrix->order.getNumber()){
 223                     g_warning("targetX must be a value between 0 and orderX! Assuming floor(orderX/2) as default value.");
 224                     read_int = (int) floor(feConvolveMatrix->order.getNumber()/2.0);
 225                 }
 226                 feConvolveMatrix->targetXIsSet = true;
 227                 if (read_int != feConvolveMatrix->targetX){
 228                     feConvolveMatrix->targetX = read_int;
 229                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 230                 }
 231             }
 232             break;
 233         case SP_ATTR_TARGETY:
 234             if (value) {
 235                 read_int = (int) helperfns_read_number(value);
 236                 if (read_int < 0 || read_int > feConvolveMatrix->order.getOptNumber()){
 237                     g_warning("targetY must be a value between 0 and orderY! Assuming floor(orderY/2) as default value.");
 238                     read_int = (int) floor(feConvolveMatrix->order.getOptNumber()/2.0);
 239                 }
 240                 feConvolveMatrix->targetYIsSet = true;
 241                 if (read_int != feConvolveMatrix->targetY){
 242                     feConvolveMatrix->targetY = read_int;
 243                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 244                 }
 245             }
 246             break;
 247         case SP_ATTR_EDGEMODE:
 248             read_mode = sp_feConvolveMatrix_read_edgeMode(value);
 249             if (read_mode != feConvolveMatrix->edgeMode){
 250                 feConvolveMatrix->edgeMode = read_mode;
 251                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 252             }
 253             break;
 254         case SP_ATTR_KERNELUNITLENGTH:
 255             feConvolveMatrix->kernelUnitLength.set(value);
 256             //From SVG spec: If the <dy> value is not specified, it defaults to the same value as <dx>.
 257             if (feConvolveMatrix->kernelUnitLength.optNumIsSet() == false)
 258                 feConvolveMatrix->kernelUnitLength.setOptNumber(feConvolveMatrix->kernelUnitLength.getNumber());
 259             object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 260             break;
 261         case SP_ATTR_PRESERVEALPHA:
 262             read_bool = helperfns_read_bool(value, false);
 263             if (read_bool != feConvolveMatrix->preserveAlpha){
 264                 feConvolveMatrix->preserveAlpha = read_bool;
 265                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 266             }
 267             break;
 268         default:
 269             if (((SPObjectClass *) feConvolveMatrix_parent_class)->set)
 270                 ((SPObjectClass *) feConvolveMatrix_parent_class)->set(object, key, value);
 271             break;
 272     }
 273
 274 }
 275
 276 /**
 277  * Receives update notifications.
 278  */
 279 static void
 280 sp_feConvolveMatrix_update(SPObject *object, SPCtx *ctx, guint flags)
 281 {
 282     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 283                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 284
 285         /* do something to trigger redisplay, updates? */
 286
 287     }
 288
 289     if (((SPObjectClass *) feConvolveMatrix_parent_class)->update) {
 290         ((SPObjectClass *) feConvolveMatrix_parent_class)->update(object, ctx, flags);
 291     }
 292 }
 293
 294 /**
 295  * Writes its settings to an incoming repr object, if any.
 296  */
 297 static Inkscape::XML::Node *
 298 sp_feConvolveMatrix_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
 299 {
 300     /* TODO: Don't just clone, but create a new repr node and write all
 301      * relevant values into it */
 302     if (!repr) {
 303         repr = SP_OBJECT_REPR(object)->duplicate(doc);
 304     }
 305
 306
 307     if (((SPObjectClass *) feConvolveMatrix_parent_class)->write) {
 308         ((SPObjectClass *) feConvolveMatrix_parent_class)->write(object, doc, repr, flags);
 309     }
 310
 311     return repr;
 312 }
 313
 314 static void sp_feConvolveMatrix_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
 315     g_assert(primitive != NULL);
 316     g_assert(filter != NULL);
 317
 318     SPFeConvolveMatrix *sp_convolve = SP_FECONVOLVEMATRIX(primitive);
 319
 320     int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_CONVOLVEMATRIX);
 321     Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
 322     Inkscape::Filters::FilterConvolveMatrix *nr_convolve = dynamic_cast<Inkscape::Filters::FilterConvolveMatrix*>(nr_primitive);
 323     g_assert(nr_convolve != NULL);
 324
 325     sp_filter_primitive_renderer_common(primitive, nr_primitive);
 326
 327     nr_convolve->set_targetX(sp_convolve->targetX);
 328     nr_convolve->set_targetY(sp_convolve->targetY);
 329     nr_convolve->set_orderX( (int)sp_convolve->order.getNumber() );
 330     nr_convolve->set_orderY( (int)sp_convolve->order.getOptNumber() );
 331     nr_convolve->set_kernelMatrix(sp_convolve->kernelMatrix);
 332     nr_convolve->set_divisor(sp_convolve->divisor);
 333     nr_convolve->set_bias(sp_convolve->bias);
 334     nr_convolve->set_preserveAlpha(sp_convolve->preserveAlpha);
 335
 336 }
 337 /*
 338   Local Variables:
 339   mode:c++
 340   c-file-style:"stroustrup"
 341   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 342   indent-tabs-mode:nil
 343   fill-column:99
 344   End:
 345 */
 346 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :