Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGResourceFilter.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005 Rob Buis <buis@kde.org>
4  * Copyright (C) 2005 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
6  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "RenderSVGResourceFilter.h"
26
27 #include "ElementChildIterator.h"
28 #include "FilterEffect.h"
29 #include "FloatPoint.h"
30 #include "Frame.h"
31 #include "GraphicsContext.h"
32 #include "Image.h"
33 #include "ImageData.h"
34 #include "IntRect.h"
35 #include "Page.h"
36 #include "RenderSVGResourceFilterPrimitive.h"
37 #include "RenderView.h"
38 #include "SVGFilterPrimitiveStandardAttributes.h"
39 #include "SVGNames.h"
40 #include "SVGRenderingContext.h"
41 #include "Settings.h"
42 #include "SourceGraphic.h"
43
44 namespace WebCore {
45
46 RenderSVGResourceFilter::RenderSVGResourceFilter(SVGFilterElement& element, Ref<RenderStyle>&& style)
47     : RenderSVGResourceContainer(element, WTFMove(style))
48 {
49 }
50
51 RenderSVGResourceFilter::~RenderSVGResourceFilter()
52 {
53 }
54
55 void RenderSVGResourceFilter::removeAllClientsFromCache(bool markForInvalidation)
56 {
57     m_filter.clear();
58
59     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
60 }
61
62 void RenderSVGResourceFilter::removeClientFromCache(RenderElement& client, bool markForInvalidation)
63 {
64     if (FilterData* filterData = m_filter.get(&client)) {
65         if (filterData->savedContext)
66             filterData->state = FilterData::MarkedForRemoval;
67         else
68             m_filter.remove(&client);
69     }
70
71     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
72 }
73
74 std::unique_ptr<SVGFilterBuilder> RenderSVGResourceFilter::buildPrimitives(SVGFilter& filter) const
75 {
76     static const unsigned maxCountChildNodes = 200;
77     if (filterElement().countChildNodes() > maxCountChildNodes)
78         return nullptr;
79
80     FloatRect targetBoundingBox = filter.targetBoundingBox();
81
82     // Add effects to the builder
83     auto builder = std::make_unique<SVGFilterBuilder>(SourceGraphic::create(filter));
84     for (auto& element : childrenOfType<SVGFilterPrimitiveStandardAttributes>(filterElement())) {
85         RefPtr<FilterEffect> effect = element.build(builder.get(), filter);
86         if (!effect) {
87             builder->clearEffects();
88             return nullptr;
89         }
90         builder->appendEffectToEffectReferences(effect.copyRef(), element.renderer());
91         element.setStandardAttributes(effect.get());
92         effect->setEffectBoundaries(SVGLengthContext::resolveRectangle<SVGFilterPrimitiveStandardAttributes>(&element, filterElement().primitiveUnits(), targetBoundingBox));
93         if (element.renderer())
94             effect->setOperatingColorSpace(element.renderer()->style().svgStyle().colorInterpolationFilters() == CI_LINEARRGB ? ColorSpaceLinearRGB : ColorSpaceSRGB);
95         builder->add(element.result(), WTFMove(effect));
96     }
97     return builder;
98 }
99
100 bool RenderSVGResourceFilter::applyResource(RenderElement& renderer, const RenderStyle&, GraphicsContext*& context, unsigned short resourceMode)
101 {
102     ASSERT(context);
103     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
104
105     if (m_filter.contains(&renderer)) {
106         FilterData* filterData = m_filter.get(&renderer);
107         if (filterData->state == FilterData::PaintingSource || filterData->state == FilterData::Applying)
108             filterData->state = FilterData::CycleDetected;
109         return false; // Already built, or we're in a cycle, or we're marked for removal. Regardless, just do nothing more now.
110     }
111
112     auto filterData = std::make_unique<FilterData>();
113     FloatRect targetBoundingBox = renderer.objectBoundingBox();
114
115     filterData->boundaries = SVGLengthContext::resolveRectangle<SVGFilterElement>(&filterElement(), filterElement().filterUnits(), targetBoundingBox);
116     if (filterData->boundaries.isEmpty())
117         return false;
118
119     // Determine absolute transformation matrix for filter. 
120     AffineTransform absoluteTransform = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(renderer);
121     if (!absoluteTransform.isInvertible())
122         return false;
123
124     // Eliminate shear of the absolute transformation matrix, to be able to produce unsheared tile images for feTile.
125     filterData->shearFreeAbsoluteTransform = AffineTransform(absoluteTransform.xScale(), 0, 0, absoluteTransform.yScale(), 0, 0);
126
127     // Determine absolute boundaries of the filter and the drawing region.
128     FloatRect absoluteFilterBoundaries = filterData->shearFreeAbsoluteTransform.mapRect(filterData->boundaries);
129     filterData->drawingRegion = renderer.strokeBoundingBox();
130     filterData->drawingRegion.intersect(filterData->boundaries);
131     FloatRect absoluteDrawingRegion = filterData->shearFreeAbsoluteTransform.mapRect(filterData->drawingRegion);
132
133     // Create the SVGFilter object.
134     bool primitiveBoundingBoxMode = filterElement().primitiveUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX;
135     filterData->filter = SVGFilter::create(filterData->shearFreeAbsoluteTransform, absoluteDrawingRegion, targetBoundingBox, filterData->boundaries, primitiveBoundingBoxMode);
136
137     // Create all relevant filter primitives.
138     filterData->builder = buildPrimitives(*filterData->filter);
139     if (!filterData->builder)
140         return false;
141
142     // Calculate the scale factor for the use of filterRes.
143     // Also see http://www.w3.org/TR/SVG/filters.html#FilterEffectsRegion
144     FloatSize scale(1, 1);
145     if (filterElement().hasAttribute(SVGNames::filterResAttr)) {
146         scale.setWidth(filterElement().filterResX() / absoluteFilterBoundaries.width());
147         scale.setHeight(filterElement().filterResY() / absoluteFilterBoundaries.height());
148     }
149
150     if (scale.isEmpty())
151         return false;
152
153     // Determine scale factor for filter. The size of intermediate ImageBuffers shouldn't be bigger than kMaxFilterSize.
154     FloatRect tempSourceRect = absoluteDrawingRegion;
155     ImageBuffer::sizeNeedsClamping(tempSourceRect.size(), scale);
156     tempSourceRect.scale(scale.width(), scale.height());
157
158     // Set the scale level in SVGFilter.
159     filterData->filter->setFilterResolution(scale);
160
161     static const unsigned maxTotalOfEffectInputs = 100;
162     FilterEffect* lastEffect = filterData->builder->lastEffect();
163     if (!lastEffect || lastEffect->totalNumberOfEffectInputs() > maxTotalOfEffectInputs)
164         return false;
165
166     RenderSVGResourceFilterPrimitive::determineFilterPrimitiveSubregion(*lastEffect);
167     FloatRect subRegion = lastEffect->maxEffectRect();
168     // At least one FilterEffect has a too big image size,
169     // recalculate the effect sizes with new scale factors.
170     if (ImageBuffer::sizeNeedsClamping(subRegion.size(), scale)) {
171         filterData->filter->setFilterResolution(scale);
172         RenderSVGResourceFilterPrimitive::determineFilterPrimitiveSubregion(*lastEffect);
173     }
174
175     // If the drawingRegion is empty, we have something like <g filter=".."/>.
176     // Even if the target objectBoundingBox() is empty, we still have to draw the last effect result image in postApplyResource.
177     if (filterData->drawingRegion.isEmpty()) {
178         ASSERT(!m_filter.contains(&renderer));
179         filterData->savedContext = context;
180         m_filter.set(&renderer, WTFMove(filterData));
181         return false;
182     }
183
184     // Change the coordinate transformation applied to the filtered element to reflect the resolution of the filter.
185     AffineTransform effectiveTransform;
186     effectiveTransform.scale(scale.width(), scale.height());
187     effectiveTransform.multiply(filterData->shearFreeAbsoluteTransform);
188
189     RenderingMode renderingMode = renderer.frame().settings().acceleratedFiltersEnabled() ? Accelerated : Unaccelerated;
190
191     auto sourceGraphic = SVGRenderingContext::createImageBuffer(filterData->drawingRegion, effectiveTransform, ColorSpaceLinearRGB, renderingMode);
192     if (!sourceGraphic) {
193         ASSERT(!m_filter.contains(&renderer));
194         filterData->savedContext = context;
195         m_filter.set(&renderer, WTFMove(filterData));
196         return false;
197     }
198     
199     // Set the rendering mode from the page's settings.
200     filterData->filter->setRenderingMode(renderingMode);
201
202     GraphicsContext& sourceGraphicContext = sourceGraphic->context();
203   
204     filterData->sourceGraphicBuffer = WTFMove(sourceGraphic);
205     filterData->savedContext = context;
206
207     context = &sourceGraphicContext;
208
209     ASSERT(!m_filter.contains(&renderer));
210     m_filter.set(&renderer, WTFMove(filterData));
211
212     return true;
213 }
214
215 void RenderSVGResourceFilter::postApplyResource(RenderElement& renderer, GraphicsContext*& context, unsigned short resourceMode, const Path*, const RenderSVGShape*)
216 {
217     ASSERT(context);
218     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
219
220     FilterData* filterData = m_filter.get(&renderer);
221     if (!filterData)
222         return;
223
224     switch (filterData->state) {
225     case FilterData::MarkedForRemoval:
226         m_filter.remove(&renderer);
227         return;
228
229     case FilterData::CycleDetected:
230     case FilterData::Applying:
231         // We have a cycle if we are already applying the data.
232         // This can occur due to FeImage referencing a source that makes use of the FEImage itself.
233         // This is the first place we've hit the cycle, so set the state back to PaintingSource so the return stack
234         // will continue correctly.
235         filterData->state = FilterData::PaintingSource;
236         return;
237
238     case FilterData::PaintingSource:
239         if (!filterData->savedContext) {
240             removeClientFromCache(renderer);
241             return;
242         }
243
244         context = filterData->savedContext;
245         filterData->savedContext = 0;
246         break;
247
248     case FilterData::Built: { } // Empty
249     }
250
251     FilterEffect* lastEffect = filterData->builder->lastEffect();
252
253     if (lastEffect && !filterData->boundaries.isEmpty() && !lastEffect->filterPrimitiveSubregion().isEmpty()) {
254         // This is the real filtering of the object. It just needs to be called on the
255         // initial filtering process. We just take the stored filter result on a
256         // second drawing.
257         if (filterData->state != FilterData::Built)
258             filterData->filter->setSourceImage(WTFMove(filterData->sourceGraphicBuffer));
259
260         // Always true if filterData is just built (filterData->state == FilterData::Built).
261         if (!lastEffect->hasResult()) {
262             filterData->state = FilterData::Applying;
263             lastEffect->applyAll();
264             lastEffect->correctFilterResultIfNeeded();
265             lastEffect->transformResultColorSpace(ColorSpaceDeviceRGB);
266         }
267         filterData->state = FilterData::Built;
268
269         ImageBuffer* resultImage = lastEffect->asImageBuffer();
270         if (resultImage) {
271             context->concatCTM(filterData->shearFreeAbsoluteTransform.inverse().valueOr(AffineTransform()));
272
273             context->scale(FloatSize(1 / filterData->filter->filterResolution().width(), 1 / filterData->filter->filterResolution().height()));
274             context->drawImageBuffer(*resultImage, lastEffect->absolutePaintRect());
275             context->scale(filterData->filter->filterResolution());
276
277             context->concatCTM(filterData->shearFreeAbsoluteTransform);
278         }
279     }
280     filterData->sourceGraphicBuffer.reset();
281 }
282
283 FloatRect RenderSVGResourceFilter::resourceBoundingBox(const RenderObject& object)
284 {
285     return SVGLengthContext::resolveRectangle<SVGFilterElement>(&filterElement(), filterElement().filterUnits(), object.objectBoundingBox());
286 }
287
288 void RenderSVGResourceFilter::primitiveAttributeChanged(RenderObject* object, const QualifiedName& attribute)
289 {
290     SVGFilterPrimitiveStandardAttributes* primitve = static_cast<SVGFilterPrimitiveStandardAttributes*>(object->node());
291
292     for (const auto& objectFilterDataPair : m_filter) {
293         const auto& filterData = objectFilterDataPair.value;
294         if (filterData->state != FilterData::Built)
295             continue;
296
297         SVGFilterBuilder* builder = filterData->builder.get();
298         FilterEffect* effect = builder->effectByRenderer(object);
299         if (!effect)
300             continue;
301         // Since all effects shares the same attribute value, all
302         // or none of them will be changed.
303         if (!primitve->setFilterEffectAttribute(effect, attribute))
304             return;
305         builder->clearResultsRecursive(effect);
306
307         // Repaint the image on the screen.
308         markClientForInvalidation(*objectFilterDataPair.key, RepaintInvalidation);
309     }
310     markAllClientLayersForInvalidation();
311 }
312
313 FloatRect RenderSVGResourceFilter::drawingRegion(RenderObject* object) const
314 {
315     FilterData* filterData = m_filter.get(object);
316     return filterData ? filterData->drawingRegion : FloatRect();
317 }
318
319 }