Extend platform layer so it can pass blend modes to the compositing calls
[WebKit-https.git] / Source / WebCore / platform / graphics / BitmapImage.h
1 /*
2  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
3  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
4  * Copyright (C) 2008-2009 Torch Mobile, Inc.
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 COMPUTER, 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 COMPUTER, 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 #ifndef BitmapImage_h
29 #define BitmapImage_h
30
31 #include "Image.h"
32 #include "Color.h"
33 #include "ImageOrientation.h"
34 #include "ImageSource.h"
35 #include "IntSize.h"
36
37 #if PLATFORM(MAC)
38 #include <wtf/RetainPtr.h>
39 OBJC_CLASS NSImage;
40 #endif
41
42 #if PLATFORM(WIN)
43 typedef struct HBITMAP__ *HBITMAP;
44 #endif
45
46 #if PLATFORM(WX)
47 class wxBitmap;
48 #endif
49
50 namespace WebCore {
51     struct FrameData;
52 }
53
54 namespace WTF {
55     template<> struct VectorTraits<WebCore::FrameData> : public SimpleClassVectorTraits {
56         static const bool canInitializeWithMemset = false; // Not all FrameData members initialize to 0.
57     };
58 }
59
60 namespace WebCore {
61
62 template <typename T> class Timer;
63
64 // ================================================
65 // FrameData Class
66 // ================================================
67
68 struct FrameData {
69     WTF_MAKE_NONCOPYABLE(FrameData);
70 public:
71     FrameData()
72         : m_frame(0)
73         , m_orientation(DefaultImageOrientation)
74         , m_duration(0)
75         , m_haveMetadata(false)
76         , m_isComplete(false)
77         , m_hasAlpha(true) 
78         , m_frameBytes(0)
79     {
80     }
81
82     ~FrameData()
83     { 
84         clear(true);
85     }
86
87     // Clear the cached image data on the frame, and (optionally) the metadata.
88     // Returns whether there was cached image data to clear.
89     bool clear(bool clearMetadata);
90
91     void reportMemoryUsage(MemoryObjectInfo*) const;
92
93     NativeImagePtr m_frame;
94     ImageOrientation m_orientation;
95     float m_duration;
96     bool m_haveMetadata : 1;
97     bool m_isComplete : 1;
98     bool m_hasAlpha : 1;
99     unsigned m_frameBytes;
100 };
101
102 // =================================================
103 // BitmapImage Class
104 // =================================================
105
106 class BitmapImage : public Image {
107     friend class GeneratedImage;
108     friend class CrossfadeGeneratedImage;
109     friend class GeneratorGeneratedImage;
110     friend class GraphicsContext;
111 public:
112     static PassRefPtr<BitmapImage> create(NativeImagePtr nativeImage, ImageObserver* observer = 0)
113     {
114         return adoptRef(new BitmapImage(nativeImage, observer));
115     }
116     static PassRefPtr<BitmapImage> create(ImageObserver* observer = 0)
117     {
118         return adoptRef(new BitmapImage(observer));
119     }
120     virtual ~BitmapImage();
121     
122     virtual bool isBitmapImage() const;
123
124     virtual bool hasSingleSecurityOrigin() const;
125
126     virtual IntSize size() const;
127     IntSize sizeRespectingOrientation() const;
128     IntSize currentFrameSize() const;
129     virtual bool getHotSpot(IntPoint&) const;
130
131     virtual bool dataChanged(bool allDataReceived);
132     virtual String filenameExtension() const; 
133
134     // It may look unusual that there is no start animation call as public API.  This is because
135     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
136     // automatically pause once all observers no longer want to render the image anywhere.
137     virtual void stopAnimation();
138     virtual void resetAnimation();
139
140     virtual unsigned decodedSize() const;
141
142 #if PLATFORM(MAC)
143     // Accessors for native image formats.
144     virtual NSImage* getNSImage();
145     virtual CFDataRef getTIFFRepresentation();
146 #endif
147     
148 #if USE(CG)
149     virtual CGImageRef getCGImageRef();
150     virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&);
151     virtual RetainPtr<CFArrayRef> getCGImageArray();
152 #endif
153
154 #if PLATFORM(WIN) || (PLATFORM(QT) && OS(WINDOWS))
155     static PassRefPtr<BitmapImage> create(HBITMAP);
156 #endif
157 #if PLATFORM(WX)
158     static PassRefPtr<BitmapImage> create(const wxBitmap& bitmap)
159     {
160         return adoptRef(new BitmapImage(bitmap));
161     }
162 #endif
163 #if PLATFORM(WIN)
164     virtual bool getHBITMAP(HBITMAP);
165     virtual bool getHBITMAPOfSize(HBITMAP, LPSIZE);
166 #endif
167
168 #if USE(CAIRO)
169     static PassRefPtr<BitmapImage> create(cairo_surface_t*);
170 #endif
171
172 #if PLATFORM(GTK)
173     virtual GdkPixbuf* getGdkPixbuf();
174 #endif
175
176 #if PLATFORM(EFL)
177     virtual Evas_Object* getEvasObject(Evas*);
178 #endif
179
180     virtual NativeImagePtr nativeImageForCurrentFrame();
181     virtual bool currentFrameHasAlpha();
182
183     ImageOrientation currentFrameOrientation();
184
185 #if !ASSERT_DISABLED
186     virtual bool notSolidColor();
187 #endif
188
189     void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
190
191 private:
192     void updateSize() const;
193
194 protected:
195     enum RepetitionCountStatus {
196       Unknown,    // We haven't checked the source's repetition count.
197       Uncertain,  // We have a repetition count, but it might be wrong (some GIFs have a count after the image data, and will report "loop once" until all data has been decoded).
198       Certain     // The repetition count is known to be correct.
199     };
200
201     BitmapImage(NativeImagePtr, ImageObserver* = 0);
202     BitmapImage(ImageObserver* = 0);
203 #if PLATFORM(WX)
204     BitmapImage(const wxBitmap&);
205 #endif
206
207 #if PLATFORM(WIN)
208     virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator);
209 #endif
210     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator, BlendMode);
211 #if USE(CG) || PLATFORM(CHROMIUM) || USE(CAIRO)
212     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator, BlendMode, RespectImageOrientationEnum) OVERRIDE;
213 #endif
214
215 #if (OS(WINCE) && !PLATFORM(QT))
216     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
217                              const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
218 #endif
219
220     size_t currentFrame() const { return m_currentFrame; }
221     virtual size_t frameCount();
222     NativeImagePtr frameAtIndex(size_t);
223     bool frameIsCompleteAtIndex(size_t);
224     float frameDurationAtIndex(size_t);
225     bool frameHasAlphaAtIndex(size_t);
226     ImageOrientation frameOrientationAtIndex(size_t);
227
228     // Decodes and caches a frame. Never accessed except internally.
229     void cacheFrame(size_t index);
230     // Called before accessing m_frames[index]. Returns false on index out of bounds.
231     bool ensureFrameIsCached(size_t index);
232
233     // Called to invalidate cached data.  When |destroyAll| is true, we wipe out
234     // the entire frame buffer cache and tell the image source to destroy
235     // everything; this is used when e.g. we want to free some room in the image
236     // cache.  If |destroyAll| is false, we only delete frames up to the current
237     // one; this is used while animating large images to keep memory footprint
238     // low without redecoding the whole image on every frame.
239     virtual void destroyDecodedData(bool destroyAll = true);
240
241     // If the image is large enough, calls destroyDecodedData() and passes
242     // |destroyAll| along.
243     void destroyDecodedDataIfNecessary(bool destroyAll);
244
245     // Generally called by destroyDecodedData(), destroys whole-image metadata
246     // and notifies observers that the memory footprint has (hopefully)
247     // decreased by |frameBytesCleared|.
248     void destroyMetadataAndNotify(unsigned frameBytesCleared);
249
250     // Whether or not size is available yet.    
251     bool isSizeAvailable();
252
253     // Called after asking the source for any information that may require
254     // decoding part of the image (e.g., the image size).  We need to report
255     // the partially decoded data to our observer so it has an accurate
256     // account of the BitmapImage's memory usage.
257     void didDecodeProperties() const;
258
259     // Animation.
260     int repetitionCount(bool imageKnownToBeComplete);  // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded.
261     bool shouldAnimate();
262     virtual void startAnimation(bool catchUpIfNecessary = true);
263     void advanceAnimation(Timer<BitmapImage>*);
264
265     // Function that does the real work of advancing the animation.  When
266     // skippingFrames is true, we're in the middle of a loop trying to skip over
267     // a bunch of animation frames, so we should not do things like decode each
268     // one or notify our observers.
269     // Returns whether the animation was advanced.
270     bool internalAdvanceAnimation(bool skippingFrames);
271
272     // Handle platform-specific data
273     void invalidatePlatformData();
274     
275     // Checks to see if the image is a 1x1 solid color.  We optimize these images and just do a fill rect instead.
276     // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have
277     // changed.
278     void checkForSolidColor();
279     
280     virtual bool mayFillWithSolidColor();
281     virtual Color solidColor() const;
282     
283     ImageSource m_source;
284     mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
285     mutable IntSize m_sizeRespectingOrientation;
286     
287     size_t m_currentFrame; // The index of the current frame of animation.
288     Vector<FrameData, 1> m_frames; // An array of the cached frames of the animation. We have to ref frames to pin them in the cache.
289
290     Timer<BitmapImage>* m_frameTimer;
291     int m_repetitionCount; // How many total animation loops we should do.  This will be cAnimationNone if this image type is incapable of animation.
292     RepetitionCountStatus m_repetitionCountStatus;
293     int m_repetitionsComplete;  // How many repetitions we've finished.
294     double m_desiredFrameStartTime;  // The system time at which we hope to see the next call to startAnimation().
295
296 #if PLATFORM(MAC)
297     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one.
298     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for frame 0.  Only built lazily if someone queries for one.
299 #endif
300
301     Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
302
303     unsigned m_decodedSize; // The current size of all decoded frames.
304     mutable unsigned m_decodedPropertiesSize; // The size of data decoded by the source to determine image properties (e.g. size, frame count, etc).
305     size_t m_frameCount;
306
307     bool m_isSolidColor : 1; // Whether or not we are a 1x1 solid image.
308     bool m_checkedForSolidColor : 1; // Whether we've checked the frame for solid color.
309
310     bool m_animationFinished : 1; // Whether or not we've completed the entire animation.
311
312     bool m_allDataReceived : 1; // Whether or not we've received all our data.
313     mutable bool m_haveSize : 1; // Whether or not our |m_size| member variable has the final overall image size yet.
314     bool m_sizeAvailable : 1; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
315     mutable bool m_hasUniformFrameSize : 1;
316     mutable bool m_haveFrameCount : 1;
317 };
318
319 }
320
321 #endif