All image drawing functions should take an argument of type ImagePaintingOptions
[WebKit.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 "SVGImage.h"
37 #include "SharedBuffer.h"
38 #include <math.h>
39 #include <wtf/MainThread.h>
40 #include <wtf/StdLibExtras.h>
41 #include <wtf/URL.h>
42 #include <wtf/text/TextStream.h>
43
44 #if USE(CG)
45 #include "PDFDocumentImage.h"
46 #include <CoreFoundation/CoreFoundation.h>
47 #endif
48
49 namespace WebCore {
50
51 Image::Image(ImageObserver* observer)
52     : m_imageObserver(observer)
53 {
54 }
55
56 Image::~Image() = default;
57
58 Image& Image::nullImage()
59 {
60     ASSERT(isMainThread());
61     static Image& nullImage = BitmapImage::create().leakRef();
62     return nullImage;
63 }
64
65 RefPtr<Image> Image::create(ImageObserver& observer)
66 {
67     auto mimeType = observer.mimeType();
68     if (mimeType == "image/svg+xml")
69         return SVGImage::create(observer);
70
71     auto url = observer.sourceUrl();
72     if (isPDFResource(mimeType, url) || isPostScriptResource(mimeType, url)) {
73 #if USE(CG) && !USE(WEBKIT_IMAGE_DECODERS)
74         return PDFDocumentImage::create(&observer);
75 #else
76         return nullptr;
77 #endif
78     }
79
80     return BitmapImage::create(&observer);
81 }
82
83 bool Image::supportsType(const String& type)
84 {
85     return MIMETypeRegistry::isSupportedImageMIMEType(type);
86
87
88 bool Image::isPDFResource(const String& mimeType, const URL& url)
89 {
90     if (mimeType.isEmpty())
91         return url.path().endsWithIgnoringASCIICase(".pdf");
92     return MIMETypeRegistry::isPDFMIMEType(mimeType);
93 }
94
95 bool Image::isPostScriptResource(const String& mimeType, const URL& url)
96 {
97     if (mimeType.isEmpty())
98         return url.path().endsWithIgnoringASCIICase(".ps");
99     return MIMETypeRegistry::isPostScriptMIMEType(mimeType);
100 }
101
102
103 EncodedDataStatus Image::setData(RefPtr<SharedBuffer>&& data, bool allDataReceived)
104 {
105     m_encodedImageData = WTFMove(data);
106
107     // Don't do anything; it is an empty image.
108     if (!m_encodedImageData.get() || !m_encodedImageData->size())
109         return EncodedDataStatus::Complete;
110
111     return dataChanged(allDataReceived);
112 }
113
114 URL Image::sourceURL() const
115 {
116     return imageObserver() ? imageObserver()->sourceUrl() : URL();
117 }
118
119 String Image::mimeType() const
120 {
121     return imageObserver() ? imageObserver()->mimeType() : emptyString();
122 }
123
124 long long Image::expectedContentLength() const
125 {
126     return imageObserver() ? imageObserver()->expectedContentLength() : 0;
127 }
128
129 void Image::fillWithSolidColor(GraphicsContext& ctxt, const FloatRect& dstRect, const Color& color, CompositeOperator op)
130 {
131     if (!color.isVisible())
132         return;
133     
134     CompositeOperator previousOperator = ctxt.compositeOperation();
135     ctxt.setCompositeOperation(color.isOpaque() && op == CompositeSourceOver ? CompositeCopy : op);
136     ctxt.fillRect(dstRect, color);
137     ctxt.setCompositeOperation(previousOperator);
138 }
139
140 void Image::drawPattern(GraphicsContext& ctxt, const FloatRect& destRect, const FloatRect& tileRect, const AffineTransform& patternTransform,  const FloatPoint& phase, const FloatSize& spacing, const ImagePaintingOptions& options)
141 {
142     if (!nativeImageForCurrentFrame(&ctxt))
143         return;
144
145     ctxt.drawPattern(*this, destRect, tileRect, patternTransform, phase, spacing, options);
146
147     if (imageObserver())
148         imageObserver()->didDraw(*this);
149 }
150
151 ImageDrawResult Image::drawTiled(GraphicsContext& ctxt, const FloatRect& destRect, const FloatPoint& srcPoint, const FloatSize& scaledTileSize, const FloatSize& spacing, const ImagePaintingOptions& options)
152 {
153     Color color = singlePixelSolidColor();
154     if (color.isValid()) {
155         fillWithSolidColor(ctxt, destRect, color, options.compositeOperator());
156         return ImageDrawResult::DidDraw;
157     }
158
159     ASSERT(!isBitmapImage() || notSolidColor());
160
161     FloatSize intrinsicTileSize = size();
162     if (hasRelativeWidth())
163         intrinsicTileSize.setWidth(scaledTileSize.width());
164     if (hasRelativeHeight())
165         intrinsicTileSize.setHeight(scaledTileSize.height());
166
167     FloatSize scale(scaledTileSize / intrinsicTileSize);
168
169     FloatRect oneTileRect;
170     FloatSize actualTileSize = scaledTileSize + spacing;
171     oneTileRect.setX(destRect.x() + fmodf(fmodf(-srcPoint.x(), actualTileSize.width()) - actualTileSize.width(), actualTileSize.width()));
172     oneTileRect.setY(destRect.y() + fmodf(fmodf(-srcPoint.y(), actualTileSize.height()) - actualTileSize.height(), actualTileSize.height()));
173     oneTileRect.setSize(scaledTileSize);
174     
175     // Check and see if a single draw of the image can cover the entire area we are supposed to tile.
176     if (oneTileRect.contains(destRect) && !ctxt.drawLuminanceMask()) {
177         FloatRect visibleSrcRect;
178         visibleSrcRect.setX((destRect.x() - oneTileRect.x()) / scale.width());
179         visibleSrcRect.setY((destRect.y() - oneTileRect.y()) / scale.height());
180         visibleSrcRect.setWidth(destRect.width() / scale.width());
181         visibleSrcRect.setHeight(destRect.height() / scale.height());
182         return draw(ctxt, destRect, visibleSrcRect, options);
183     }
184
185 #if PLATFORM(IOS_FAMILY)
186     // When using accelerated drawing on iOS, it's faster to stretch an image than to tile it.
187     if (ctxt.isAcceleratedContext()) {
188         if (size().width() == 1 && intersection(oneTileRect, destRect).height() == destRect.height()) {
189             FloatRect visibleSrcRect;
190             visibleSrcRect.setX(0);
191             visibleSrcRect.setY((destRect.y() - oneTileRect.y()) / scale.height());
192             visibleSrcRect.setWidth(1);
193             visibleSrcRect.setHeight(destRect.height() / scale.height());
194             return draw(ctxt, destRect, visibleSrcRect, { options, BlendMode::Normal });
195         }
196         if (size().height() == 1 && intersection(oneTileRect, destRect).width() == destRect.width()) {
197             FloatRect visibleSrcRect;
198             visibleSrcRect.setX((destRect.x() - oneTileRect.x()) / scale.width());
199             visibleSrcRect.setY(0);
200             visibleSrcRect.setWidth(destRect.width() / scale.width());
201             visibleSrcRect.setHeight(1);
202             return draw(ctxt, destRect, visibleSrcRect, { options, BlendMode::Normal });
203         }
204     }
205 #endif
206
207     // Patterned images and gradients can use lots of memory for caching when the
208     // tile size is large (<rdar://problem/4691859>, <rdar://problem/6239505>).
209     // Memory consumption depends on the transformed tile size which can get
210     // larger than the original tile if user zooms in enough.
211 #if PLATFORM(IOS_FAMILY)
212     const float maxPatternTilePixels = 512 * 512;
213 #else
214     const float maxPatternTilePixels = 2048 * 2048;
215 #endif
216     FloatRect transformedTileSize = ctxt.getCTM().mapRect(FloatRect(FloatPoint(), scaledTileSize));
217     float transformedTileSizePixels = transformedTileSize.width() * transformedTileSize.height();
218     FloatRect currentTileRect = oneTileRect;
219     if (transformedTileSizePixels > maxPatternTilePixels) {
220         GraphicsContextStateSaver stateSaver(ctxt);
221         ctxt.clip(destRect);
222
223         currentTileRect.shiftYEdgeTo(destRect.y());
224         float toY = currentTileRect.y();
225         ImageDrawResult result = ImageDrawResult::DidNothing;
226         while (toY < destRect.maxY()) {
227             currentTileRect.shiftXEdgeTo(destRect.x());
228             float toX = currentTileRect.x();
229             while (toX < destRect.maxX()) {
230                 FloatRect toRect(toX, toY, currentTileRect.width(), currentTileRect.height());
231                 FloatRect fromRect(toFloatPoint(currentTileRect.location() - oneTileRect.location()), currentTileRect.size());
232                 fromRect.scale(1 / scale.width(), 1 / scale.height());
233
234                 result = draw(ctxt, toRect, fromRect, { options, BlendMode::Normal });
235                 if (result == ImageDrawResult::DidRequestDecoding)
236                     return result;
237                 toX += currentTileRect.width();
238                 currentTileRect.shiftXEdgeTo(oneTileRect.x());
239             }
240             toY += currentTileRect.height();
241             currentTileRect.shiftYEdgeTo(oneTileRect.y());
242         }
243         return result;
244     }
245
246     AffineTransform patternTransform = AffineTransform().scaleNonUniform(scale.width(), scale.height());
247     FloatRect tileRect(FloatPoint(), intrinsicTileSize);
248     drawPattern(ctxt, destRect, tileRect, patternTransform, oneTileRect.location(), spacing, options);
249     startAnimation();
250     return ImageDrawResult::DidDraw;
251 }
252
253 // FIXME: Merge with the other drawTiled eventually, since we need a combination of both for some things.
254 ImageDrawResult Image::drawTiled(GraphicsContext& ctxt, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, const ImagePaintingOptions& options)
255 {    
256     Color color = singlePixelSolidColor();
257     if (color.isValid()) {
258         fillWithSolidColor(ctxt, dstRect, color, options.compositeOperator());
259         return ImageDrawResult::DidDraw;
260     }
261     
262     FloatSize tileScale = tileScaleFactor;
263     FloatSize spacing;
264     
265     // FIXME: These rules follow CSS border-image rules, but they should not be down here in Image.
266     bool centerOnGapHorizonally = false;
267     bool centerOnGapVertically = false;
268     switch (hRule) {
269     case RoundTile: {
270         int numItems = std::max<int>(floorf(dstRect.width() / srcRect.width()), 1);
271         tileScale.setWidth(dstRect.width() / (srcRect.width() * numItems));
272         break;
273     }
274     case SpaceTile: {
275         int numItems = floorf(dstRect.width() / srcRect.width());
276         if (!numItems)
277             return ImageDrawResult::DidNothing;
278         spacing.setWidth((dstRect.width() - srcRect.width() * numItems) / (numItems + 1));
279         tileScale.setWidth(1);
280         centerOnGapHorizonally = !(numItems & 1);
281         break;
282     }
283     case StretchTile:
284     case RepeatTile:
285         break;
286     }
287
288     switch (vRule) {
289     case RoundTile: {
290         int numItems = std::max<int>(floorf(dstRect.height() / srcRect.height()), 1);
291         tileScale.setHeight(dstRect.height() / (srcRect.height() * numItems));
292         break;
293         }
294     case SpaceTile: {
295         int numItems = floorf(dstRect.height() / srcRect.height());
296         if (!numItems)
297             return ImageDrawResult::DidNothing;
298         spacing.setHeight((dstRect.height() - srcRect.height() * numItems) / (numItems + 1));
299         tileScale.setHeight(1);
300         centerOnGapVertically = !(numItems & 1);
301         break;
302     }
303     case StretchTile:
304     case RepeatTile:
305         break;
306     }
307
308     AffineTransform patternTransform = AffineTransform().scaleNonUniform(tileScale.width(), tileScale.height());
309
310     // We want to construct the phase such that the pattern is centered (when stretch is not
311     // set for a particular rule).
312     float hPhase = tileScale.width() * srcRect.x();
313     float vPhase = tileScale.height() * srcRect.y();
314     float scaledTileWidth = tileScale.width() * srcRect.width();
315     float scaledTileHeight = tileScale.height() * srcRect.height();
316
317     if (centerOnGapHorizonally)
318         hPhase -= spacing.width();
319     else if (hRule == Image::RepeatTile || hRule == Image::SpaceTile)
320         hPhase -= (dstRect.width() - scaledTileWidth) / 2;
321
322     if (centerOnGapVertically)
323         vPhase -= spacing.height();
324     else if (vRule == Image::RepeatTile || vRule == Image::SpaceTile)
325         vPhase -= (dstRect.height() - scaledTileHeight) / 2;
326
327     FloatPoint patternPhase(dstRect.x() - hPhase, dstRect.y() - vPhase);
328     drawPattern(ctxt, dstRect, srcRect, patternTransform, patternPhase, spacing, options);
329     startAnimation();
330     return ImageDrawResult::DidDraw;
331 }
332
333 void Image::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
334 {
335     intrinsicRatio = size();
336     intrinsicWidth = Length(intrinsicRatio.width(), Fixed);
337     intrinsicHeight = Length(intrinsicRatio.height(), Fixed);
338 }
339
340 void Image::startAnimationAsynchronously()
341 {
342     if (!m_animationStartTimer)
343         m_animationStartTimer = makeUnique<Timer>(*this, &Image::startAnimation);
344     if (m_animationStartTimer->isActive())
345         return;
346     m_animationStartTimer->startOneShot(0_s);
347 }
348
349 void Image::dump(TextStream& ts) const
350 {
351     if (isAnimated())
352         ts.dumpProperty("animated", isAnimated());
353
354     if (isNull())
355         ts.dumpProperty("is-null-image", true);
356
357     ts.dumpProperty("size", size());
358 }
359
360 TextStream& operator<<(TextStream& ts, const Image& image)
361 {
362     TextStream::GroupScope scope(ts);
363     
364     if (image.isBitmapImage())
365         ts << "bitmap image";
366     else if (image.isCrossfadeGeneratedImage())
367         ts << "crossfade image";
368     else if (image.isNamedImageGeneratedImage())
369         ts << "named image";
370     else if (image.isGradientImage())
371         ts << "gradient image";
372     else if (image.isSVGImage())
373         ts << "svg image";
374     else if (image.isPDFDocumentImage())
375         ts << "pdf image";
376
377     image.dump(ts);
378     return ts;
379 }
380
381 #if !PLATFORM(COCOA) && !PLATFORM(GTK) && !PLATFORM(WIN)
382
383 void BitmapImage::invalidatePlatformData()
384 {
385 }
386
387 Ref<Image> Image::loadPlatformResource(const char* resource)
388 {
389     WTFLogAlways("WARNING: trying to load platform resource '%s'", resource);
390     return BitmapImage::create();
391 }
392
393 #endif // !PLATFORM(COCOA) && !PLATFORM(GTK) && !PLATFORM(WIN)
394 }