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.
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.
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.
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.
26 #include "core/rendering/svg/RenderSVGResourceFilter.h"
28 #include "core/dom/ElementTraversal.h"
29 #include "core/frame/Settings.h"
30 #include "core/rendering/svg/RenderSVGResourceFilterPrimitive.h"
31 #include "core/rendering/svg/SVGRenderingContext.h"
32 #include "core/svg/SVGFilterPrimitiveStandardAttributes.h"
33 #include "platform/graphics/UnacceleratedImageBufferSurface.h"
34 #include "platform/graphics/filters/SkiaImageFilterBuilder.h"
35 #include "platform/graphics/filters/SourceAlpha.h"
36 #include "platform/graphics/filters/SourceGraphic.h"
40 const RenderSVGResourceType RenderSVGResourceFilter::s_resourceType = FilterResourceType;
42 RenderSVGResourceFilter::RenderSVGResourceFilter(SVGFilterElement* node)
43 : RenderSVGResourceContainer(node)
47 RenderSVGResourceFilter::~RenderSVGResourceFilter()
52 bool RenderSVGResourceFilter::isChildAllowed(RenderObject* child, RenderStyle*) const
54 return child->isSVGResourceFilterPrimitive();
57 void RenderSVGResourceFilter::removeAllClientsFromCache(bool markForInvalidation)
60 markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
63 void RenderSVGResourceFilter::removeClientFromCache(RenderObject* client, bool markForInvalidation)
67 if (FilterData* filterData = m_filter.get(client)) {
68 if (filterData->savedContext)
69 filterData->state = FilterData::MarkedForRemoval;
71 m_filter.remove(client);
74 markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
77 PassRefPtr<SVGFilterBuilder> RenderSVGResourceFilter::buildPrimitives(SVGFilter* filter)
79 SVGFilterElement* filterElement = toSVGFilterElement(element());
80 FloatRect targetBoundingBox = filter->targetBoundingBox();
82 // Add effects to the builder
83 RefPtr<SVGFilterBuilder> builder = SVGFilterBuilder::create(SourceGraphic::create(filter), SourceAlpha::create(filter));
84 for (SVGElement* element = Traversal<SVGElement>::firstChild(*filterElement); element; element = Traversal<SVGElement>::nextSibling(*element)) {
85 if (!element->isFilterEffect() || !element->renderer())
88 SVGFilterPrimitiveStandardAttributes* effectElement = static_cast<SVGFilterPrimitiveStandardAttributes*>(element);
89 RefPtr<FilterEffect> effect = effectElement->build(builder.get(), filter);
91 builder->clearEffects();
94 builder->appendEffectToEffectReferences(effect, effectElement->renderer());
95 effectElement->setStandardAttributes(effect.get());
96 effect->setEffectBoundaries(SVGLengthContext::resolveRectangle<SVGFilterPrimitiveStandardAttributes>(effectElement, filterElement->primitiveUnits()->currentValue()->enumValue(), targetBoundingBox));
97 effect->setOperatingColorSpace(
98 effectElement->renderer()->style()->svgStyle().colorInterpolationFilters() == CI_LINEARRGB ? ColorSpaceLinearRGB : ColorSpaceDeviceRGB);
99 builder->add(AtomicString(effectElement->result()->currentValue()->value()), effect);
101 return builder.release();
104 void RenderSVGResourceFilter::adjustScaleForMaximumImageSize(const FloatSize& size, FloatSize& filterScale)
106 FloatSize scaledSize(size);
107 scaledSize.scale(filterScale.width(), filterScale.height());
108 float scaledArea = scaledSize.width() * scaledSize.height();
110 if (scaledArea <= FilterEffect::maxFilterArea())
113 // If area of scaled size is bigger than the upper limit, adjust the scale
115 filterScale.scale(sqrt(FilterEffect::maxFilterArea() / scaledArea));
118 static bool createImageBuffer(const Filter* filter, OwnPtr<ImageBuffer>& imageBuffer)
120 IntRect paintRect = filter->sourceImageRect();
121 // Don't create empty ImageBuffers.
122 if (paintRect.isEmpty())
125 OwnPtr<ImageBufferSurface> surface = adoptPtr(new UnacceleratedImageBufferSurface(paintRect.size()));
126 if (!surface->isValid())
128 OwnPtr<ImageBuffer> image = ImageBuffer::create(surface.release());
130 GraphicsContext* imageContext = image->context();
131 ASSERT(imageContext);
133 imageContext->translate(-paintRect.x(), -paintRect.y());
134 imageContext->concatCTM(filter->absoluteTransform());
135 imageBuffer = image.release();
139 static void beginDeferredFilter(GraphicsContext* context, FilterData* filterData)
141 context->beginRecording(filterData->boundaries);
142 // We pass the boundaries to SkPictureImageFilter so it knows the
143 // world-space position of the filter primitives. It gets them
144 // from the DisplayList, which also applies the inverse translate
145 // to the origin. So we apply the forward translate here to avoid
146 // it being applied twice.
147 // FIXME: we should fix SkPicture to handle this offset itself, or
148 // make the translate optional on SkPictureImageFilter.
149 // See https://code.google.com/p/skia/issues/detail?id=2801
150 context->translate(filterData->boundaries.x(), filterData->boundaries.y());
153 static void endDeferredFilter(GraphicsContext* context, FilterData* filterData)
155 // FIXME: maybe filterData should just hold onto SourceGraphic after creation?
156 SourceGraphic* sourceGraphic = static_cast<SourceGraphic*>(filterData->builder->getEffectById(SourceGraphic::effectName()));
157 ASSERT(sourceGraphic);
158 sourceGraphic->setDisplayList(context->endRecording());
161 static void drawDeferredFilter(GraphicsContext* context, FilterData* filterData, SVGFilterElement* filterElement)
163 SkiaImageFilterBuilder builder(context);
164 SourceGraphic* sourceGraphic = static_cast<SourceGraphic*>(filterData->builder->getEffectById(SourceGraphic::effectName()));
165 ASSERT(sourceGraphic);
166 builder.setSourceGraphic(sourceGraphic);
167 RefPtr<ImageFilter> imageFilter = builder.build(filterData->builder->lastEffect(), ColorSpaceDeviceRGB);
168 FloatRect boundaries = enclosingIntRect(filterData->boundaries);
171 FloatSize deviceSize = context->getCTM().mapSize(boundaries.size());
172 float scaledArea = deviceSize.width() * deviceSize.height();
174 // If area of scaled size is bigger than the upper limit, adjust the scale
175 // to fit. Note that this only really matters in the non-impl-side painting
176 // case, since the impl-side case never allocates a full-sized backing
177 // store, only tile-sized.
178 // FIXME: remove this once all platforms are using impl-side painting.
180 if (scaledArea > FilterEffect::maxFilterArea()) {
181 float scale = sqrtf(FilterEffect::maxFilterArea() / scaledArea);
182 context->scale(scale, scale);
184 // Clip drawing of filtered image to primitive boundaries.
185 context->clipRect(boundaries);
186 if (filterElement->hasAttribute(SVGNames::filterResAttr)) {
187 // Get boundaries in device coords.
188 // FIXME: See crbug.com/382491. Is the use of getCTM OK here, given it does not include device
189 // zoom or High DPI adjustments?
190 FloatSize size = context->getCTM().mapSize(boundaries.size());
191 // Compute the scale amount required so that the resulting offscreen is exactly filterResX by filterResY pixels.
192 float filterResScaleX = filterElement->filterResX()->currentValue()->value() / size.width();
193 float filterResScaleY = filterElement->filterResY()->currentValue()->value() / size.height();
194 // Scale the CTM so the primitive is drawn to filterRes.
195 context->scale(filterResScaleX, filterResScaleY);
196 // Create a resize filter with the inverse scale.
197 AffineTransform resizeMatrix;
198 resizeMatrix.scale(1 / filterResScaleX, 1 / filterResScaleY);
199 imageFilter = builder.buildTransform(resizeMatrix, imageFilter.get());
201 // If the CTM contains rotation or shearing, apply the filter to
202 // the unsheared/unrotated matrix, and do the shearing/rotation
204 AffineTransform ctm = context->getCTM();
205 if (ctm.b() || ctm.c()) {
206 AffineTransform scaleAndTranslate;
207 scaleAndTranslate.translate(ctm.e(), ctm.f());
208 scaleAndTranslate.scale(ctm.xScale(), ctm.yScale());
209 ASSERT(scaleAndTranslate.isInvertible());
210 AffineTransform shearAndRotate = scaleAndTranslate.inverse();
211 shearAndRotate.multiply(ctm);
212 context->setCTM(scaleAndTranslate);
213 imageFilter = builder.buildTransform(shearAndRotate, imageFilter.get());
215 context->beginLayer(1, CompositeSourceOver, &boundaries, ColorFilterNone, imageFilter.get());
220 bool RenderSVGResourceFilter::applyResource(RenderObject* object, RenderStyle*, GraphicsContext*& context, unsigned short resourceMode)
224 ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
226 clearInvalidationMask();
228 bool deferredFiltersEnabled = object->document().settings()->deferredFiltersEnabled();
229 if (m_filter.contains(object)) {
230 FilterData* filterData = m_filter.get(object);
231 if (filterData->state == FilterData::PaintingSource || filterData->state == FilterData::Applying)
232 filterData->state = FilterData::CycleDetected;
233 return false; // Already built, or we're in a cycle, or we're marked for removal. Regardless, just do nothing more now.
236 OwnPtr<FilterData> filterData(adoptPtr(new FilterData));
237 FloatRect targetBoundingBox = object->objectBoundingBox();
239 SVGFilterElement* filterElement = toSVGFilterElement(element());
240 filterData->boundaries = SVGLengthContext::resolveRectangle<SVGFilterElement>(filterElement, filterElement->filterUnits()->currentValue()->enumValue(), targetBoundingBox);
241 if (filterData->boundaries.isEmpty())
244 // Determine absolute transformation matrix for filter.
245 AffineTransform absoluteTransform;
246 SVGRenderingContext::calculateDeviceSpaceTransformation(object, absoluteTransform);
247 if (!absoluteTransform.isInvertible())
250 // Filters cannot handle a full transformation, only scales in each direction.
251 FloatSize filterScale;
253 // Calculate the scale factor for the filter.
254 // Also see http://www.w3.org/TR/SVG/filters.html#FilterEffectsRegion
255 if (filterElement->hasAttribute(SVGNames::filterResAttr)) {
256 // If resolution is specified, scale to match it.
257 filterScale = FloatSize(
258 filterElement->filterResX()->currentValue()->value() / filterData->boundaries.width(),
259 filterElement->filterResY()->currentValue()->value() / filterData->boundaries.height());
261 // Otherwise, use the scale of the absolute transform.
262 filterScale = FloatSize(absoluteTransform.xScale(), absoluteTransform.yScale());
264 // The size of the scaled filter boundaries shouldn't be bigger than kMaxFilterSize.
265 // Intermediate filters are limited by the filter boundaries so they can't be bigger than this.
266 adjustScaleForMaximumImageSize(filterData->boundaries.size(), filterScale);
268 filterData->drawingRegion = object->strokeBoundingBox();
269 filterData->drawingRegion.intersect(filterData->boundaries);
270 FloatRect absoluteDrawingRegion = filterData->drawingRegion;
271 if (!deferredFiltersEnabled)
272 absoluteDrawingRegion.scale(filterScale.width(), filterScale.height());
274 IntRect intDrawingRegion = enclosingIntRect(absoluteDrawingRegion);
276 // Create the SVGFilter object.
277 bool primitiveBoundingBoxMode = filterElement->primitiveUnits()->currentValue()->enumValue() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX;
278 filterData->shearFreeAbsoluteTransform = AffineTransform();
279 if (!deferredFiltersEnabled)
280 filterData->shearFreeAbsoluteTransform.scale(filterScale.width(), filterScale.height());
281 filterData->filter = SVGFilter::create(filterData->shearFreeAbsoluteTransform, intDrawingRegion, targetBoundingBox, filterData->boundaries, primitiveBoundingBoxMode);
283 // Create all relevant filter primitives.
284 filterData->builder = buildPrimitives(filterData->filter.get());
285 if (!filterData->builder)
288 FilterEffect* lastEffect = filterData->builder->lastEffect();
292 lastEffect->determineFilterPrimitiveSubregion(ClipToFilterRegion);
294 if (deferredFiltersEnabled) {
295 FilterData* data = filterData.get();
296 m_filter.set(object, filterData.release());
297 beginDeferredFilter(context, data);
301 // If the drawingRegion is empty, we have something like <g filter=".."/>.
302 // Even if the target objectBoundingBox() is empty, we still have to draw the last effect result image in postApplyResource.
303 if (filterData->drawingRegion.isEmpty()) {
304 ASSERT(!m_filter.contains(object));
305 filterData->savedContext = context;
306 m_filter.set(object, filterData.release());
310 OwnPtr<ImageBuffer> sourceGraphic;
311 if (!createImageBuffer(filterData->filter.get(), sourceGraphic)) {
312 ASSERT(!m_filter.contains(object));
313 filterData->savedContext = context;
314 m_filter.set(object, filterData.release());
318 GraphicsContext* sourceGraphicContext = sourceGraphic->context();
319 ASSERT(sourceGraphicContext);
321 filterData->sourceGraphicBuffer = sourceGraphic.release();
322 filterData->savedContext = context;
324 context = sourceGraphicContext;
326 ASSERT(!m_filter.contains(object));
327 m_filter.set(object, filterData.release());
332 void RenderSVGResourceFilter::postApplyResource(RenderObject* object, GraphicsContext*& context, unsigned short resourceMode, const Path*, const RenderSVGShape*)
336 ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
338 FilterData* filterData = m_filter.get(object);
342 bool deferredFiltersEnabled = object->document().settings()->deferredFiltersEnabled();
344 switch (filterData->state) {
345 case FilterData::MarkedForRemoval:
346 m_filter.remove(object);
349 case FilterData::CycleDetected:
350 case FilterData::Applying:
351 // We have a cycle if we are already applying the data.
352 // This can occur due to FeImage referencing a source that makes use of the FEImage itself.
353 // This is the first place we've hit the cycle, so set the state back to PaintingSource so the return stack
354 // will continue correctly.
355 filterData->state = FilterData::PaintingSource;
358 case FilterData::PaintingSource:
359 if (deferredFiltersEnabled) {
360 endDeferredFilter(context, filterData);
362 if (!filterData->savedContext) {
363 removeClientFromCache(object);
367 context = filterData->savedContext;
368 filterData->savedContext = 0;
372 case FilterData::Built: { } // Empty
375 if (deferredFiltersEnabled) {
376 drawDeferredFilter(context, filterData, toSVGFilterElement(element()));
377 filterData->state = FilterData::Built;
381 FilterEffect* lastEffect = filterData->builder->lastEffect();
383 if (lastEffect && !filterData->boundaries.isEmpty() && !lastEffect->filterPrimitiveSubregion().isEmpty()) {
384 // This is the real filtering of the object. It just needs to be called on the
385 // initial filtering process. We just take the stored filter result on a
387 if (filterData->state != FilterData::Built)
388 filterData->filter->setSourceImage(filterData->sourceGraphicBuffer.release());
390 // Always true if filterData is just built (filterData->state == FilterData::Built).
391 if (!lastEffect->hasResult()) {
392 filterData->state = FilterData::Applying;
394 lastEffect->correctFilterResultIfNeeded();
395 lastEffect->transformResultColorSpace(ColorSpaceDeviceRGB);
397 filterData->state = FilterData::Built;
399 ImageBuffer* resultImage = lastEffect->asImageBuffer();
401 context->drawImageBuffer(resultImage, filterData->filter->mapAbsoluteRectToLocalRect(lastEffect->absolutePaintRect()));
404 filterData->sourceGraphicBuffer.clear();
407 FloatRect RenderSVGResourceFilter::resourceBoundingBox(const RenderObject* object)
409 if (SVGFilterElement* element = toSVGFilterElement(this->element()))
410 return SVGLengthContext::resolveRectangle<SVGFilterElement>(element, element->filterUnits()->currentValue()->enumValue(), object->objectBoundingBox());
415 void RenderSVGResourceFilter::primitiveAttributeChanged(RenderObject* object, const QualifiedName& attribute)
417 FilterMap::iterator it = m_filter.begin();
418 FilterMap::iterator end = m_filter.end();
419 SVGFilterPrimitiveStandardAttributes* primitve = static_cast<SVGFilterPrimitiveStandardAttributes*>(object->node());
421 for (; it != end; ++it) {
422 FilterData* filterData = it->value.get();
423 if (filterData->state != FilterData::Built)
426 SVGFilterBuilder* builder = filterData->builder.get();
427 FilterEffect* effect = builder->effectByRenderer(object);
430 // Since all effects shares the same attribute value, all
431 // or none of them will be changed.
432 if (!primitve->setFilterEffectAttribute(effect, attribute))
434 builder->clearResultsRecursive(effect);
436 // Issue paint invalidations for the image on the screen.
437 markClientForInvalidation(it->key, PaintInvalidation);
439 markAllClientLayersForInvalidation();
442 FloatRect RenderSVGResourceFilter::drawingRegion(RenderObject* object) const
444 FilterData* filterData = m_filter.get(object);
445 return filterData ? filterData->drawingRegion : FloatRect();