ImageBuffer::create should return a std::unique_ptr instead of OwnPtr.
[WebKit-https.git] / Source / WebCore / rendering / svg / SVGRenderingContext.cpp
1 /*
2  * Copyright (C) 2007, 2008 Rob Buis <buis@kde.org>
3  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2009 Google, Inc.  All rights reserved.
6  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
7  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26
27 #if ENABLE(SVG)
28 #include "SVGRenderingContext.h"
29
30 #include "BasicShapes.h"
31 #include "Frame.h"
32 #include "FrameView.h"
33 #include "Page.h"
34 #include "RenderLayer.h"
35 #include "RenderSVGImage.h"
36 #include "RenderSVGResource.h"
37 #include "RenderSVGResourceClipper.h"
38 #include "RenderSVGResourceFilter.h"
39 #include "RenderSVGResourceMasker.h"
40 #include "RenderView.h"
41 #include "SVGResources.h"
42 #include "SVGResourcesCache.h"
43
44 static int kMaxImageBufferSize = 4096;
45
46 namespace WebCore {
47
48 static inline bool isRenderingMaskImage(const RenderObject& object)
49 {
50     return object.view().frameView().paintBehavior() & PaintBehaviorRenderingSVGMask;
51 }
52
53 SVGRenderingContext::~SVGRenderingContext()
54 {
55     // Fast path if we don't need to restore anything.
56     if (!(m_renderingFlags & ActionsNeeded))
57         return;
58
59     ASSERT(m_renderer && m_paintInfo);
60
61 #if ENABLE(FILTERS)
62     if (m_renderingFlags & EndFilterLayer) {
63         ASSERT(m_filter);
64         m_filter->postApplyResource(*m_renderer, m_paintInfo->context, ApplyToDefaultMode, 0, 0);
65         m_paintInfo->context = m_savedContext;
66         m_paintInfo->rect = m_savedPaintRect;
67     }
68 #endif
69
70     if (m_renderingFlags & EndOpacityLayer)
71         m_paintInfo->context->endTransparencyLayer();
72
73     if (m_renderingFlags & EndShadowLayer)
74         m_paintInfo->context->endTransparencyLayer();
75
76     if (m_renderingFlags & RestoreGraphicsContext)
77         m_paintInfo->context->restore();
78 }
79
80 void SVGRenderingContext::prepareToRenderSVGContent(RenderElement& renderer, PaintInfo& paintInfo, NeedsGraphicsContextSave needsGraphicsContextSave)
81 {
82 #ifndef NDEBUG
83     // This function must not be called twice!
84     ASSERT(!(m_renderingFlags & PrepareToRenderSVGContentWasCalled));
85     m_renderingFlags |= PrepareToRenderSVGContentWasCalled;
86 #endif
87
88     m_renderer = &renderer;
89     m_paintInfo = &paintInfo;
90 #if ENABLE(FILTERS)
91     m_filter = 0;
92 #endif
93
94     // We need to save / restore the context even if the initialization failed.
95     if (needsGraphicsContextSave == SaveGraphicsContext) {
96         m_paintInfo->context->save();
97         m_renderingFlags |= RestoreGraphicsContext;
98     }
99
100     RenderStyle& style = m_renderer->style();
101
102     const SVGRenderStyle& svgStyle = style.svgStyle();
103
104     // Setup transparency layers before setting up SVG resources!
105     bool isRenderingMask = isRenderingMaskImage(*m_renderer);
106     float opacity = isRenderingMask ? 1 : style.opacity();
107     const ShadowData* shadow = svgStyle.shadow();
108     if (opacity < 1 || shadow) {
109         FloatRect repaintRect = m_renderer->repaintRectInLocalCoordinates();
110
111         if (opacity < 1) {
112             m_paintInfo->context->clip(repaintRect);
113             m_paintInfo->context->beginTransparencyLayer(opacity);
114             m_renderingFlags |= EndOpacityLayer;
115         }
116
117         if (shadow) {
118             m_paintInfo->context->clip(repaintRect);
119             m_paintInfo->context->setShadow(IntSize(roundToInt(shadow->x()), roundToInt(shadow->y())), shadow->radius(), shadow->color(), style.colorSpace());
120             m_paintInfo->context->beginTransparencyLayer(1);
121             m_renderingFlags |= EndShadowLayer;
122         }
123     }
124
125     ClipPathOperation* clipPathOperation = style.clipPath();
126     if (clipPathOperation && clipPathOperation->type() == ClipPathOperation::SHAPE) {
127         ShapeClipPathOperation* clipPath = static_cast<ShapeClipPathOperation*>(clipPathOperation);
128         m_paintInfo->context->clipPath(clipPath->path(renderer.objectBoundingBox()), clipPath->windRule());
129     }
130
131     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(m_renderer);
132     if (!resources) {
133 #if ENABLE(FILTERS)
134         if (svgStyle.hasFilter())
135             return;
136 #endif
137         m_renderingFlags |= RenderingPrepared;
138         return;
139     }
140
141     if (!isRenderingMask) {
142         if (RenderSVGResourceMasker* masker = resources->masker()) {
143             if (!masker->applyResource(*m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
144                 return;
145         }
146     }
147
148     RenderSVGResourceClipper* clipper = resources->clipper();
149     if (!clipPathOperation && clipper) {
150         if (!clipper->applyResource(*m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
151             return;
152     }
153
154 #if ENABLE(FILTERS)
155     if (!isRenderingMask) {
156         m_filter = resources->filter();
157         if (m_filter) {
158             m_savedContext = m_paintInfo->context;
159             m_savedPaintRect = m_paintInfo->rect;
160             // Return with false here may mean that we don't need to draw the content
161             // (because it was either drawn before or empty) but we still need to apply the filter.
162             m_renderingFlags |= EndFilterLayer;
163             if (!m_filter->applyResource(*m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
164                 return;
165
166             // Since we're caching the resulting bitmap and do not invalidate it on repaint rect
167             // changes, we need to paint the whole filter region. Otherwise, elements not visible
168             // at the time of the initial paint (due to scrolling, window size, etc.) will never
169             // be drawn.
170             m_paintInfo->rect = IntRect(m_filter->drawingRegion(m_renderer));
171         }
172     }
173 #endif
174
175     m_renderingFlags |= RenderingPrepared;
176 }
177
178 static AffineTransform& currentContentTransformation()
179 {
180     DEFINE_STATIC_LOCAL(AffineTransform, s_currentContentTransformation, ());
181     return s_currentContentTransformation;
182 }
183
184 float SVGRenderingContext::calculateScreenFontSizeScalingFactor(const RenderObject* renderer)
185 {
186     ASSERT(renderer);
187
188     AffineTransform ctm;
189     calculateTransformationToOutermostCoordinateSystem(renderer, ctm);
190     return narrowPrecisionToFloat(sqrt((pow(ctm.xScale(), 2) + pow(ctm.yScale(), 2)) / 2));
191 }
192
193 void SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(const RenderObject* renderer, AffineTransform& absoluteTransform)
194 {
195     ASSERT(renderer);
196     absoluteTransform = currentContentTransformation();
197
198     float deviceScaleFactor = 1;
199     if (Page* page = renderer->document().page())
200         deviceScaleFactor = page->deviceScaleFactor();
201
202     // Walk up the render tree, accumulating SVG transforms.
203     while (renderer) {
204         absoluteTransform = renderer->localToParentTransform() * absoluteTransform;
205         if (renderer->isSVGRoot())
206             break;
207         renderer = renderer->parent();
208     }
209
210     // Continue walking up the layer tree, accumulating CSS transforms.
211     RenderLayer* layer = renderer ? renderer->enclosingLayer() : 0;
212     while (layer) {
213         if (TransformationMatrix* layerTransform = layer->transform())
214             absoluteTransform = layerTransform->toAffineTransform() * absoluteTransform;
215
216         // We can stop at compositing layers, to match the backing resolution.
217         if (layer->isComposited())
218             break;
219
220         layer = layer->parent();
221     }
222
223     absoluteTransform.scale(deviceScaleFactor);
224 }
225
226 bool SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, std::unique_ptr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
227 {
228     IntRect paintRect = calculateImageBufferRect(targetRect, absoluteTransform);
229     // Don't create empty ImageBuffers.
230     if (paintRect.isEmpty())
231         return false;
232
233     IntSize clampedSize = clampedAbsoluteSize(paintRect.size());
234     std::unique_ptr<ImageBuffer> image = ImageBuffer::create(clampedSize, 1, colorSpace, renderingMode);
235     if (!image)
236         return false;
237
238     GraphicsContext* imageContext = image->context();
239     ASSERT(imageContext);
240
241     imageContext->scale(FloatSize(static_cast<float>(clampedSize.width()) / paintRect.width(),
242                                   static_cast<float>(clampedSize.height()) / paintRect.height()));
243     imageContext->translate(-paintRect.x(), -paintRect.y());
244     imageContext->concatCTM(absoluteTransform);
245
246     imageBuffer = std::move(image);
247     return true;
248 }
249
250 bool SVGRenderingContext::createImageBufferForPattern(const FloatRect& absoluteTargetRect, const FloatRect& clampedAbsoluteTargetRect, std::unique_ptr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
251 {
252     IntSize imageSize(roundedIntSize(clampedAbsoluteTargetRect.size()));
253     IntSize unclampedImageSize(roundedIntSize(absoluteTargetRect.size()));
254
255     // Don't create empty ImageBuffers.
256     if (imageSize.isEmpty())
257         return false;
258
259     std::unique_ptr<ImageBuffer> image = ImageBuffer::create(imageSize, 1, colorSpace, renderingMode);
260     if (!image)
261         return false;
262
263     GraphicsContext* imageContext = image->context();
264     ASSERT(imageContext);
265
266     // Compensate rounding effects, as the absolute target rect is using floating-point numbers and the image buffer size is integer.
267     imageContext->scale(FloatSize(unclampedImageSize.width() / absoluteTargetRect.width(), unclampedImageSize.height() / absoluteTargetRect.height()));
268
269     imageBuffer = std::move(image);
270     return true;
271 }
272
273 void SVGRenderingContext::renderSubtreeToImageBuffer(ImageBuffer* image, RenderElement& item, const AffineTransform& subtreeContentTransformation)
274 {
275     ASSERT(image);
276     ASSERT(image->context());
277
278     PaintInfo info(image->context(), PaintInfo::infiniteRect(), PaintPhaseForeground, PaintBehaviorNormal);
279
280     AffineTransform& contentTransformation = currentContentTransformation();
281     AffineTransform savedContentTransformation = contentTransformation;
282     contentTransformation = subtreeContentTransformation * contentTransformation;
283
284     ASSERT(!item.needsLayout());
285     item.paint(info, IntPoint());
286
287     contentTransformation = savedContentTransformation;
288 }
289
290 void SVGRenderingContext::clipToImageBuffer(GraphicsContext* context, const AffineTransform& absoluteTransform, const FloatRect& targetRect, std::unique_ptr<ImageBuffer>& imageBuffer, bool safeToClear)
291 {
292     ASSERT(context);
293     ASSERT(imageBuffer);
294
295     FloatRect absoluteTargetRect = calculateImageBufferRect(targetRect, absoluteTransform);
296
297     // The mask image has been created in the absolute coordinate space, as the image should not be scaled.
298     // So the actual masking process has to be done in the absolute coordinate space as well.
299     context->concatCTM(absoluteTransform.inverse());
300     context->clipToImageBuffer(imageBuffer.get(), absoluteTargetRect);
301     context->concatCTM(absoluteTransform);
302
303     // When nesting resources, with objectBoundingBox as content unit types, there's no use in caching the
304     // resulting image buffer as the parent resource already caches the result.
305     if (safeToClear && !currentContentTransformation().isIdentity())
306         imageBuffer.reset();
307 }
308
309 FloatRect SVGRenderingContext::clampedAbsoluteTargetRect(const FloatRect& absoluteTargetRect)
310 {
311     const FloatSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
312     return FloatRect(absoluteTargetRect.location(), absoluteTargetRect.size().shrunkTo(maxImageBufferSize));
313 }
314
315 IntSize SVGRenderingContext::clampedAbsoluteSize(const IntSize& absoluteSize)
316 {
317     const IntSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
318     return absoluteSize.shrunkTo(maxImageBufferSize);
319 }
320
321 void SVGRenderingContext::clear2DRotation(AffineTransform& transform)
322 {
323     AffineTransform::DecomposedType decomposition;
324     transform.decompose(decomposition);
325     decomposition.angle = 0;
326     transform.recompose(decomposition);
327 }
328
329 bool SVGRenderingContext::bufferForeground(std::unique_ptr<ImageBuffer>& imageBuffer)
330 {
331     ASSERT(m_paintInfo);
332     ASSERT(m_renderer->isSVGImage());
333     FloatRect boundingBox = m_renderer->objectBoundingBox();
334
335     // Invalidate an existing buffer if the scale is not correct.
336     if (imageBuffer) {
337         AffineTransform transform = m_paintInfo->context->getCTM(GraphicsContext::DefinitelyIncludeDeviceScale);
338         IntSize expandedBoundingBox = expandedIntSize(boundingBox.size());
339         IntSize bufferSize(static_cast<int>(ceil(expandedBoundingBox.width() * transform.xScale())), static_cast<int>(ceil(expandedBoundingBox.height() * transform.yScale())));
340         if (bufferSize != imageBuffer->internalSize())
341             imageBuffer.reset();
342     }
343
344     // Create a new buffer and paint the foreground into it.
345     if (!imageBuffer) {
346         if ((imageBuffer = m_paintInfo->context->createCompatibleBuffer(expandedIntSize(boundingBox.size()), true))) {
347             GraphicsContext* bufferedRenderingContext = imageBuffer->context();
348             bufferedRenderingContext->translate(-boundingBox.x(), -boundingBox.y());
349             PaintInfo bufferedInfo(*m_paintInfo);
350             bufferedInfo.context = bufferedRenderingContext;
351             toRenderSVGImage(m_renderer)->paintForeground(bufferedInfo);
352         } else
353             return false;
354     }
355
356     m_paintInfo->context->drawImageBuffer(imageBuffer.get(), ColorSpaceDeviceRGB, boundingBox);
357     return true;
358 }
359
360 }
361
362 #endif