53a22aa6841d827a5d54a3fea7230d7a676edf17
[WebKit-https.git] / Source / WebCore / platform / graphics / Image.cpp
1 /*
2  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
3  * Copyright (C) 2004, 2005, 2006 Apple Inc.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "Image.h"
29
30 #include "AffineTransform.h"
31 #include "BitmapImage.h"
32 #include "GraphicsContext.h"
33 #include "ImageObserver.h"
34 #include "Length.h"
35 #include "MIMETypeRegistry.h"
36 #include "SharedBuffer.h"
37 #include "TextStream.h"
38 #include <math.h>
39 #include <wtf/MainThread.h>
40 #include <wtf/StdLibExtras.h>
41
42 #if USE(CG)
43 #include <CoreFoundation/CoreFoundation.h>
44 #endif
45
46 namespace WebCore {
47
48 Image::Image(ImageObserver* observer)
49     : m_imageObserver(observer)
50 {
51 }
52
53 Image::~Image()
54 {
55 }
56
57 Image* Image::nullImage()
58 {
59     ASSERT(isMainThread());
60     static Image& nullImage = BitmapImage::create().leakRef();
61     return &nullImage;
62 }
63
64 bool Image::supportsType(const String& type)
65 {
66     return MIMETypeRegistry::isSupportedImageResourceMIMEType(type);
67
68
69 EncodedDataStatus Image::setData(RefPtr<SharedBuffer>&& data, bool allDataReceived)
70 {
71     m_encodedImageData = WTFMove(data);
72
73     // Don't do anything; it is an empty image.
74     if (!m_encodedImageData.get() || !m_encodedImageData->size())
75         return EncodedDataStatus::Complete;
76
77     return dataChanged(allDataReceived);
78 }
79
80 URL Image::sourceURL() const
81 {
82     return imageObserver() ? imageObserver()->sourceUrl() : URL();
83 }
84
85 void Image::fillWithSolidColor(GraphicsContext& ctxt, const FloatRect& dstRect, const Color& color, CompositeOperator op)
86 {
87     if (!color.isVisible())
88         return;
89     
90     CompositeOperator previousOperator = ctxt.compositeOperation();
91     ctxt.setCompositeOperation(color.isOpaque() && op == CompositeSourceOver ? CompositeCopy : op);
92     ctxt.fillRect(dstRect, color);
93     ctxt.setCompositeOperation(previousOperator);
94 }
95
96 void Image::drawTiled(GraphicsContext& ctxt, const FloatRect& destRect, const FloatPoint& srcPoint, const FloatSize& scaledTileSize, const FloatSize& spacing, CompositeOperator op, BlendMode blendMode, DecodingMode decodingMode)
97 {
98     Color color = singlePixelSolidColor();
99     if (color.isValid()) {
100         fillWithSolidColor(ctxt, destRect, color, op);
101         return;
102     }
103
104     ASSERT(!isBitmapImage() || notSolidColor());
105
106 #if PLATFORM(IOS)
107     FloatSize intrinsicTileSize = originalSize();
108 #else
109     FloatSize intrinsicTileSize = size();
110 #endif
111     if (hasRelativeWidth())
112         intrinsicTileSize.setWidth(scaledTileSize.width());
113     if (hasRelativeHeight())
114         intrinsicTileSize.setHeight(scaledTileSize.height());
115
116     FloatSize scale(scaledTileSize.width() / intrinsicTileSize.width(),
117                     scaledTileSize.height() / intrinsicTileSize.height());
118
119     FloatRect oneTileRect;
120     FloatSize actualTileSize(scaledTileSize.width() + spacing.width(), scaledTileSize.height() + spacing.height());
121     oneTileRect.setX(destRect.x() + fmodf(fmodf(-srcPoint.x(), actualTileSize.width()) - actualTileSize.width(), actualTileSize.width()));
122     oneTileRect.setY(destRect.y() + fmodf(fmodf(-srcPoint.y(), actualTileSize.height()) - actualTileSize.height(), actualTileSize.height()));
123     oneTileRect.setSize(scaledTileSize);
124     
125     // Check and see if a single draw of the image can cover the entire area we are supposed to tile.
126     if (oneTileRect.contains(destRect) && !ctxt.drawLuminanceMask()) {
127         FloatRect visibleSrcRect;
128         visibleSrcRect.setX((destRect.x() - oneTileRect.x()) / scale.width());
129         visibleSrcRect.setY((destRect.y() - oneTileRect.y()) / scale.height());
130         visibleSrcRect.setWidth(destRect.width() / scale.width());
131         visibleSrcRect.setHeight(destRect.height() / scale.height());
132         draw(ctxt, destRect, visibleSrcRect, op, blendMode, decodingMode, ImageOrientationDescription());
133         return;
134     }
135
136 #if PLATFORM(IOS)
137     // When using accelerated drawing on iOS, it's faster to stretch an image than to tile it.
138     if (ctxt.isAcceleratedContext()) {
139         if (size().width() == 1 && intersection(oneTileRect, destRect).height() == destRect.height()) {
140             FloatRect visibleSrcRect;
141             visibleSrcRect.setX(0);
142             visibleSrcRect.setY((destRect.y() - oneTileRect.y()) / scale.height());
143             visibleSrcRect.setWidth(1);
144             visibleSrcRect.setHeight(destRect.height() / scale.height());
145             draw(ctxt, destRect, visibleSrcRect, op, BlendModeNormal, decodingMode, ImageOrientationDescription());
146             return;
147         }
148         if (size().height() == 1 && intersection(oneTileRect, destRect).width() == destRect.width()) {
149             FloatRect visibleSrcRect;
150             visibleSrcRect.setX((destRect.x() - oneTileRect.x()) / scale.width());
151             visibleSrcRect.setY(0);
152             visibleSrcRect.setWidth(destRect.width() / scale.width());
153             visibleSrcRect.setHeight(1);
154             draw(ctxt, destRect, visibleSrcRect, op, BlendModeNormal, decodingMode, ImageOrientationDescription());
155             return;
156         }
157     }
158 #endif
159
160     // Patterned images and gradients can use lots of memory for caching when the
161     // tile size is large (<rdar://problem/4691859>, <rdar://problem/6239505>).
162     // Memory consumption depends on the transformed tile size which can get
163     // larger than the original tile if user zooms in enough.
164 #if PLATFORM(IOS)
165     const float maxPatternTilePixels = 512 * 512;
166 #else
167     const float maxPatternTilePixels = 2048 * 2048;
168 #endif
169     FloatRect transformedTileSize = ctxt.getCTM().mapRect(FloatRect(FloatPoint(), scaledTileSize));
170     float transformedTileSizePixels = transformedTileSize.width() * transformedTileSize.height();
171     FloatRect currentTileRect = oneTileRect;
172     if (transformedTileSizePixels > maxPatternTilePixels) {
173         GraphicsContextStateSaver stateSaver(ctxt);
174         ctxt.clip(destRect);
175
176         currentTileRect.shiftYEdgeTo(destRect.y());
177         float toY = currentTileRect.y();
178         while (toY < destRect.maxY()) {
179             currentTileRect.shiftXEdgeTo(destRect.x());
180             float toX = currentTileRect.x();
181             while (toX < destRect.maxX()) {
182                 FloatRect toRect(toX, toY, currentTileRect.width(), currentTileRect.height());
183                 FloatRect fromRect(toFloatPoint(currentTileRect.location() - oneTileRect.location()), currentTileRect.size());
184                 fromRect.scale(1 / scale.width(), 1 / scale.height());
185
186                 draw(ctxt, toRect, fromRect, op, BlendModeNormal, decodingMode, ImageOrientationDescription());
187                 toX += currentTileRect.width();
188                 currentTileRect.shiftXEdgeTo(oneTileRect.x());
189             }
190             toY += currentTileRect.height();
191             currentTileRect.shiftYEdgeTo(oneTileRect.y());
192         }
193         return;
194     }
195
196     AffineTransform patternTransform = AffineTransform().scaleNonUniform(scale.width(), scale.height());
197     FloatRect tileRect(FloatPoint(), intrinsicTileSize);
198     drawPattern(ctxt, destRect, tileRect, patternTransform, oneTileRect.location(), spacing, op, blendMode);
199     startAnimation();
200 }
201
202 // FIXME: Merge with the other drawTiled eventually, since we need a combination of both for some things.
203 void Image::drawTiled(GraphicsContext& ctxt, const FloatRect& dstRect, const FloatRect& srcRect,
204     const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, CompositeOperator op)
205 {    
206     Color color = singlePixelSolidColor();
207     if (color.isValid()) {
208         fillWithSolidColor(ctxt, dstRect, color, op);
209         return;
210     }
211     
212     FloatSize tileScale = tileScaleFactor;
213     FloatSize spacing;
214     
215     // FIXME: These rules follow CSS border-image rules, but they should not be down here in Image.
216     bool centerOnGapHorizonally = false;
217     bool centerOnGapVertically = false;
218     switch (hRule) {
219     case RoundTile: {
220         int numItems = std::max<int>(floorf(dstRect.width() / srcRect.width()), 1);
221         tileScale.setWidth(dstRect.width() / (srcRect.width() * numItems));
222         break;
223     }
224     case SpaceTile: {
225         int numItems = floorf(dstRect.width() / srcRect.width());
226         if (!numItems)
227             return;
228         spacing.setWidth((dstRect.width() - srcRect.width() * numItems) / (numItems + 1));
229         tileScale.setWidth(1);
230         centerOnGapHorizonally = !(numItems & 1);
231         break;
232     }
233     case StretchTile:
234     case RepeatTile:
235         break;
236     }
237
238     switch (vRule) {
239     case RoundTile: {
240         int numItems = std::max<int>(floorf(dstRect.height() / srcRect.height()), 1);
241         tileScale.setHeight(dstRect.height() / (srcRect.height() * numItems));
242         break;
243         }
244     case SpaceTile: {
245         int numItems = floorf(dstRect.height() / srcRect.height());
246         if (!numItems)
247             return;
248         spacing.setHeight((dstRect.height() - srcRect.height() * numItems) / (numItems + 1));
249         tileScale.setHeight(1);
250         centerOnGapVertically = !(numItems & 1);
251         break;
252     }
253     case StretchTile:
254     case RepeatTile:
255         break;
256     }
257
258     AffineTransform patternTransform = AffineTransform().scaleNonUniform(tileScale.width(), tileScale.height());
259
260     // We want to construct the phase such that the pattern is centered (when stretch is not
261     // set for a particular rule).
262     float hPhase = tileScale.width() * srcRect.x();
263     float vPhase = tileScale.height() * srcRect.y();
264     float scaledTileWidth = tileScale.width() * srcRect.width();
265     float scaledTileHeight = tileScale.height() * srcRect.height();
266
267     if (centerOnGapHorizonally)
268         hPhase -= spacing.width();
269     else if (hRule == Image::RepeatTile || hRule == Image::SpaceTile)
270         hPhase -= (dstRect.width() - scaledTileWidth) / 2;
271
272     if (centerOnGapVertically)
273         vPhase -= spacing.height();
274     else if (vRule == Image::RepeatTile || vRule == Image::SpaceTile)
275         vPhase -= (dstRect.height() - scaledTileHeight) / 2;
276
277     FloatPoint patternPhase(dstRect.x() - hPhase, dstRect.y() - vPhase);
278     drawPattern(ctxt, dstRect, srcRect, patternTransform, patternPhase, spacing, op);
279     startAnimation();
280 }
281
282 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
283 FloatRect Image::adjustSourceRectForDownSampling(const FloatRect& srcRect, const IntSize& scaledSize) const
284 {
285     const FloatSize unscaledSize = size();
286     if (unscaledSize == scaledSize)
287         return srcRect;
288
289     // Image has been down-sampled.
290     float xscale = static_cast<float>(scaledSize.width()) / unscaledSize.width();
291     float yscale = static_cast<float>(scaledSize.height()) / unscaledSize.height();
292     FloatRect scaledSrcRect = srcRect;
293     scaledSrcRect.scale(xscale, yscale);
294
295     return scaledSrcRect;
296 }
297 #endif
298
299 void Image::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
300 {
301 #if PLATFORM(IOS)
302     intrinsicRatio = originalSize();
303 #else
304     intrinsicRatio = size();
305 #endif
306     intrinsicWidth = Length(intrinsicRatio.width(), Fixed);
307     intrinsicHeight = Length(intrinsicRatio.height(), Fixed);
308 }
309
310 void Image::dump(TextStream& ts) const
311 {
312     if (isAnimated())
313         ts.dumpProperty("animated", isAnimated());
314
315     if (isNull())
316         ts.dumpProperty("is-null-image", true);
317
318     ts.dumpProperty("size", size());
319 }
320
321 TextStream& operator<<(TextStream& ts, const Image& image)
322 {
323     TextStream::GroupScope scope(ts);
324     
325     if (image.isBitmapImage())
326         ts << "bitmap image";
327     else if (image.isCrossfadeGeneratedImage())
328         ts << "crossfade image";
329     else if (image.isNamedImageGeneratedImage())
330         ts << "named image";
331     else if (image.isGradientImage())
332         ts << "gradient image";
333     else if (image.isSVGImage())
334         ts << "svg image";
335     else if (image.isPDFDocumentImage())
336         ts << "pdf image";
337
338     image.dump(ts);
339     return ts;
340 }
341
342 }