d0fb611057f4907de2abe046a62ddeebac8c16c1
[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 #include "SVGFEConvolveMatrixElement.h"
22
23 #include "FilterEffect.h"
24 #include "FloatPoint.h"
25 #include "IntPoint.h"
26 #include "IntSize.h"
27 #include "SVGFilterBuilder.h"
28 #include "SVGNames.h"
29 #include "SVGNumberListValues.h"
30 #include "SVGParserUtilities.h"
31 #include <wtf/IsoMallocInlines.h>
32
33 namespace WebCore {
34
35 WTF_MAKE_ISO_ALLOCATED_IMPL(SVGFEConvolveMatrixElement);
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 Ref<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     static NeverDestroyed<AtomicString> s_identifier("SVGKernelUnitLengthX", AtomicString::ConstructFromLiteral);
83     return s_identifier;
84 }
85
86 const AtomicString& SVGFEConvolveMatrixElement::kernelUnitLengthYIdentifier()
87 {
88     static NeverDestroyed<AtomicString> s_identifier("SVGKernelUnitLengthY", AtomicString::ConstructFromLiteral);
89     return s_identifier;
90 }
91
92 const AtomicString& SVGFEConvolveMatrixElement::orderXIdentifier()
93 {
94     static NeverDestroyed<AtomicString> s_identifier("SVGOrderX", AtomicString::ConstructFromLiteral);
95     return s_identifier;
96 }
97
98 const AtomicString& SVGFEConvolveMatrixElement::orderYIdentifier()
99 {
100     static NeverDestroyed<AtomicString> s_identifier("SVGOrderY", AtomicString::ConstructFromLiteral);
101     return s_identifier;
102 }
103
104 void SVGFEConvolveMatrixElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
105 {
106     if (name == SVGNames::inAttr) {
107         setIn1BaseValue(value);
108         return;
109     }
110
111     if (name == SVGNames::orderAttr) {
112         float x, y;
113         if (parseNumberOptionalNumber(value, x, y) && x >= 1 && y >= 1) {
114             setOrderXBaseValue(x);
115             setOrderYBaseValue(y);
116         } else
117             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing order=\"" + value + "\". Filtered element will not be displayed.");
118         return;
119     }
120
121     if (name == SVGNames::edgeModeAttr) {
122         EdgeModeType propertyValue = SVGPropertyTraits<EdgeModeType>::fromString(value);
123         if (propertyValue > 0)
124             setEdgeModeBaseValue(propertyValue);
125         else
126             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing edgeMode=\"" + value + "\". Filtered element will not be displayed.");
127         return;
128     }
129
130     if (name == SVGNames::kernelMatrixAttr) {
131         SVGNumberListValues newList;
132         newList.parse(value);
133         detachAnimatedKernelMatrixListWrappers(newList.size());
134         setKernelMatrixBaseValue(newList);
135         return;
136     }
137
138     if (name == SVGNames::divisorAttr) {
139         float divisor = value.toFloat();
140         if (divisor)
141             setDivisorBaseValue(divisor);
142         else
143             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing divisor=\"" + value + "\". Filtered element will not be displayed.");
144         return;
145     }
146     
147     if (name == SVGNames::biasAttr) {
148         setBiasBaseValue(value.toFloat());
149         return;
150     }
151
152     if (name == SVGNames::targetXAttr) {
153         setTargetXBaseValue(value.string().toUIntStrict());
154         return;
155     }
156
157     if (name == SVGNames::targetYAttr) {
158         setTargetYBaseValue(value.string().toUIntStrict());
159         return;
160     }
161
162     if (name == SVGNames::kernelUnitLengthAttr) {
163         float x, y;
164         if (parseNumberOptionalNumber(value, x, y) && x > 0 && y > 0) {
165             setKernelUnitLengthXBaseValue(x);
166             setKernelUnitLengthYBaseValue(y);
167         } else
168             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing kernelUnitLength=\"" + value + "\". Filtered element will not be displayed.");
169         return;
170     }
171
172     if (name == SVGNames::preserveAlphaAttr) {
173         if (value == "true")
174             setPreserveAlphaBaseValue(true);
175         else if (value == "false")
176             setPreserveAlphaBaseValue(false);
177         else
178             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing preserveAlphaAttr=\"" + value  + "\". Filtered element will not be displayed.");
179         return;
180     }
181
182     SVGFilterPrimitiveStandardAttributes::parseAttribute(name, value);
183 }
184
185 bool SVGFEConvolveMatrixElement::setFilterEffectAttribute(FilterEffect* effect, const QualifiedName& attrName)
186 {
187     FEConvolveMatrix* convolveMatrix = static_cast<FEConvolveMatrix*>(effect);
188     if (attrName == SVGNames::edgeModeAttr)
189         return convolveMatrix->setEdgeMode(edgeMode());
190     if (attrName == SVGNames::divisorAttr)
191         return convolveMatrix->setDivisor(divisor());
192     if (attrName == SVGNames::biasAttr)
193         return convolveMatrix->setBias(bias());
194     if (attrName == SVGNames::targetXAttr)
195        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
196     if (attrName == SVGNames::targetYAttr)
197        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
198     if (attrName == SVGNames::kernelUnitLengthAttr)
199        return convolveMatrix->setKernelUnitLength(FloatPoint(kernelUnitLengthX(), kernelUnitLengthY()));
200     if (attrName == SVGNames::preserveAlphaAttr)
201         return convolveMatrix->setPreserveAlpha(preserveAlpha());
202
203     ASSERT_NOT_REACHED();
204     return false;
205 }
206
207 void SVGFEConvolveMatrixElement::setOrder(float x, float y)
208 {
209     setOrderXBaseValue(x);
210     setOrderYBaseValue(y);
211     invalidate();
212 }
213
214 void SVGFEConvolveMatrixElement::setKernelUnitLength(float x, float y)
215 {
216     setKernelUnitLengthXBaseValue(x);
217     setKernelUnitLengthYBaseValue(y);
218     invalidate();
219 }
220
221 void SVGFEConvolveMatrixElement::svgAttributeChanged(const QualifiedName& attrName)
222 {
223     if (attrName == SVGNames::edgeModeAttr || attrName == SVGNames::divisorAttr || attrName == SVGNames::biasAttr || attrName == SVGNames::targetXAttr || attrName == SVGNames::targetYAttr || attrName == SVGNames::kernelUnitLengthAttr || attrName == SVGNames::preserveAlphaAttr) {
224         InstanceInvalidationGuard guard(*this);
225         primitiveAttributeChanged(attrName);
226         return;
227     }
228
229     if (attrName == SVGNames::inAttr || attrName == SVGNames::orderAttr || attrName == SVGNames::kernelMatrixAttr) {
230         InstanceInvalidationGuard guard(*this);
231         invalidate();
232         return;
233     }
234
235     SVGFilterPrimitiveStandardAttributes::svgAttributeChanged(attrName);
236 }
237
238 RefPtr<FilterEffect> SVGFEConvolveMatrixElement::build(SVGFilterBuilder* filterBuilder, Filter& filter)
239 {
240     auto input1 = filterBuilder->getEffectById(in1());
241
242     if (!input1)
243         return nullptr;
244
245     int orderXValue = orderX();
246     int orderYValue = orderY();
247     if (!hasAttribute(SVGNames::orderAttr)) {
248         orderXValue = 3;
249         orderYValue = 3;
250     }
251     // Spec says order must be > 0. Bail if it is not.
252     if (orderXValue < 1 || orderYValue < 1)
253         return nullptr;
254     auto& kernelMatrix = this->kernelMatrix();
255     int kernelMatrixSize = kernelMatrix.size();
256     // The spec says this is a requirement, and should bail out if fails
257     if (orderXValue * orderYValue != kernelMatrixSize)
258         return nullptr;
259
260     int targetXValue = targetX();
261     int targetYValue = targetY();
262     if (hasAttribute(SVGNames::targetXAttr) && (targetXValue < 0 || targetXValue >= orderXValue))
263         return nullptr;
264     // The spec says the default value is: targetX = floor ( orderX / 2 ))
265     if (!hasAttribute(SVGNames::targetXAttr))
266         targetXValue = static_cast<int>(floorf(orderXValue / 2));
267     if (hasAttribute(SVGNames::targetYAttr) && (targetYValue < 0 || targetYValue >= orderYValue))
268         return nullptr;
269     // The spec says the default value is: targetY = floor ( orderY / 2 ))
270     if (!hasAttribute(SVGNames::targetYAttr))
271         targetYValue = static_cast<int>(floorf(orderYValue / 2));
272
273     // Spec says default kernelUnitLength is 1.0, and a specified length cannot be 0.
274     int kernelUnitLengthXValue = kernelUnitLengthX();
275     int kernelUnitLengthYValue = kernelUnitLengthY();
276     if (!hasAttribute(SVGNames::kernelUnitLengthAttr)) {
277         kernelUnitLengthXValue = 1;
278         kernelUnitLengthYValue = 1;
279     }
280     if (kernelUnitLengthXValue <= 0 || kernelUnitLengthYValue <= 0)
281         return nullptr;
282
283     float divisorValue = divisor();
284     if (hasAttribute(SVGNames::divisorAttr) && !divisorValue)
285         return nullptr;
286     if (!hasAttribute(SVGNames::divisorAttr)) {
287         for (int i = 0; i < kernelMatrixSize; ++i)
288             divisorValue += kernelMatrix.at(i);
289         if (!divisorValue)
290             divisorValue = 1;
291     }
292
293     auto effect = FEConvolveMatrix::create(filter, IntSize(orderXValue, orderYValue), divisorValue, bias(), IntPoint(targetXValue, targetYValue), edgeMode(), FloatPoint(kernelUnitLengthXValue, kernelUnitLengthYValue), preserveAlpha(), kernelMatrix);
294     effect->inputEffects().append(input1);
295     return WTFMove(effect);
296 }
297
298 } // namespace WebCore