<http://webkit.org/b/91015> Remove BUILDING_ON / TARGETING macros in favor of system...
[WebKit-https.git] / Source / WebCore / platform / graphics / cg / ImageCG.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "BitmapImage.h"
28
29 #if USE(CG)
30
31 #include "AffineTransform.h"
32 #include "FloatConversion.h"
33 #include "FloatRect.h"
34 #include "GraphicsContextCG.h"
35 #include "ImageObserver.h"
36 #include "PDFDocumentImage.h"
37 #include "PlatformString.h"
38 #include <ApplicationServices/ApplicationServices.h>
39 #include <CoreFoundation/CFArray.h>
40 #include <wtf/RetainPtr.h>
41
42 #if PLATFORM(MAC) || PLATFORM(CHROMIUM)
43 #include "WebCoreSystemInterface.h"
44 #endif
45
46 #if PLATFORM(WIN)
47 #include <WebKitSystemInterface/WebKitSystemInterface.h>
48 #endif
49
50 namespace WebCore {
51
52 bool FrameData::clear(bool clearMetadata)
53 {
54     if (clearMetadata)
55         m_haveMetadata = false;
56
57     m_orientation = DefaultImageOrientation;
58
59     if (m_frame) {
60         CGImageRelease(m_frame);
61         m_frame = 0;
62         return true;
63     }
64     return false;
65 }
66
67 // ================================================
68 // Image Class
69 // ================================================
70
71 BitmapImage::BitmapImage(CGImageRef cgImage, ImageObserver* observer)
72     : Image(observer)
73     , m_currentFrame(0)
74     , m_frames(0)
75     , m_frameTimer(0)
76     , m_repetitionCount(cAnimationNone)
77     , m_repetitionCountStatus(Unknown)
78     , m_repetitionsComplete(0)
79     , m_decodedSize(0)
80     , m_frameCount(1)
81     , m_isSolidColor(false)
82     , m_checkedForSolidColor(false)
83     , m_animationFinished(true)
84     , m_allDataReceived(true)
85     , m_haveSize(true)
86     , m_sizeAvailable(true)
87     , m_haveFrameCount(true)
88 {
89     CGFloat width = CGImageGetWidth(cgImage);
90     CGFloat height = CGImageGetHeight(cgImage);
91     m_decodedSize = width * height * 4;
92     m_size = IntSize(width, height);
93
94     // Since we don't have a decoder, we can't figure out the image orientation.
95     // Set m_sizeRespectingOrientation to be the same as m_size so it's not 0x0.
96     m_sizeRespectingOrientation = IntSize(width, height);
97
98     m_frames.grow(1);
99     m_frames[0].m_frame = cgImage;
100     m_frames[0].m_hasAlpha = true;
101     m_frames[0].m_haveMetadata = true;
102
103     checkForSolidColor();
104 }
105
106 // Drawing Routines
107
108 void BitmapImage::checkForSolidColor()
109 {
110     m_checkedForSolidColor = true;
111     if (frameCount() > 1) {
112         m_isSolidColor = false;
113         return;
114     }
115
116     CGImageRef image = frameAtIndex(0);
117     
118     // Currently we only check for solid color in the important special case of a 1x1 image.
119     if (image && CGImageGetWidth(image) == 1 && CGImageGetHeight(image) == 1) {
120         unsigned char pixel[4]; // RGBA
121         RetainPtr<CGContextRef> bmap(AdoptCF, CGBitmapContextCreate(pixel, 1, 1, 8, sizeof(pixel), deviceRGBColorSpaceRef(),
122             kCGImageAlphaPremultipliedLast | kCGBitmapByteOrder32Big));
123         if (!bmap)
124             return;
125         GraphicsContext(bmap.get()).setCompositeOperation(CompositeCopy);
126         CGRect dst = { {0, 0}, {1, 1} };
127         CGContextDrawImage(bmap.get(), dst, image);
128         if (pixel[3] == 0)
129             m_solidColor = Color(0, 0, 0, 0);
130         else
131             m_solidColor = Color(pixel[0] * 255 / pixel[3], pixel[1] * 255 / pixel[3], pixel[2] * 255 / pixel[3], pixel[3]);
132         m_isSolidColor = true;
133     }
134 }
135
136 RetainPtr<CGImageRef> Image::imageWithColorSpace(CGImageRef originalImage, ColorSpace colorSpace)
137 {
138     CGColorSpaceRef originalColorSpace = CGImageGetColorSpace(originalImage);
139
140     // If the image already has a (non-device) color space, we don't want to
141     // override it, so return.
142     if (!originalColorSpace || !CFEqual(originalColorSpace, deviceRGBColorSpaceRef()))
143         return originalImage;
144
145     switch (colorSpace) {
146     case ColorSpaceDeviceRGB:
147         return originalImage;
148     case ColorSpaceSRGB:
149         return RetainPtr<CGImageRef>(AdoptCF, CGImageCreateCopyWithColorSpace(originalImage, sRGBColorSpaceRef()));
150     case ColorSpaceLinearRGB:
151         return RetainPtr<CGImageRef>(AdoptCF, CGImageCreateCopyWithColorSpace(originalImage, linearRGBColorSpaceRef()));
152     }
153
154     ASSERT_NOT_REACHED();
155     return originalImage;
156 }
157
158 CGImageRef BitmapImage::getCGImageRef()
159 {
160     return frameAtIndex(0);
161 }
162
163 CGImageRef BitmapImage::getFirstCGImageRefOfSize(const IntSize& size)
164 {
165     size_t count = frameCount();
166     for (size_t i = 0; i < count; ++i) {
167         CGImageRef cgImage = frameAtIndex(i);
168         if (cgImage && IntSize(CGImageGetWidth(cgImage), CGImageGetHeight(cgImage)) == size)
169             return cgImage;
170     }
171
172     // Fallback to the default CGImageRef if we can't find the right size
173     return getCGImageRef();
174 }
175
176 RetainPtr<CFArrayRef> BitmapImage::getCGImageArray()
177 {
178     size_t count = frameCount();
179     if (!count)
180         return 0;
181     
182     CFMutableArrayRef array = CFArrayCreateMutable(NULL, count, &kCFTypeArrayCallBacks);
183     for (size_t i = 0; i < count; ++i) {
184         if (CGImageRef currFrame = frameAtIndex(i))
185             CFArrayAppendValue(array, currFrame);
186     }
187     return RetainPtr<CFArrayRef>(AdoptCF, array);
188 }
189
190 void BitmapImage::draw(GraphicsContext* ctx, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator op)
191 {
192     draw(ctx, dstRect, srcRect, styleColorSpace, op, DoNotRespectImageOrientation);
193 }
194
195 void BitmapImage::draw(GraphicsContext* ctxt, const FloatRect& destRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator compositeOp, RespectImageOrientationEnum shouldRespectImageOrientation)
196 {
197     startAnimation();
198
199     CGImageRef image = frameAtIndex(m_currentFrame);
200     if (!image) // If it's too early we won't have an image yet.
201         return;
202     
203     if (mayFillWithSolidColor()) {
204         fillWithSolidColor(ctxt, destRect, solidColor(), styleColorSpace, compositeOp);
205         return;
206     }
207
208     FloatSize selfSize = currentFrameSize();
209     ImageOrientation orientation = DefaultImageOrientation;
210
211     if (shouldRespectImageOrientation == RespectImageOrientation)
212         orientation = frameOrientationAtIndex(m_currentFrame);
213
214     ctxt->drawNativeImage(image, selfSize, styleColorSpace, destRect, srcRect, compositeOp, orientation);
215
216     if (imageObserver())
217         imageObserver()->didDraw(this);
218 }
219
220 static void drawPatternCallback(void* info, CGContextRef context)
221 {
222     CGImageRef image = (CGImageRef)info;
223     CGContextDrawImage(context, GraphicsContext(context).roundToDevicePixels(FloatRect(0, 0, CGImageGetWidth(image), CGImageGetHeight(image))), image);
224 }
225
226 void Image::drawPattern(GraphicsContext* ctxt, const FloatRect& tileRect, const AffineTransform& patternTransform,
227                         const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator op, const FloatRect& destRect)
228 {
229     if (!nativeImageForCurrentFrame())
230         return;
231
232     if (!patternTransform.isInvertible())
233         return;
234
235     CGContextRef context = ctxt->platformContext();
236     GraphicsContextStateSaver stateSaver(*ctxt);
237     CGContextClipToRect(context, destRect);
238     ctxt->setCompositeOperation(op);
239     CGContextTranslateCTM(context, destRect.x(), destRect.y() + destRect.height());
240     CGContextScaleCTM(context, 1, -1);
241     
242     // Compute the scaled tile size.
243     float scaledTileHeight = tileRect.height() * narrowPrecisionToFloat(patternTransform.d());
244     
245     // We have to adjust the phase to deal with the fact we're in Cartesian space now (with the bottom left corner of destRect being
246     // the origin).
247     float adjustedX = phase.x() - destRect.x() + tileRect.x() * narrowPrecisionToFloat(patternTransform.a()); // We translated the context so that destRect.x() is the origin, so subtract it out.
248     float adjustedY = destRect.height() - (phase.y() - destRect.y() + tileRect.y() * narrowPrecisionToFloat(patternTransform.d()) + scaledTileHeight);
249
250     CGImageRef tileImage = nativeImageForCurrentFrame();
251     float h = CGImageGetHeight(tileImage);
252
253     RetainPtr<CGImageRef> subImage;
254     if (tileRect.size() == size())
255         subImage = tileImage;
256     else {
257         // Copying a sub-image out of a partially-decoded image stops the decoding of the original image. It should never happen
258         // because sub-images are only used for border-image, which only renders when the image is fully decoded.
259         ASSERT(h == height());
260         subImage.adoptCF(CGImageCreateWithImageInRect(tileImage, tileRect));
261     }
262
263     // Adjust the color space.
264     subImage = Image::imageWithColorSpace(subImage.get(), styleColorSpace);
265     
266     // Leopard has an optimized call for the tiling of image patterns, but we can only use it if the image has been decoded enough that
267     // its buffer is the same size as the overall image.  Because a partially decoded CGImageRef with a smaller width or height than the
268     // overall image buffer needs to tile with "gaps", we can't use the optimized tiling call in that case.
269     // FIXME: We cannot use CGContextDrawTiledImage with scaled tiles on Leopard, because it suffers from rounding errors.  Snow Leopard is ok.
270     float scaledTileWidth = tileRect.width() * narrowPrecisionToFloat(patternTransform.a());
271     float w = CGImageGetWidth(tileImage);
272 #if __MAC_OS_X_VERSION_MIN_REQUIRED == 1050
273     if (w == size().width() && h == size().height() && scaledTileWidth == tileRect.width() && scaledTileHeight == tileRect.height())
274 #else
275     if (w == size().width() && h == size().height())
276 #endif
277         CGContextDrawTiledImage(context, FloatRect(adjustedX, adjustedY, scaledTileWidth, scaledTileHeight), subImage.get());
278     else {
279
280     // On Leopard and newer, this code now only runs for partially decoded images whose buffers do not yet match the overall size of the image.
281     static const CGPatternCallbacks patternCallbacks = { 0, drawPatternCallback, NULL };
282     CGAffineTransform matrix = CGAffineTransformMake(narrowPrecisionToCGFloat(patternTransform.a()), 0, 0, narrowPrecisionToCGFloat(patternTransform.d()), adjustedX, adjustedY);
283     matrix = CGAffineTransformConcat(matrix, CGContextGetCTM(context));
284     // The top of a partially-decoded image is drawn at the bottom of the tile. Map it to the top.
285     matrix = CGAffineTransformTranslate(matrix, 0, size().height() - h);
286     RetainPtr<CGPatternRef> pattern(AdoptCF, CGPatternCreate(subImage.get(), CGRectMake(0, 0, tileRect.width(), tileRect.height()),
287                                              matrix, tileRect.width(), tileRect.height(), 
288                                              kCGPatternTilingConstantSpacing, true, &patternCallbacks));
289     if (!pattern)
290         return;
291
292     RetainPtr<CGColorSpaceRef> patternSpace(AdoptCF, CGColorSpaceCreatePattern(0));
293     
294     CGFloat alpha = 1;
295     RetainPtr<CGColorRef> color(AdoptCF, CGColorCreateWithPattern(patternSpace.get(), pattern.get(), &alpha));
296     CGContextSetFillColorSpace(context, patternSpace.get());
297
298     // FIXME: Really want a public API for this.  It is just CGContextSetBaseCTM(context, CGAffineTransformIdentiy).
299     wkSetBaseCTM(context, CGAffineTransformIdentity);
300     CGContextSetPatternPhase(context, CGSizeZero);
301
302     CGContextSetFillColorWithColor(context, color.get());
303     CGContextFillRect(context, CGContextGetClipBoundingBox(context));
304
305     }
306
307     stateSaver.restore();
308
309     if (imageObserver())
310         imageObserver()->didDraw(this);
311 }
312
313
314 }
315
316 #endif // USE(CG)