Element's renderer factory should return RenderPtrs.
[WebKit-https.git] / Source / WebCore / svg / SVGFEConvolveMatrixElement.cpp
1 /*
2  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21
22 #if ENABLE(SVG) && ENABLE(FILTERS)
23 #include "SVGFEConvolveMatrixElement.h"
24
25 #include "Attr.h"
26 #include "FilterEffect.h"
27 #include "FloatPoint.h"
28 #include "IntPoint.h"
29 #include "IntSize.h"
30 #include "SVGElementInstance.h"
31 #include "SVGFilterBuilder.h"
32 #include "SVGNames.h"
33 #include "SVGParserUtilities.h"
34
35 namespace WebCore {
36
37 // Animated property definitions
38 DEFINE_ANIMATED_STRING(SVGFEConvolveMatrixElement, SVGNames::inAttr, In1, in1)
39 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::orderAttr, orderXIdentifier(), OrderX, orderX)
40 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::orderAttr, orderYIdentifier(), OrderY, orderY) 
41 DEFINE_ANIMATED_NUMBER_LIST(SVGFEConvolveMatrixElement, SVGNames::kernelMatrixAttr, KernelMatrix, kernelMatrix)
42 DEFINE_ANIMATED_NUMBER(SVGFEConvolveMatrixElement, SVGNames::divisorAttr, Divisor, divisor)
43 DEFINE_ANIMATED_NUMBER(SVGFEConvolveMatrixElement, SVGNames::biasAttr, Bias, bias)
44 DEFINE_ANIMATED_INTEGER(SVGFEConvolveMatrixElement, SVGNames::targetXAttr, TargetX, targetX)
45 DEFINE_ANIMATED_INTEGER(SVGFEConvolveMatrixElement, SVGNames::targetYAttr, TargetY, targetY)
46 DEFINE_ANIMATED_ENUMERATION(SVGFEConvolveMatrixElement, SVGNames::edgeModeAttr, EdgeMode, edgeMode, EdgeModeType)
47 DEFINE_ANIMATED_NUMBER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::kernelUnitLengthAttr, kernelUnitLengthXIdentifier(), KernelUnitLengthX, kernelUnitLengthX)
48 DEFINE_ANIMATED_NUMBER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::kernelUnitLengthAttr, kernelUnitLengthYIdentifier(), KernelUnitLengthY, kernelUnitLengthY)
49 DEFINE_ANIMATED_BOOLEAN(SVGFEConvolveMatrixElement, SVGNames::preserveAlphaAttr, PreserveAlpha, preserveAlpha)
50
51 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGFEConvolveMatrixElement)
52     REGISTER_LOCAL_ANIMATED_PROPERTY(in1)
53     REGISTER_LOCAL_ANIMATED_PROPERTY(orderX)
54     REGISTER_LOCAL_ANIMATED_PROPERTY(orderY)
55     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelMatrix)
56     REGISTER_LOCAL_ANIMATED_PROPERTY(divisor)
57     REGISTER_LOCAL_ANIMATED_PROPERTY(bias)
58     REGISTER_LOCAL_ANIMATED_PROPERTY(targetX)
59     REGISTER_LOCAL_ANIMATED_PROPERTY(targetY)
60     REGISTER_LOCAL_ANIMATED_PROPERTY(edgeMode)
61     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelUnitLengthX)
62     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelUnitLengthY)
63     REGISTER_LOCAL_ANIMATED_PROPERTY(preserveAlpha)
64     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGFilterPrimitiveStandardAttributes)
65 END_REGISTER_ANIMATED_PROPERTIES
66
67 inline SVGFEConvolveMatrixElement::SVGFEConvolveMatrixElement(const QualifiedName& tagName, Document& document)
68     : SVGFilterPrimitiveStandardAttributes(tagName, document)
69     , m_edgeMode(EDGEMODE_DUPLICATE)
70 {
71     ASSERT(hasTagName(SVGNames::feConvolveMatrixTag));
72     registerAnimatedPropertiesForSVGFEConvolveMatrixElement();
73 }
74
75 PassRefPtr<SVGFEConvolveMatrixElement> SVGFEConvolveMatrixElement::create(const QualifiedName& tagName, Document& document)
76 {
77     return adoptRef(new SVGFEConvolveMatrixElement(tagName, document));
78 }
79
80 const AtomicString& SVGFEConvolveMatrixElement::kernelUnitLengthXIdentifier()
81 {
82     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGKernelUnitLengthX", AtomicString::ConstructFromLiteral));
83     return s_identifier;
84 }
85
86 const AtomicString& SVGFEConvolveMatrixElement::kernelUnitLengthYIdentifier()
87 {
88     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGKernelUnitLengthY", AtomicString::ConstructFromLiteral));
89     return s_identifier;
90 }
91
92 const AtomicString& SVGFEConvolveMatrixElement::orderXIdentifier()
93 {
94     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGOrderX", AtomicString::ConstructFromLiteral));
95     return s_identifier;
96 }
97
98 const AtomicString& SVGFEConvolveMatrixElement::orderYIdentifier()
99 {
100     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGOrderY", AtomicString::ConstructFromLiteral));
101     return s_identifier;
102 }
103
104 bool SVGFEConvolveMatrixElement::isSupportedAttribute(const QualifiedName& attrName)
105 {
106     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
107     if (supportedAttributes.isEmpty()) {
108         supportedAttributes.add(SVGNames::inAttr);
109         supportedAttributes.add(SVGNames::orderAttr);
110         supportedAttributes.add(SVGNames::kernelMatrixAttr);
111         supportedAttributes.add(SVGNames::edgeModeAttr);
112         supportedAttributes.add(SVGNames::divisorAttr);
113         supportedAttributes.add(SVGNames::biasAttr);
114         supportedAttributes.add(SVGNames::targetXAttr);
115         supportedAttributes.add(SVGNames::targetYAttr);
116         supportedAttributes.add(SVGNames::kernelUnitLengthAttr);
117         supportedAttributes.add(SVGNames::preserveAlphaAttr);
118     }
119     return supportedAttributes.contains<SVGAttributeHashTranslator>(attrName);
120 }
121
122 void SVGFEConvolveMatrixElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
123 {
124     if (!isSupportedAttribute(name)) {
125         SVGFilterPrimitiveStandardAttributes::parseAttribute(name, value);
126         return;
127     }
128
129     if (name == SVGNames::inAttr) {
130         setIn1BaseValue(value);
131         return;
132     }
133
134     if (name == SVGNames::orderAttr) {
135         float x, y;
136         if (parseNumberOptionalNumber(value, x, y) && x >= 1 && y >= 1) {
137             setOrderXBaseValue(x);
138             setOrderYBaseValue(y);
139         } else
140             document().accessSVGExtensions()->reportWarning(
141                 "feConvolveMatrix: problem parsing order=\"" + value
142                 + "\". Filtered element will not be displayed.");
143         return;
144     }
145
146     if (name == SVGNames::edgeModeAttr) {
147         EdgeModeType propertyValue = SVGPropertyTraits<EdgeModeType>::fromString(value);
148         if (propertyValue > 0)
149             setEdgeModeBaseValue(propertyValue);
150         else
151             document().accessSVGExtensions()->reportWarning(
152                 "feConvolveMatrix: problem parsing edgeMode=\"" + value
153                 + "\". Filtered element will not be displayed.");
154         return;
155     }
156
157     if (name == SVGNames::kernelMatrixAttr) {
158         SVGNumberList newList;
159         newList.parse(value);
160         detachAnimatedKernelMatrixListWrappers(newList.size());
161         setKernelMatrixBaseValue(newList);
162         return;
163     }
164
165     if (name == SVGNames::divisorAttr) {
166         float divisor = value.toFloat();
167         if (divisor)
168             setDivisorBaseValue(divisor);
169         else
170             document().accessSVGExtensions()->reportWarning(
171                 "feConvolveMatrix: problem parsing divisor=\"" + value
172                 + "\". Filtered element will not be displayed.");
173         return;
174     }
175     
176     if (name == SVGNames::biasAttr) {
177         setBiasBaseValue(value.toFloat());
178         return;
179     }
180
181     if (name == SVGNames::targetXAttr) {
182         setTargetXBaseValue(value.string().toUIntStrict());
183         return;
184     }
185
186     if (name == SVGNames::targetYAttr) {
187         setTargetYBaseValue(value.string().toUIntStrict());
188         return;
189     }
190
191     if (name == SVGNames::kernelUnitLengthAttr) {
192         float x, y;
193         if (parseNumberOptionalNumber(value, x, y) && x > 0 && y > 0) {
194             setKernelUnitLengthXBaseValue(x);
195             setKernelUnitLengthYBaseValue(y);
196         } else
197             document().accessSVGExtensions()->reportWarning(
198                 "feConvolveMatrix: problem parsing kernelUnitLength=\"" + value
199                 + "\". Filtered element will not be displayed.");
200         return;
201     }
202
203     if (name == SVGNames::preserveAlphaAttr) {
204         if (value == "true")
205             setPreserveAlphaBaseValue(true);
206         else if (value == "false")
207             setPreserveAlphaBaseValue(false);
208         else
209             document().accessSVGExtensions()->reportWarning(
210                 "feConvolveMatrix: problem parsing preserveAlphaAttr=\"" + value
211                 + "\". Filtered element will not be displayed.");
212         return;
213     }
214
215     ASSERT_NOT_REACHED();
216 }
217
218 bool SVGFEConvolveMatrixElement::setFilterEffectAttribute(FilterEffect* effect, const QualifiedName& attrName)
219 {
220     FEConvolveMatrix* convolveMatrix = static_cast<FEConvolveMatrix*>(effect);
221     if (attrName == SVGNames::edgeModeAttr)
222         return convolveMatrix->setEdgeMode(edgeMode());
223     if (attrName == SVGNames::divisorAttr)
224         return convolveMatrix->setDivisor(divisor());
225     if (attrName == SVGNames::biasAttr)
226         return convolveMatrix->setBias(bias());
227     if (attrName == SVGNames::targetXAttr)
228        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
229     if (attrName == SVGNames::targetYAttr)
230        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
231     if (attrName == SVGNames::kernelUnitLengthAttr)
232        return convolveMatrix->setKernelUnitLength(FloatPoint(kernelUnitLengthX(), kernelUnitLengthY()));
233     if (attrName == SVGNames::preserveAlphaAttr)
234         return convolveMatrix->setPreserveAlpha(preserveAlpha());
235
236     ASSERT_NOT_REACHED();
237     return false;
238 }
239
240 void SVGFEConvolveMatrixElement::setOrder(float x, float y)
241 {
242     setOrderXBaseValue(x);
243     setOrderYBaseValue(y);
244     invalidate();
245 }
246
247 void SVGFEConvolveMatrixElement::setKernelUnitLength(float x, float y)
248 {
249     setKernelUnitLengthXBaseValue(x);
250     setKernelUnitLengthYBaseValue(y);
251     invalidate();
252 }
253
254 void SVGFEConvolveMatrixElement::svgAttributeChanged(const QualifiedName& attrName)
255 {
256     if (!isSupportedAttribute(attrName)) {
257         SVGFilterPrimitiveStandardAttributes::svgAttributeChanged(attrName);
258         return;
259     }
260
261     SVGElementInstance::InvalidationGuard invalidationGuard(this);
262
263     if (attrName == SVGNames::edgeModeAttr
264         || attrName == SVGNames::divisorAttr
265         || attrName == SVGNames::biasAttr
266         || attrName == SVGNames::targetXAttr
267         || attrName == SVGNames::targetYAttr
268         || attrName == SVGNames::kernelUnitLengthAttr
269         || attrName == SVGNames::preserveAlphaAttr) {
270         primitiveAttributeChanged(attrName);
271         return;
272     }
273
274     if (attrName == SVGNames::inAttr
275         || attrName == SVGNames::orderAttr
276         || attrName == SVGNames::kernelMatrixAttr) {
277         invalidate();
278         return;
279     }
280
281     ASSERT_NOT_REACHED();
282 }
283
284 PassRefPtr<FilterEffect> SVGFEConvolveMatrixElement::build(SVGFilterBuilder* filterBuilder, Filter* filter)
285 {
286     FilterEffect* input1 = filterBuilder->getEffectById(in1());
287
288     if (!input1)
289         return 0;
290
291     int orderXValue = orderX();
292     int orderYValue = orderY();
293     if (!hasAttribute(SVGNames::orderAttr)) {
294         orderXValue = 3;
295         orderYValue = 3;
296     }
297     // Spec says order must be > 0. Bail if it is not.
298     if (orderXValue < 1 || orderYValue < 1)
299         return 0;
300     SVGNumberList& kernelMatrix = this->kernelMatrix();
301     int kernelMatrixSize = kernelMatrix.size();
302     // The spec says this is a requirement, and should bail out if fails
303     if (orderXValue * orderYValue != kernelMatrixSize)
304         return 0;
305
306     int targetXValue = targetX();
307     int targetYValue = targetY();
308     if (hasAttribute(SVGNames::targetXAttr) && (targetXValue < 0 || targetXValue >= orderXValue))
309         return 0;
310     // The spec says the default value is: targetX = floor ( orderX / 2 ))
311     if (!hasAttribute(SVGNames::targetXAttr))
312         targetXValue = static_cast<int>(floorf(orderXValue / 2));
313     if (hasAttribute(SVGNames::targetYAttr) && (targetYValue < 0 || targetYValue >= orderYValue))
314         return 0;
315     // The spec says the default value is: targetY = floor ( orderY / 2 ))
316     if (!hasAttribute(SVGNames::targetYAttr))
317         targetYValue = static_cast<int>(floorf(orderYValue / 2));
318
319     // Spec says default kernelUnitLength is 1.0, and a specified length cannot be 0.
320     int kernelUnitLengthXValue = kernelUnitLengthX();
321     int kernelUnitLengthYValue = kernelUnitLengthY();
322     if (!hasAttribute(SVGNames::kernelUnitLengthAttr)) {
323         kernelUnitLengthXValue = 1;
324         kernelUnitLengthYValue = 1;
325     }
326     if (kernelUnitLengthXValue <= 0 || kernelUnitLengthYValue <= 0)
327         return 0;
328
329     float divisorValue = divisor();
330     if (hasAttribute(SVGNames::divisorAttr) && !divisorValue)
331         return 0;
332     if (!hasAttribute(SVGNames::divisorAttr)) {
333         for (int i = 0; i < kernelMatrixSize; ++i)
334             divisorValue += kernelMatrix.at(i);
335         if (!divisorValue)
336             divisorValue = 1;
337     }
338
339     RefPtr<FilterEffect> effect = FEConvolveMatrix::create(filter,
340                     IntSize(orderXValue, orderYValue), divisorValue,
341                     bias(), IntPoint(targetXValue, targetYValue), edgeMode(),
342                     FloatPoint(kernelUnitLengthXValue, kernelUnitLengthYValue), preserveAlpha(), kernelMatrix);
343     effect->inputEffects().append(input1);
344     return effect.release();
345 }
346
347 } // namespace WebCore
348
349 #endif // ENABLE(SVG)