Remove deep copy of ImageBuffer in tiled SVG backgrounds
[WebKit-https.git] / Source / WebCore / svg / graphics / SVGImage.cpp
1 /*
2  * Copyright (C) 2006 Eric Seidel <eric@webkit.org>
3  * Copyright (C) 2008, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #include "config.h"
29
30 #if ENABLE(SVG)
31 #include "SVGImage.h"
32
33 #include "DocumentLoader.h"
34 #include "FrameView.h"
35 #include "ImageBuffer.h"
36 #include "ImageObserver.h"
37 #include "IntRect.h"
38 #include "RenderSVGRoot.h"
39 #include "SVGDocument.h"
40 #include "SVGImageChromeClient.h"
41 #include "SVGSVGElement.h"
42 #include "Settings.h"
43
44 namespace WebCore {
45
46 SVGImage::SVGImage(ImageObserver* observer)
47     : Image(observer)
48 {
49 }
50
51 SVGImage::~SVGImage()
52 {
53     if (m_page) {
54         // Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
55         OwnPtr<Page> currentPage = m_page.release();
56         currentPage->mainFrame()->loader()->frameDetached(); // Break both the loader and view references to the frame
57     }
58
59     // Verify that page teardown destroyed the Chrome
60     ASSERT(!m_chromeClient || !m_chromeClient->image());
61 }
62
63 void SVGImage::setContainerSize(const IntSize& size)
64 {
65     if (!m_page || !usesContainerSize())
66         return;
67
68     Frame* frame = m_page->mainFrame();
69     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
70     if (!rootElement)
71         return;
72     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
73     if (!renderer)
74         return;
75
76     FrameView* view = frameView();
77     view->resize(this->size());
78
79     renderer->setContainerSize(size);
80 }
81
82 IntSize SVGImage::size() const
83 {
84     if (!m_page)
85         return IntSize();
86     Frame* frame = m_page->mainFrame();
87     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
88     if (!rootElement)
89         return IntSize();
90
91     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
92     if (!renderer)
93         return IntSize();
94
95     // If a container size is available it has precedence.
96     IntSize containerSize = renderer->containerSize();
97     if (!containerSize.isEmpty())
98         return containerSize;
99
100     // Assure that a container size is always given for a non-identity zoom level.
101     ASSERT(renderer->style()->effectiveZoom() == 1);
102
103     FloatSize currentSize;
104     if (rootElement->intrinsicWidth().isFixed() && rootElement->intrinsicHeight().isFixed())
105         currentSize = rootElement->currentViewportSize();
106     else
107         currentSize = rootElement->currentViewBoxRect().size();
108
109     if (!currentSize.isEmpty())
110         return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
111
112     // As last resort, use CSS default intrinsic size.
113     return IntSize(300, 150);
114 }
115
116 void SVGImage::drawForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& dstRect,
117     const FloatRect& srcRect, ColorSpace colorSpace, CompositeOperator compositeOp, BlendMode blendMode)
118 {
119     if (!m_page)
120         return;
121
122     ImageObserver* observer = imageObserver();
123     ASSERT(observer);
124
125     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
126     setImageObserver(0);
127
128     IntSize roundedContainerSize = roundedIntSize(containerSize);
129     setContainerSize(roundedContainerSize);
130
131     FloatRect scaledSrc = srcRect;
132     scaledSrc.scale(1 / zoom);
133
134     // Compensate for the container size rounding by adjusting the source rect.
135     FloatSize adjustedSrcSize = scaledSrc.size();
136     adjustedSrcSize.scale(roundedContainerSize.width() / containerSize.width(), roundedContainerSize.height() / containerSize.height());
137     scaledSrc.setSize(adjustedSrcSize);
138
139     draw(context, dstRect, scaledSrc, colorSpace, compositeOp, blendMode);
140
141     setImageObserver(observer);
142 }
143
144 void SVGImage::drawPatternForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& srcRect,
145     const AffineTransform& patternTransform, const FloatPoint& phase, ColorSpace colorSpace, CompositeOperator compositeOp, const FloatRect& dstRect)
146 {
147     FloatRect zoomedContainerRect = FloatRect(FloatPoint(), containerSize);
148     zoomedContainerRect.scale(zoom);
149
150     // The ImageBuffer size needs to be scaled to match the final resolution.
151     AffineTransform transform = context->getCTM();
152     FloatSize imageBufferScale = FloatSize(transform.xScale(), transform.yScale());
153     ASSERT(imageBufferScale.width());
154     ASSERT(imageBufferScale.height());
155
156     FloatRect imageBufferSize = zoomedContainerRect;
157     imageBufferSize.scale(imageBufferScale.width(), imageBufferScale.height());
158
159     OwnPtr<ImageBuffer> buffer = ImageBuffer::create(expandedIntSize(imageBufferSize.size()), 1);
160     drawForContainer(buffer->context(), containerSize, zoom, imageBufferSize, zoomedContainerRect, ColorSpaceDeviceRGB, CompositeSourceOver, BlendModeNormal);
161     RefPtr<Image> image = buffer->copyImage(DontCopyBackingStore, Unscaled);
162
163     // Adjust the source rect and transform due to the image buffer's scaling.
164     FloatRect scaledSrcRect = srcRect;
165     scaledSrcRect.scale(imageBufferScale.width(), imageBufferScale.height());
166     AffineTransform unscaledPatternTransform(patternTransform);
167     unscaledPatternTransform.scale(1 / imageBufferScale.width(), 1 / imageBufferScale.height());
168
169     image->drawPattern(context, scaledSrcRect, unscaledPatternTransform, phase, colorSpace, compositeOp, dstRect);
170 }
171
172 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp, BlendMode)
173 {
174     if (!m_page)
175         return;
176
177     FrameView* view = frameView();
178
179     GraphicsContextStateSaver stateSaver(*context);
180     context->setCompositeOperation(compositeOp);
181     context->clip(enclosingIntRect(dstRect));
182     if (compositeOp != CompositeSourceOver)
183         context->beginTransparencyLayer(1);
184
185     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
186     
187     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
188     // of the image would be if we were drawing without clipping, and translate accordingly.
189     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
190     FloatPoint destOffset = dstRect.location() - topLeftOffset;
191
192     context->translate(destOffset.x(), destOffset.y());
193     context->scale(scale);
194
195     view->resize(size());
196
197     if (view->needsLayout())
198         view->layout();
199
200     view->paint(context, IntRect(0, 0, view->width(), view->height()));
201
202     if (compositeOp != CompositeSourceOver)
203         context->endTransparencyLayer();
204
205     stateSaver.restore();
206
207     if (imageObserver())
208         imageObserver()->didDraw(this);
209 }
210
211 RenderBox* SVGImage::embeddedContentBox() const
212 {
213     if (!m_page)
214         return 0;
215     Frame* frame = m_page->mainFrame();
216     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
217     if (!rootElement)
218         return 0;
219     return toRenderBox(rootElement->renderer());
220 }
221
222 FrameView* SVGImage::frameView() const
223 {
224     if (!m_page)
225         return 0;
226
227     return m_page->mainFrame()->view();
228 }
229
230 bool SVGImage::hasRelativeWidth() const
231 {
232     if (!m_page)
233         return false;
234     Frame* frame = m_page->mainFrame();
235     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
236     if (!rootElement)
237         return false;
238     return rootElement->intrinsicWidth().isPercent();
239 }
240
241 bool SVGImage::hasRelativeHeight() const
242 {
243     if (!m_page)
244         return false;
245     Frame* frame = m_page->mainFrame();
246     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
247     if (!rootElement)
248         return false;
249     return rootElement->intrinsicHeight().isPercent();
250 }
251
252 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
253 {
254     if (!m_page)
255         return;
256     Frame* frame = m_page->mainFrame();
257     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
258     if (!rootElement)
259         return;
260
261     intrinsicWidth = rootElement->intrinsicWidth();
262     intrinsicHeight = rootElement->intrinsicHeight();
263     if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
264         return;
265
266     intrinsicRatio = rootElement->viewBox().size();
267     if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
268         intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
269 }
270
271 // FIXME: support catchUpIfNecessary.
272 void SVGImage::startAnimation(bool /* catchUpIfNecessary */)
273 {
274     if (!m_page)
275         return;
276     Frame* frame = m_page->mainFrame();
277     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
278     if (!rootElement)
279         return;
280     rootElement->unpauseAnimations();
281     rootElement->setCurrentTime(0);
282 }
283
284 void SVGImage::stopAnimation()
285 {
286     if (!m_page)
287         return;
288     Frame* frame = m_page->mainFrame();
289     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
290     if (!rootElement)
291         return;
292     rootElement->pauseAnimations();
293 }
294
295 void SVGImage::resetAnimation()
296 {
297     stopAnimation();
298 }
299
300 bool SVGImage::dataChanged(bool allDataReceived)
301 {
302     // Don't do anything if is an empty image.
303     if (!data()->size())
304         return true;
305
306     if (allDataReceived) {
307         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
308
309         Page::PageClients pageClients;
310         fillWithEmptyClients(pageClients);
311         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
312         pageClients.chromeClient = m_chromeClient.get();
313
314         // FIXME: If this SVG ends up loading itself, we might leak the world.
315         // The Cache code does not know about CachedImages holding Frames and
316         // won't know to break the cycle.
317         // This will become an issue when SVGImage will be able to load other
318         // SVGImage objects, but we're safe now, because SVGImage can only be
319         // loaded by a top-level document.
320         m_page = adoptPtr(new Page(pageClients));
321         m_page->settings()->setMediaEnabled(false);
322         m_page->settings()->setScriptEnabled(false);
323         m_page->settings()->setPluginsEnabled(false);
324
325         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
326         frame->setView(FrameView::create(frame.get()));
327         frame->init();
328         FrameLoader* loader = frame->loader();
329         loader->forceSandboxFlags(SandboxAll);
330
331         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
332         frame->view()->setTransparent(true); // SVG Images are transparent.
333
334         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
335         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
336         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
337         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
338         loader->activeDocumentLoader()->writer()->end();
339     }
340
341     return m_page;
342 }
343
344 String SVGImage::filenameExtension() const
345 {
346     return "svg";
347 }
348
349 void SVGImage::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
350 {
351     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::CachedResourceImage);
352     Image::reportMemoryUsage(memoryObjectInfo);
353     info.addMember(m_chromeClient, "chromeClient");
354     info.addMember(m_page, "page");
355 }
356
357 }
358
359 #endif // ENABLE(SVG)