Code

add simplified feed_path_to_cairo functions
[inkscape.git] / src / display / nr-filter.cpp
index a3c361fb101531b0c1f4f46fa0ec2a4cc0b09eab..f7a04fd50383541d17dbd62f395b26ff993299a5 100644 (file)
@@ -6,35 +6,61 @@
  * Author:
  *   Niko Kiirala <niko@kiirala.com>
  *
- * Copyright (C) 2006 Niko Kiirala
+ * Copyright (C) 2006,2007 Niko Kiirala
  *
  * Released under GNU GPL, read the file 'COPYING' for more information
  */
 
 #include <glib.h>
+#include <cmath>
+#include <cstring>
+#include <string>
 
 #include "display/nr-filter.h"
 #include "display/nr-filter-primitive.h"
-#include "display/nr-filter-gaussian.h"
 #include "display/nr-filter-slot.h"
 #include "display/nr-filter-types.h"
+#include "display/nr-filter-units.h"
+
+#include "display/nr-filter-blend.h"
+#include "display/nr-filter-composite.h"
+#include "display/nr-filter-convolve-matrix.h"
+#include "display/nr-filter-colormatrix.h"
+#include "display/nr-filter-component-transfer.h"
+#include "display/nr-filter-diffuselighting.h"
+#include "display/nr-filter-displacement-map.h"
+#include "display/nr-filter-flood.h"
+#include "display/nr-filter-gaussian.h"
+#include "display/nr-filter-image.h"
+#include "display/nr-filter-merge.h"
+#include "display/nr-filter-morphology.h"
+#include "display/nr-filter-offset.h"
+#include "display/nr-filter-specularlighting.h"
+#include "display/nr-filter-tile.h"
+#include "display/nr-filter-turbulence.h"
 
 #include "display/nr-arena-item.h"
 #include "libnr/nr-pixblock.h"
 #include "libnr/nr-blit.h"
+#include "libnr/nr-matrix.h"
+#include "libnr/nr-scale.h"
 #include "svg/svg-length.h"
 #include "sp-filter-units.h"
