Modernize the toRenderSVGResourceContainer() helper.
[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
26 #if ENABLE(SVG) && ENABLE(FILTERS)
27 #include "RenderSVGResourceFilter.h"
28
29 #include "ElementChildIterator.h"
30 #include "FilterEffect.h"
31 #include "FloatPoint.h"
32 #include "Frame.h"
33 #include "GraphicsContext.h"
34 #include "Image.h"
35 #include "ImageData.h"
36 #include "IntRect.h"
37 #include "Page.h"
38 #include "RenderSVGResourceFilterPrimitive.h"
39 #include "RenderView.h"
40 #include "SVGFilterPrimitiveStandardAttributes.h"
41 #include "SVGNames.h"
42 #include "SVGRenderingContext.h"
43 #include "Settings.h"
44 #include "SourceAlpha.h"
45 #include "SourceGraphic.h"
46
47 namespace WebCore {
48
49 RenderSVGResourceType RenderSVGResourceFilter::s_resourceType = FilterResourceType;
50
51 RenderSVGResourceFilter::RenderSVGResourceFilter(SVGFilterElement& element, PassRef<RenderStyle> style)
52     : RenderSVGResourceContainer(element, std::move(style))
53 {
54 }
55
56 RenderSVGResourceFilter::~RenderSVGResourceFilter()
57 {
58 }
59
60 void RenderSVGResourceFilter::removeAllClientsFromCache(bool markForInvalidation)
61 {
62     m_filter.clear();
63
64     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
65 }
66
67 void RenderSVGResourceFilter::removeClientFromCache(RenderObject& client, bool markForInvalidation)
68 {
69     if (FilterData* filterData = m_filter.get(&client)) {
70         if (filterData->savedContext)
71             filterData->state = FilterData::MarkedForRemoval;
72         else
73             m_filter.remove(&client);
74     }
75
76     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
77 }
78
79 std::unique_ptr<SVGFilterBuilder> RenderSVGResourceFilter::buildPrimitives(SVGFilter* filter) const
80 {
81     FloatRect targetBoundingBox = filter->targetBoundingBox();
82
83     // Add effects to the builder
84     auto builder = std::make_unique<SVGFilterBuilder>(SourceGraphic::create(filter), SourceAlpha::create(filter));
85     for (auto& element : childrenOfType<SVGFilterPrimitiveStandardAttributes>(filterElement())) {
86         RefPtr<FilterEffect> effect = element.build(builder.get(), filter);
87         if (!effect) {
88             builder->clearEffects();
89             return nullptr;
90         }
91         builder->appendEffectToEffectReferences(effect, element.renderer());
92         element.setStandardAttributes(effect.get());
93         effect->setEffectBoundaries(SVGLengthContext::resolveRectangle<SVGFilterPrimitiveStandardAttributes>(&element, filterElement().primitiveUnits(), targetBoundingBox));
94         effect->setOperatingColorSpace(element.renderer()->style().svgStyle().colorInterpolationFilters() == CI_LINEARRGB ? ColorSpaceLinearRGB : ColorSpaceDeviceRGB);
95         builder->add(element.result(), effect.release());
96     }
97     return builder;
98 }
99
100 bool RenderSVGResourceFilter::fitsInMaximumImageSize(const FloatSize& size, FloatSize& scale)
101 {
102     bool matchesFilterSize = true;
103     if (size.width() > kMaxFilterSize) {
104         scale.setWidth(scale.width() * kMaxFilterSize / size.width());
105         matchesFilterSize = false;
106     }
107     if (size.height() > kMaxFilterSize) {
108         scale.setHeight(scale.height() * kMaxFilterSize / size.height());
109         matchesFilterSize = false;
110     }
111
112     return matchesFilterSize;
113 }
114
115 bool RenderSVGResourceFilter::applyResource(RenderElement& renderer, const RenderStyle&, GraphicsContext*& context, unsigned short resourceMode)
116 {
117     ASSERT(context);
118     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
119
120     if (m_filter.contains(&renderer)) {
121         FilterData* filterData = m_filter.get(&renderer);
122         if (filterData->state == FilterData::PaintingSource || filterData->state == FilterData::Applying)
123             filterData->state = FilterData::CycleDetected;
124         return false; // Already built, or we're in a cycle, or we're marked for removal. Regardless, just do nothing more now.
125     }
126
127     auto filterData = std::make_unique<FilterData>();
128     FloatRect targetBoundingBox = renderer.objectBoundingBox();
129
130     filterData->boundaries = SVGLengthContext::resolveRectangle<SVGFilterElement>(&filterElement(), filterElement().filterUnits(), targetBoundingBox);
131     if (filterData->boundaries.isEmpty())
132         return false;
133
134     // Determine absolute transformation matrix for filter. 
135     AffineTransform absoluteTransform;
136     SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(renderer, absoluteTransform);
137     if (!absoluteTransform.isInvertible())
138         return false;
139
140     // Eliminate shear of the absolute transformation matrix, to be able to produce unsheared tile images for feTile.
141     filterData->shearFreeAbsoluteTransform = AffineTransform(absoluteTransform.xScale(), 0, 0, absoluteTransform.yScale(), 0, 0);
142
143     // Determine absolute boundaries of the filter and the drawing region.
144     FloatRect absoluteFilterBoundaries = filterData->shearFreeAbsoluteTransform.mapRect(filterData->boundaries);
145     filterData->drawingRegion = renderer.strokeBoundingBox();
146     filterData->drawingRegion.intersect(filterData->boundaries);
147     FloatRect absoluteDrawingRegion = filterData->shearFreeAbsoluteTransform.mapRect(filterData->drawingRegion);
148
149     // Create the SVGFilter object.
150     bool primitiveBoundingBoxMode = filterElement().primitiveUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX;
151     filterData->filter = SVGFilter::create(filterData->shearFreeAbsoluteTransform, absoluteDrawingRegion, targetBoundingBox, filterData->boundaries, primitiveBoundingBoxMode);
152
153     // Create all relevant filter primitives.
154     filterData->builder = buildPrimitives(filterData->filter.get());
155     if (!filterData->builder)
156         return false;
157
158     // Calculate the scale factor for the use of filterRes.
159     // Also see http://www.w3.org/TR/SVG/filters.html#FilterEffectsRegion
160     FloatSize scale(1, 1);
161     if (filterElement().hasAttribute(SVGNames::filterResAttr)) {
162         scale.setWidth(filterElement().filterResX() / absoluteFilterBoundaries.width());
163         scale.setHeight(filterElement().filterResY() / absoluteFilterBoundaries.height());
164     }
165
166     if (scale.isEmpty())
167         return false;
168
169     // Determine scale factor for filter. The size of intermediate ImageBuffers shouldn't be bigger than kMaxFilterSize.
170     FloatRect tempSourceRect = absoluteDrawingRegion;
171     tempSourceRect.scale(scale.width(), scale.height());
172     fitsInMaximumImageSize(tempSourceRect.size(), scale);
173
174     // Set the scale level in SVGFilter.
175     filterData->filter->setFilterResolution(scale);
176
177     FilterEffect* lastEffect = filterData->builder->lastEffect();
178     if (!lastEffect)
179         return false;
180
181     RenderSVGResourceFilterPrimitive::determineFilterPrimitiveSubregion(lastEffect);
182     FloatRect subRegion = lastEffect->maxEffectRect();
183     // At least one FilterEffect has a too big image size,
184     // recalculate the effect sizes with new scale factors.
185     if (!fitsInMaximumImageSize(subRegion.size(), scale)) {
186         filterData->filter->setFilterResolution(scale);
187         RenderSVGResourceFilterPrimitive::determineFilterPrimitiveSubregion(lastEffect);
188     }
189
190     // If the drawingRegion is empty, we have something like <g filter=".."/>.
191     // Even if the target objectBoundingBox() is empty, we still have to draw the last effect result image in postApplyResource.
192     if (filterData->drawingRegion.isEmpty()) {
193         ASSERT(!m_filter.contains(&renderer));
194         filterData->savedContext = context;
195         m_filter.set(&renderer, std::move(filterData));
196         return false;
197     }
198
199     // Change the coordinate transformation applied to the filtered element to reflect the resolution of the filter.
200     AffineTransform effectiveTransform;
201     effectiveTransform.scale(scale.width(), scale.height());
202     effectiveTransform.multiply(filterData->shearFreeAbsoluteTransform);
203
204     std::unique_ptr<ImageBuffer> sourceGraphic;
205     RenderingMode renderingMode = renderer.frame().settings().acceleratedFiltersEnabled() ? Accelerated : Unaccelerated;
206     if (!SVGRenderingContext::createImageBuffer(filterData->drawingRegion, effectiveTransform, sourceGraphic, ColorSpaceLinearRGB, renderingMode)) {
207         ASSERT(!m_filter.contains(&renderer));
208         filterData->savedContext = context;
209         m_filter.set(&renderer, std::move(filterData));
210         return false;
211     }
212     
213     // Set the rendering mode from the page's settings.
214     filterData->filter->setRenderingMode(renderingMode);
215
216     GraphicsContext* sourceGraphicContext = sourceGraphic->context();
217     ASSERT(sourceGraphicContext);
218   
219     filterData->sourceGraphicBuffer = std::move(sourceGraphic);
220     filterData->savedContext = context;
221
222     context = sourceGraphicContext;
223
224     ASSERT(!m_filter.contains(&renderer));
225     m_filter.set(&renderer, std::move(filterData));
226
227     return true;
228 }
229
230 void RenderSVGResourceFilter::postApplyResource(RenderElement& renderer, GraphicsContext*& context, unsigned short resourceMode, const Path*, const RenderSVGShape*)
231 {
232     ASSERT(context);
233     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
234
235     FilterData* filterData = m_filter.get(&renderer);
236     if (!filterData)
237         return;
238
239     switch (filterData->state) {
240     case FilterData::MarkedForRemoval:
241         m_filter.remove(&renderer);
242         return;
243
244     case FilterData::CycleDetected:
245     case FilterData::Applying:
246         // We have a cycle if we are already applying the data.
247         // This can occur due to FeImage referencing a source that makes use of the FEImage itself.
248         // This is the first place we've hit the cycle, so set the state back to PaintingSource so the return stack
249         // will continue correctly.
250         filterData->state = FilterData::PaintingSource;
251         return;
252
253     case FilterData::PaintingSource:
254         if (!filterData->savedContext) {
255             removeClientFromCache(renderer);
256             return;
257         }
258
259         context = filterData->savedContext;
260         filterData->savedContext = 0;
261         break;
262
263     case FilterData::Built: { } // Empty
264     }
265
266     FilterEffect* lastEffect = filterData->builder->lastEffect();
267
268     if (lastEffect && !filterData->boundaries.isEmpty() && !lastEffect->filterPrimitiveSubregion().isEmpty()) {
269         // This is the real filtering of the object. It just needs to be called on the
270         // initial filtering process. We just take the stored filter result on a
271         // second drawing.
272         if (filterData->state != FilterData::Built)
273             filterData->filter->setSourceImage(std::move(filterData->sourceGraphicBuffer));
274
275         // Always true if filterData is just built (filterData->state == FilterData::Built).
276         if (!lastEffect->hasResult()) {
277             filterData->state = FilterData::Applying;
278             lastEffect->applyAll();
279             lastEffect->correctFilterResultIfNeeded();
280             lastEffect->transformResultColorSpace(ColorSpaceDeviceRGB);
281         }
282         filterData->state = FilterData::Built;
283
284         ImageBuffer* resultImage = lastEffect->asImageBuffer();
285         if (resultImage) {
286             context->concatCTM(filterData->shearFreeAbsoluteTransform.inverse());
287
288             context->scale(FloatSize(1 / filterData->filter->filterResolution().width(), 1 / filterData->filter->filterResolution().height()));
289             context->drawImageBuffer(resultImage, renderer.style().colorSpace(), lastEffect->absolutePaintRect());
290             context->scale(filterData->filter->filterResolution());
291
292             context->concatCTM(filterData->shearFreeAbsoluteTransform);
293         }
294     }
295     filterData->sourceGraphicBuffer.reset();
296 }
297
298 FloatRect RenderSVGResourceFilter::resourceBoundingBox(const RenderObject& object)
299 {
300     return SVGLengthContext::resolveRectangle<SVGFilterElement>(&filterElement(), filterElement().filterUnits(), object.objectBoundingBox());
301 }
302
303 void RenderSVGResourceFilter::primitiveAttributeChanged(RenderObject* object, const QualifiedName& attribute)
304 {
305     SVGFilterPrimitiveStandardAttributes* primitve = static_cast<SVGFilterPrimitiveStandardAttributes*>(object->node());
306
307     for (const auto& objectFilterDataPair : m_filter) {
308         const auto& filterData = objectFilterDataPair.value;
309         if (filterData->state != FilterData::Built)
310             continue;
311
312         SVGFilterBuilder* builder = filterData->builder.get();
313         FilterEffect* effect = builder->effectByRenderer(object);
314         if (!effect)
315             continue;
316         // Since all effects shares the same attribute value, all
317         // or none of them will be changed.
318         if (!primitve->setFilterEffectAttribute(effect, attribute))
319             return;
320         builder->clearResultsRecursive(effect);
321
322         // Repaint the image on the screen.
323         markClientForInvalidation(*objectFilterDataPair.key, RepaintInvalidation);
324     }
325     markAllClientLayersForInvalidation();
326 }
327
328 FloatRect RenderSVGResourceFilter::drawingRegion(RenderObject* object) const
329 {
330     FilterData* filterData = m_filter.get(object);
331     return filterData ? filterData->drawingRegion : FloatRect();
332 }
333
334 }
335 #endif