nr-filter.cpp revision 7c89b734639fa72a5d2ffdc9cf1f7ab22eff67f1
#define __NR_FILTER_CPP__
/*
* SVG filters rendering
*
* Author:
* Niko Kiirala <niko@kiirala.com>
*
* Copyright (C) 2006-2008 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-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.h"
#include "display/nr-arena-item.h"
#include "libnr/nr-pixblock.h"
#include "libnr/nr-blit.h"
#include <2geom/affine.h>
#include <2geom/rect.h>
#include "svg/svg-length.h"
#include "sp-filter-units.h"
#include "preferences.h"
#if defined (SOLARIS) && (SOLARIS == 8)
#include "round.h"
using Inkscape::round;
#endif
namespace Inkscape {
namespace Filters {
using Geom::X;
using Geom::Y;
static Geom::OptRect get_item_bbox(NRArenaItem const *item) {
Geom::Rect item_bbox;
if (item->item_bbox) {
item_bbox = *(item->item_bbox);
} else {
// Bounding box might not exist, so create a dummy one.
Geom::Point zero(0, 0);
item_bbox = Geom::Rect(zero, zero);
}
if (item_bbox.min()[X] > item_bbox.max()[X]
|| item_bbox.min()[Y] > item_bbox.max()[Y])
{
// In case of negative-size bbox, return an empty OptRect
return Geom::OptRect();
}
return Geom::OptRect(item_bbox);
}
Filter::Filter()
{
_primitive_count = 0;
_primitive_table_size = 1;
_primitive = new FilterPrimitive*[1];
_primitive[0] = NULL;
//_primitive_count = 1;
//_primitive[0] = new FilterGaussian;
_common_init();
}
Filter::Filter(int n)
{
_primitive_count = 0;
_primitive_table_size = (n > 0) ? n : 1; // we guarantee there is at least 1(one) filter slot
_primitive = new FilterPrimitive*[_primitive_table_size];
for ( int i = 0 ; i < _primitive_table_size ; i++ ) {
_primitive[i] = NULL;
}
_common_init();
}
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;
_filter_units = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
_primitive_units = SP_FILTER_UNITS_USERSPACEONUSE;
}
Filter::~Filter()
{
clear_primitives();
delete[] _primitive;
}
int Filter::render(NRArenaItem const *item, NRPixBlock *pb)
{
if (!_primitive[0]) {
// TODO: Should clear the input buffer instead of just returning
return 1;
}
FilterQuality const filterquality = (FilterQuality)item->arena->filterquality;
int const blurquality = item->arena->blurquality;
Geom::Affine trans = item->ctm;
FilterSlot slot(_slot_count, item);
slot.set_quality(filterquality);
slot.set_blurquality(blurquality);
Geom::Rect item_bbox;
{
Geom::OptRect maybe_bbox = get_item_bbox(item);
if (maybe_bbox.isEmpty()) {
// Code below needs a bounding box
return 1;
}
item_bbox = *maybe_bbox;
}
Geom::Rect filter_area = filter_effect_area(item_bbox);
if (item_bbox.hasZeroArea()) {
// 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
std::pair<double,double> resolution
= _filter_resolution(filter_area, trans, filterquality);
if(!(resolution.first > 0 && resolution.second > 0))
return 1;
units.set_resolution(resolution.first, resolution.second);
if (_x_pixels > 0) {
units.set_automatic_resolution(false);
}
else {
units.set_automatic_resolution(true);
}
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,
pb->area.x1, pb->area.y1, true);
if (in->size != NR_PIXBLOCK_SIZE_TINY && in->data.px == NULL) {
g_warning("Inkscape::Filters::Filter::render: failed to reserve temporary buffer");
return 0;
}
nr_blit_pixblock_pixblock(in, pb);
in->empty = FALSE;
slot.set(NR_FILTER_SOURCEGRAPHIC, in);
// 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("Inkscape::Filters::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
for (int i = 0 ; i < _primitive_count ; i++) {
_primitive[i]->render(slot, units);
}
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;
}
void Filter::set_filter_units(SPFilterUnits unit) {
_filter_units = unit;
}
void Filter::set_primitive_units(SPFilterUnits unit) {
_primitive_units = unit;
}
void Filter::area_enlarge(NRRectL &bbox, NRArenaItem const *item) const {
for (int i = 0 ; i < _primitive_count ; i++) {
if (_primitive[i]) _primitive[i]->area_enlarge(bbox, item->ctm);
}
/*
TODO: something. See images at the bottom of filters.svg with medium-low
filtering quality.
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
FilterQuality const filterquality = (FilterQuality)prefs->getInt("/options/filterquality/value");
if (_x_pixels <= 0 && (filterquality == FILTER_QUALITY_BEST ||
filterquality == FILTER_QUALITY_BETTER)) {
return;
}
Geom::Rect item_bbox;
Geom::OptRect maybe_bbox = get_item_bbox(item);
if (maybe_bbox.isEmpty()) {
// Code below needs a bounding box
return;
}
item_bbox = *maybe_bbox;
std::pair<double,double> res_low
= _filter_resolution(item_bbox, item->ctm, filterquality);
//std::pair<double,double> res_full
// = _filter_resolution(item_bbox, item->ctm, FILTER_QUALITY_BEST);
double pixels_per_block = fmax(item_bbox.width() / res_low.first,
item_bbox.height() / res_low.second);
bbox.x0 -= (int)pixels_per_block;
bbox.x1 += (int)pixels_per_block;
bbox.y0 -= (int)pixels_per_block;
bbox.y1 += (int)pixels_per_block;
*/
}
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. */
Geom::Point min(bbox.x0, bbox.y0);
Geom::Point max(bbox.x1, bbox.y1);
Geom::Rect tmp_bbox(min, max);
Geom::Rect enlarged = filter_effect_area(tmp_bbox);
bbox.x0 = (NR::ICoord)enlarged.min()[X];
bbox.y0 = (NR::ICoord)enlarged.min()[Y];
bbox.x1 = (NR::ICoord)enlarged.max()[X];
bbox.y1 = (NR::ICoord)enlarged.max()[Y];
}
Geom::Rect Filter::filter_effect_area(Geom::Rect const &bbox)
{
Geom::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_OBJECTBOUNDINGBOX) {
if (_region_x.unit == SVGLength::PERCENT) {
minp[X] = bbox.min()[X] + _region_x.computed;
} else {
minp[X] = bbox.min()[X] + _region_x.computed * len_x;
}
if (_region_width.unit == SVGLength::PERCENT) {
maxp[X] = minp[X] + _region_width.computed;
} else {
maxp[X] = minp[X] + _region_width.computed * len_x;
}
if (_region_y.unit == SVGLength::PERCENT) {
minp[Y] = bbox.min()[Y] + _region_y.computed;
} else {
minp[Y] = bbox.min()[Y] + _region_y.computed * len_y;
}
if (_region_height.unit == SVGLength::PERCENT) {
maxp[Y] = minp[Y] + _region_height.computed;
} else {
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 */
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 Inkscape::Filters::Filter::filter_effect_area: unrecognized value of _filter_units");
}
Geom::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 Inkscape::Filters::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;
/* 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] = &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++) {
new_tbl[i] = _primitive[i];
}
_primitive_table_size *= 2;
for (int i = _primitive_count ; i < _primitive_table_size ; i++) {
new_tbl[i] = NULL;
}
if(_primitive != NULL) {
delete[] _primitive;
} else {
g_warning("oh oh");
}
_primitive = new_tbl;
}
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 -1;
if (!_constructor[type]) return -1;
FilterPrimitive *created = _constructor[type]();
// If there is no space for new filter primitive, enlarge the table
if (_primitive_count >= _primitive_table_size) {
_enlarge_primitive_table();
}
_primitive[_primitive_count] = created;
int handle = _primitive_count;
_primitive_count++;
return handle;
}
int Filter::replace_primitive(int target, FilterPrimitiveType type)
{
_create_constructor_table();
// Check that target is valid primitive inside this filter
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 -1;
if (!_constructor[type]) return -1;
FilterPrimitive *created = _constructor[type]();
// If there is no space for new filter primitive, enlarge the table
if (_primitive_count >= _primitive_table_size) {
_enlarge_primitive_table();
}
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()
{
for (int i = 0 ; i < _primitive_count ; i++) {
if (_primitive[i]) delete _primitive[i];
}
_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;
}
int Filter::_resolution_limit(FilterQuality const quality) const {
int limit = -1;
switch (quality) {
case FILTER_QUALITY_WORST:
limit = 32;
break;
case FILTER_QUALITY_WORSE:
limit = 64;
break;
case FILTER_QUALITY_NORMAL:
limit = 256;
break;
case FILTER_QUALITY_BETTER:
case FILTER_QUALITY_BEST:
default:
break;
}
return limit;
}
std::pair<double,double> Filter::_filter_resolution(
Geom::Rect const &area, Geom::Affine const &trans,
FilterQuality const filterquality) const
{
std::pair<double,double> resolution;
if (_x_pixels > 0) {
double y_len;
if (_y_pixels > 0) {
y_len = _y_pixels;
} else {
y_len = (_x_pixels * (area.max()[Y] - area.min()[Y]))
/ (area.max()[X] - area.min()[X]);
}
resolution.first = _x_pixels;
resolution.second = y_len;
} else {
Geom::Point origo = area.min();
origo *= trans;
Geom::Point max_i(area.max()[X], area.min()[Y]);
max_i *= trans;
Geom::Point max_j(area.min()[X], 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]));
int limit = _resolution_limit(filterquality);
if (limit > 0 && (i_len > limit || j_len > limit)) {
double aspect_ratio = i_len / j_len;
if (i_len > j_len) {
i_len = limit;
j_len = i_len / aspect_ratio;
}
else {
j_len = limit;
i_len = j_len * aspect_ratio;
}
}
resolution.first = i_len;
resolution.second = j_len;
}
return resolution;
}
} /* namespace Filters */
} /* namespace Inkscape */
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :