337a61052e30ff6433fae1aa70d17ea548e3becb
[WebKit-https.git] / 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  *
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 COMPUTER, 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 COMPUTER, 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 #ifndef BitmapImage_h
28 #define BitmapImage_h
29
30 #include "Image.h"
31 #include "Color.h"
32 #include "IntSize.h"
33
34 #if PLATFORM(MAC)
35 #ifdef __OBJC__
36 @class NSImage;
37 #else
38 class NSImage;
39 #endif
40 #endif
41
42 #if PLATFORM(WIN)
43 typedef struct HBITMAP__ *HBITMAP;
44 #endif
45
46 namespace WebCore {
47     struct FrameData;
48 }
49
50 // This complicated-looking declaration tells the framedata Vector that it can copy without
51 // having to invoke our copy constructor. This allows us to not have to worry about ref counting
52 // the native frames.
53 namespace WTF { 
54     template<> class VectorTraits<WebCore::FrameData> : public SimpleClassVectorTraits {};
55 }
56
57 namespace WebCore {
58
59 template <typename T> class Timer;
60
61 // ================================================
62 // FrameData Class
63 // ================================================
64
65 struct FrameData {
66     FrameData()
67         : m_frame(0)
68         , m_duration(0)
69         , m_hasAlpha(true) 
70     {}
71
72     ~FrameData()
73     { 
74         clear();
75     }
76
77     void clear();
78
79     NativeImagePtr m_frame;
80     float m_duration;
81     bool m_hasAlpha;
82 };
83
84 // =================================================
85 // BitmapImage Class
86 // =================================================
87
88 class BitmapImage : public Image {
89     friend class GraphicsContext;
90 public:
91     BitmapImage(ImageAnimationObserver* observer = 0);
92     ~BitmapImage();
93     
94     virtual IntSize size() const;
95
96     virtual bool setNativeData(NativeBytePtr, bool allDataReceived);
97
98     // It may look unusual that there is no start animation call as public API.  This is because
99     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
100     // automatically pause once all observers no longer want to render the image anywhere.
101     virtual void stopAnimation();
102     virtual void resetAnimation();
103     
104 #if PLATFORM(MAC)
105     // Accessors for native image formats.
106     virtual NSImage* getNSImage();
107     virtual CFDataRef getTIFFRepresentation();
108 #endif
109     
110 #if PLATFORM(CG)
111     virtual CGImageRef getCGImageRef();
112 #endif
113     
114 #if PLATFORM(WIN)
115     virtual bool getHBITMAP(HBITMAP);
116 #endif
117
118     NativeImagePtr nativeImageForCurrentFrame() { return frameAtIndex(currentFrame()); }
119
120 private:
121     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator);
122     virtual void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, CompositeOperator);
123     virtual void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, TileRule hRule, TileRule vRule, CompositeOperator); 
124     
125     size_t currentFrame() const { return m_currentFrame; }
126     size_t frameCount();
127     NativeImagePtr frameAtIndex(size_t);
128     float frameDurationAtIndex(size_t);
129     bool frameHasAlphaAtIndex(size_t); 
130
131     // Decodes and caches a frame. Never accessed except internally.
132     void cacheFrame(size_t index);
133
134     // Called to invalidate all our cached data when more bytes are available.
135     void invalidateData();
136
137     // Whether or not size is available yet.    
138     bool isSizeAvailable();
139
140     // Animation.
141     bool shouldAnimate();
142     void startAnimation();
143     void advanceAnimation(Timer<BitmapImage>*);
144     
145     // Handle platform-specific data
146     void initPlatformData();
147     void invalidatePlatformData();
148
149     // Checks to see if the image is a 1x1 solid color.  We optimize these images and just do a fill rect instead.
150     void checkForSolidColor();
151     
152     bool mayFillWithSolidColor() const { return m_isSolidColor && m_currentFrame == 0; }
153     Color solidColor() const { return m_solidColor; }
154     
155     ImageSource m_source;
156     mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
157     
158     size_t m_currentFrame; // The index of the current frame of animation.
159     Vector<FrameData> m_frames; // An array of the cached frames of the animation. We have to ref frames to pin them in the cache.
160     
161     Timer<BitmapImage>* m_frameTimer;
162     int m_repetitionCount; // How many total animation loops we should do.
163     int m_repetitionsComplete;  // How many repetitions we've finished.
164
165 #if PLATFORM(MAC)
166     mutable NSImage* m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one.
167     mutable CFDataRef m_tiffRep; // Cached TIFF rep for frame 0.  Only built lazily if someone queries for one.
168 #endif
169
170     Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
171     bool m_isSolidColor;  // Whether or not we are a 1x1 solid image.
172
173     bool m_animatingImageType;  // Whether or not we're an image type that is capable of animating (GIF).
174     bool m_animationFinished;  // Whether or not we've completed the entire animation.
175
176     mutable bool m_haveSize; // Whether or not our |m_size| member variable has the final overall image size yet.
177     bool m_sizeAvailable; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
178 };
179
180 }
181
182 #endif