-
-//#include "display/nr-arena-shape.h"
+#if defined (SOLARIS) && (SOLARIS == 8)
+#include "round.h"
+using Inkscape::round;
+#endif 
 
 namespace NR {
 
 Filter::Filter()
 {
-    _primitive_count = 1;
+    _primitive_count = 0;
     _primitive_table_size = 1;
     _primitive = new FilterPrimitive*[1];
-    _primitive[0] = new FilterGaussian;
+    _primitive[0] = NULL;
+    //_primitive_count = 1;
+    //_primitive[0] = new FilterGaussian;
     _common_init();
 }
 
@@ -51,13 +77,19 @@ Filter::Filter(int n)
 
 void Filter::_common_init() {
     _slot_count = 1;
+    // Having "not set" here as value means the output of last filter
+    // primitive will be used as output of this filter
     _output_slot = NR_FILTER_SLOT_NOT_SET;
 
+    // These are the default values for filter region,
+    // as specified in SVG standard
+    // NB: SVGLength.set takes prescaled percent values: -.10 means -10%
     _region_x.set(SVGLength::PERCENT, -.10, 0);
     _region_y.set(SVGLength::PERCENT, -.10, 0);
     _region_width.set(SVGLength::PERCENT, 1.20, 0);
     _region_height.set(SVGLength::PERCENT, 1.20, 0);
 
+    // Filter resolution, negative value here stands for "automatic"
     _x_pixels = -1.0;
     _y_pixels = -1.0;
 
@@ -74,108 +106,220 @@ Filter::~Filter()
 
 int Filter::render(NRArenaItem const *item, NRPixBlock *pb)
 {
-    FilterSlot slot(_slot_count);
+    if (!_primitive[0]) {
+        // TODO: Should clear the input buffer instead of just returning
+       return 1; 
+    }
+
+    Matrix trans = item->ctm;
+    FilterSlot slot(_slot_count, item);
+
+    Rect item_bbox;
+    try {
+        item_bbox = *item->item_bbox;
+    } catch (NR::IsNothing) {
+        // Bounding box might not exist, so create a dummy one.
+        Point zero(0, 0);
+        item_bbox = Rect(zero, zero);
+    }
+    if (item_bbox.min()[X] > item_bbox.max()[X]
+        || item_bbox.min()[Y] > item_bbox.max()[Y])
+    {
+        // Code below assumes non-negative size.
+        return 1;
+    }
+
+    Rect filter_area = filter_effect_area(item_bbox);
+    if (item_bbox.isEmpty()) {
+        // It's no use to try and filter an empty object.
+        return 1;
+    }
+        
+    FilterUnits units(_filter_units, _primitive_units);
+    units.set_ctm(trans);
+    units.set_item_bbox(item_bbox);
+    units.set_filter_area(filter_area);
+
+    // TODO: with filterRes of 0x0 should return an empty image
+    if (_x_pixels > 0) {
+        double y_len;
+        if (_y_pixels > 0) {
+            y_len = _y_pixels;
+        } else {
+            y_len = (_x_pixels * (filter_area.max()[Y] - filter_area.min()[Y]))
+                / (filter_area.max()[X] - filter_area.min()[X]);
+        }
+        units.set_automatic_resolution(false);
+        units.set_resolution(_x_pixels, y_len);
+    } else {
+        Point origo = filter_area.min();
+        origo *= trans;
+        Point max_i(filter_area.max()[X], filter_area.min()[Y]);
+        max_i *= trans;
+        Point max_j(filter_area.min()[X], filter_area.max()[Y]);
+        max_j *= trans;
+        double i_len = sqrt((origo[X] - max_i[X]) * (origo[X] - max_i[X])
+                            + (origo[Y] - max_i[Y]) * (origo[Y] - max_i[Y]));
+        double j_len = sqrt((origo[X] - max_j[X]) * (origo[X] - max_j[X])
+                            + (origo[Y] - max_j[Y]) * (origo[Y] - max_j[Y]));
+        units.set_automatic_resolution(true);
+        units.set_resolution(i_len, j_len);
+    }
+
+    units.set_paraller(false);
+    for (int i = 0 ; i < _primitive_count ; i++) {
+        if (_primitive[i]->get_input_traits() & TRAIT_PARALLER) {
+            units.set_paraller(true);
+            break;
+        }
+    }
+
+    slot.set_units(units);
+
     NRPixBlock *in = new NRPixBlock;
-    nr_pixblock_setup_fast(in, pb->mode,
-                           pb->area.x0, pb->area.y0,
+    nr_pixblock_setup_fast(in, pb->mode, pb->area.x0, pb->area.y0,
                            pb->area.x1, pb->area.y1, true);
+    if (in->size != NR_PIXBLOCK_SIZE_TINY && in->data.px == NULL) {
+        g_warning("NR::Filter::render: failed to reserve temporary buffer");
+        return 0;
+    }
     nr_blit_pixblock_pixblock(in, pb);
+    in->empty = FALSE;
     slot.set(NR_FILTER_SOURCEGRAPHIC, in);
-    in = NULL; // in is now handled by FilterSlot, we should not touch it
-
-    _primitive[0]->render(slot, *item->ctm);
 
-    NRPixBlock *out = slot.get(_output_slot);
+    // Check that we are rendering a non-empty area
+    in = slot.get(NR_FILTER_SOURCEGRAPHIC);
+    if (in->area.x1 - in->area.x0 <= 0 || in->area.y1 - in->area.y0 <= 0) {
+        if (in->area.x1 - in->area.x0 < 0 || in->area.y1 - in->area.y0 < 0) {
+            g_warning("NR::Filter::render: negative area! (%d, %d) (%d, %d)",
+                      in->area.x0, in->area.y0, in->area.x1, in->area.y1);
+        }
+        return 0;
+    }
+    in = NULL; // in is now handled by FilterSlot, we should not touch it
 
-    int size = (pb->area.x1 - pb->area.x0)
-        * (pb->area.y1 - pb->area.y0)
-        * NR_PIXBLOCK_BPP(pb);
-    memset(NR_PIXBLOCK_PX(pb), 0, size);
+    for (int i = 0 ; i < _primitive_count ; i++) {
+        _primitive[i]->render(slot, units);
+    }
 
-    nr_blit_pixblock_pixblock(pb, out);
+    slot.get_final(_output_slot, pb);
 
+    // Take note of the amount of used image slots
+    // -> next time this filter is rendered, we can reserve enough slots
+    // immediately
     _slot_count = slot.get_slot_count();
     return 0;
 }
 
-int Filter::get_enlarge(Matrix const &m)
-{
-    int enlarge = 0;
-    for ( int i = 0 ; i < _primitive_count ; i++ ) {
-        if(_primitive[i]) enlarge += _primitive[i]->get_enlarge(m);
+void Filter::area_enlarge(NRRectL &bbox, Matrix const &m) {
+    for (int i = 0 ; i < _primitive_count ; i++) {
+        if (_primitive[i]) _primitive[i]->area_enlarge(bbox, m);
     }
-    return enlarge;
 }
 
-void Filter::bbox_enlarge(NRRectL &bbox)
+void Filter::bbox_enlarge(NRRectL &bbox) {
+    // Modifying empty bounding boxes confuses rest of the renderer, so
+    // let's not do that.
+    if (bbox.x0 > bbox.x1 || bbox.y0 > bbox.y1) return;
+
+    /* TODO: this is wrong. Should use bounding box in user coordinates
+     * and find its extents in display coordinates. */
+    Point min(bbox.x0, bbox.y0);
+    Point max(bbox.x1, bbox.y1);
+    Rect tmp_bbox(min, max);
+
+    Rect enlarged = filter_effect_area(tmp_bbox);
+
+    bbox.x0 = (ICoord)enlarged.min()[X];
+    bbox.y0 = (ICoord)enlarged.min()[Y];
+    bbox.x1 = (ICoord)enlarged.max()[X];
+    bbox.y1 = (ICoord)enlarged.max()[Y];
+}
+
+Rect Filter::filter_effect_area(Rect const &bbox)
 {
-    int len_x = bbox.x1 - bbox.x0;
-    int len_y = bbox.y1 - bbox.y0;
+    Point minp, maxp;
+    double len_x = bbox.max()[X] - bbox.min()[X];
+    double len_y = bbox.max()[Y] - bbox.min()[Y];
     /* TODO: fetch somehow the object ex and em lengths */
     _region_x.update(12, 6, len_x);
     _region_y.update(12, 6, len_y);
     _region_width.update(12, 6, len_x);
     _region_height.update(12, 6, len_y);
-    if (_filter_units == SP_FILTER_UNITS_BOUNDINGBOX) {
-        if (_region_x.unit == PERCENT) {
-            bbox.x0 += _region_x.computed;
+    if (_filter_units == SP_FILTER_UNITS_OBJECTBOUNDINGBOX) {
+        if (_region_x.unit == SVGLength::PERCENT) {
+            minp[X] = bbox.min()[X] + _region_x.computed;
         } else {
-            bbox.x0 += _region_x.computed * len_x;
+            minp[X] = bbox.min()[X] + _region_x.computed * len_x;
         }
-        if (_region_width.unit == PERCENT) {
-            bbox.x1 = bbox.x0 + _region_width.computed;
+        if (_region_width.unit == SVGLength::PERCENT) {
+            maxp[X] = minp[X] + _region_width.computed;
         } else {
-            bbox.x1 = bbox.x0 + _region_width.computed * len_x;
+            maxp[X] = minp[X] + _region_width.computed * len_x;
         }
 
-        if (_region_y.unit == PERCENT) {
-            bbox.y0 += _region_y.computed;
+        if (_region_y.unit == SVGLength::PERCENT) {
+            minp[Y] = bbox.min()[Y] + _region_y.computed;
         } else {
-            bbox.y0 += _region_y.computed * len_y;
+            minp[Y] = bbox.min()[Y] + _region_y.computed * len_y;
         }
-        if (_region_height.unit == PERCENT) {
-            bbox.y1 = bbox.y0 + _region_height.computed;
+        if (_region_height.unit == SVGLength::PERCENT) {
+            maxp[Y] = minp[Y] + _region_height.computed;
         } else {
-            bbox.y1 = bbox.y0 + _region_height.computed * len_y;
+            maxp[Y] = minp[Y] + _region_height.computed * len_y;
         }
     } else if (_filter_units == SP_FILTER_UNITS_USERSPACEONUSE) {
         /* TODO: make sure bbox and fe region are in same coordinate system */
-        bbox.x0 = _region_x.computed;
-        bbox.x1 = bbox.x0 + _region_width.computed;
-        bbox.y0 = _region_y.computed;
-        bbox.y1 = bbox.y0 + _region_height.computed;
+        minp[X] = _region_x.computed;
+        maxp[X] = minp[X] + _region_width.computed;
+        minp[Y] = _region_y.computed;
+        maxp[Y] = minp[Y] + _region_height.computed;
     } else {
         g_warning("Error in NR::Filter::bbox_enlarge: unrecognized value of _filter_units");
     }
+    Rect area(minp, maxp);
+    return area;
 }
 
+/* Constructor table holds pointers to static methods returning filter
+ * primitives. This table is indexed with FilterPrimitiveType, so that
+ * for example method in _constructor[NR_FILTER_GAUSSIANBLUR]
+ * returns a filter object of type NR::FilterGaussian.
+ */
 typedef FilterPrimitive*(*FilterConstructor)();
 static FilterConstructor _constructor[NR_FILTER_ENDPRIMITIVETYPE];
 
 void Filter::_create_constructor_table()
 {
+    // Constructor table won't change in run-time, so no need to recreate
     static bool created = false;
     if(created) return;
 
-    /* Filter effects not yet implemented are set to NULL */
-    _constructor[NR_FILTER_BLEND] = NULL;
-    _constructor[NR_FILTER_COLORMATRIX] = NULL;
-    _constructor[NR_FILTER_COMPONENTTRANSFER] = NULL;
-    _constructor[NR_FILTER_COMPOSITE] = NULL;
-    _constructor[NR_FILTER_CONVOLVEMATRIX] = NULL;
-    _constructor[NR_FILTER_DIFFUSELIGHTING] = NULL;
-    _constructor[NR_FILTER_DISPLACEMENTMAP] = NULL;
-    _constructor[NR_FILTER_FLOOD] = NULL;
+/* Some filter classes are not implemented yet.
+   Some of them still have only boilerplate code.*/
+    _constructor[NR_FILTER_BLEND] = &FilterBlend::create;
+    _constructor[NR_FILTER_COLORMATRIX] = &FilterColorMatrix::create;
+    _constructor[NR_FILTER_COMPONENTTRANSFER] = &FilterComponentTransfer::create;
+    _constructor[NR_FILTER_COMPOSITE] = &FilterComposite::create;
+    _constructor[NR_FILTER_CONVOLVEMATRIX] = &FilterConvolveMatrix::create;
+    _constructor[NR_FILTER_DIFFUSELIGHTING] = &FilterDiffuseLighting::create;
+    _constructor[NR_FILTER_DISPLACEMENTMAP] = &FilterDisplacementMap::create;
+    _constructor[NR_FILTER_FLOOD] = &FilterFlood::create;
     _constructor[NR_FILTER_GAUSSIANBLUR] = &FilterGaussian::create;
-    _constructor[NR_FILTER_IMAGE] = NULL;
-    _constructor[NR_FILTER_MERGE] = NULL;
-    _constructor[NR_FILTER_MORPHOLOGY] = NULL;
-    _constructor[NR_FILTER_OFFSET] = NULL;
-    _constructor[NR_FILTER_SPECULARLIGHTING] = NULL;
-    _constructor[NR_FILTER_TILE] = NULL;
-    _constructor[NR_FILTER_TURBULENCE] = NULL;
+    _constructor[NR_FILTER_IMAGE] = &FilterImage::create;
+    _constructor[NR_FILTER_MERGE] = &FilterMerge::create;
+    _constructor[NR_FILTER_MORPHOLOGY] = &FilterMorphology::create;
+    _constructor[NR_FILTER_OFFSET] = &FilterOffset::create;
+    _constructor[NR_FILTER_SPECULARLIGHTING] = &FilterSpecularLighting::create;
+    _constructor[NR_FILTER_TILE] = &FilterTile::create;
+    _constructor[NR_FILTER_TURBULENCE] = &FilterTurbulence::create;
+    created = true;
 }
 
+/** Helper method for enlarging table of filter primitives. When new
+ * primitives are added, but we have no space for them, this function
+ * makes some more space.
+ */
 void Filter::_enlarge_primitive_table() {
     FilterPrimitive **new_tbl = new FilterPrimitive*[_primitive_table_size * 2];
     for (int i = 0 ; i < _primitive_count ; i++) {
@@ -189,14 +333,14 @@ void Filter::_enlarge_primitive_table() {
     _primitive = new_tbl;
 }
 
-FilterPrimitive *Filter::add_primitive(FilterPrimitiveType type)
+int Filter::add_primitive(FilterPrimitiveType type)
 {
     _create_constructor_table();
 
     // Check that we can create a new filter of specified type
     if (type < 0 || type >= NR_FILTER_ENDPRIMITIVETYPE)
-        return NULL;
-    if (!_constructor[type]) return NULL;
+        return -1;
+    if (!_constructor[type]) return -1;
     FilterPrimitive *created = _constructor[type]();
 
     // If there is no space for new filter primitive, enlarge the table
@@ -205,27 +349,24 @@ FilterPrimitive *Filter::add_primitive(FilterPrimitiveType type)
     }
 
     _primitive[_primitive_count] = created;
-    return created;
+    int handle = _primitive_count;
+    _primitive_count++;
+    return handle;
 }
 
-FilterPrimitive *Filter::replace_primitive(FilterPrimitive *target, FilterPrimitiveType type)
+int Filter::replace_primitive(int target, FilterPrimitiveType type)
 {
     _create_constructor_table();
 
     // Check that target is valid primitive inside this filter
-    int place = -1;
-    for (int i = 0 ; i < _primitive_count ; i++) {
-        if (target == _primitive[i]) {
-            place = i;
-            break;
-        }
-    }
-    if (place < 0) return NULL;
+    if (target < 0) return -1;
+    if (target >= _primitive_count) return -1;
+    if (!_primitive[target]) return -1;
 
     // Check that we can create a new filter of specified type
     if (type < 0 || type >= NR_FILTER_ENDPRIMITIVETYPE)
-        return NULL;
-    if (!_constructor[type]) return NULL;
+        return -1;
+    if (!_constructor[type]) return -1;
     FilterPrimitive *created = _constructor[type]();
 
     // If there is no space for new filter primitive, enlarge the table
@@ -233,9 +374,14 @@ FilterPrimitive *Filter::replace_primitive(FilterPrimitive *target, FilterPrimit
         _enlarge_primitive_table();
     }
 
-    delete target;
-    _primitive[place] = created;
-    return created;
+    delete _primitive[target];
+    _primitive[target] = created;
+    return target;
+}
+
+FilterPrimitive *Filter::get_primitive(int handle) {
+    if (handle < 0 || handle >= _primitive_count) return NULL;
+    return _primitive[handle];
 }
 
 void Filter::clear_primitives()
@@ -246,6 +392,46 @@ void Filter::clear_primitives()
     _primitive_count = 0;
 }
 
+void Filter::set_x(SVGLength const &length)
+{ 
+  if (length._set)
+      _region_x = length;
+}
+void Filter::set_y(SVGLength const &length)
+{
+  if (length._set)
+      _region_y = length;
+}
+void Filter::set_width(SVGLength const &length)
+{
+  if (length._set)
+      _region_width = length;
+}
+void Filter::set_height(SVGLength const &length)
+{ 
+  if (length._set)
+      _region_height = length;
+}
+
+void Filter::set_resolution(double const pixels) {
+    if (pixels > 0) {
+        _x_pixels = pixels;
+        _y_pixels = pixels;
+    }
+}
+
+void Filter::set_resolution(double const x_pixels, double const y_pixels) {
+    if (x_pixels >= 0 && y_pixels >= 0) {
+        _x_pixels = x_pixels;
+        _y_pixels = y_pixels;
+    }
+}
+
+void Filter::reset_resolution() {
+    _x_pixels = -1;
+    _y_pixels = -1;
+}
+
 } /* namespace NR */
 
 /*