5a708085c4190704b18f688862483b5f75878b3a
[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 should copy without
51 // invoking our constructor or destructor. This allows us to have a vector even for a struct
52 // that's not copyable.
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 : Noncopyable {
66     FrameData()
67         : m_frame(0)
68         , m_duration(0)
69         , m_hasAlpha(true) 
70     {
71     }
72
73     ~FrameData()
74     { 
75         clear();
76     }
77
78     void clear();
79
80     NativeImagePtr m_frame;
81     float m_duration;
82     bool m_hasAlpha;
83 };
84
85 // =================================================
86 // BitmapImage Class
87 // =================================================
88
89 class BitmapImage : public Image {
90     friend class GraphicsContext;
91 public:
92 #if PLATFORM(QT)
93     BitmapImage(const QPixmap &pixmap, ImageObserver* = 0);
94 #endif
95     BitmapImage(ImageObserver* = 0);
96     ~BitmapImage();
97     
98     virtual IntSize size() const;
99
100     virtual bool dataChanged(bool allDataReceived);
101
102     // It may look unusual that there is no start animation call as public API.  This is because
103     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
104     // automatically pause once all observers no longer want to render the image anywhere.
105     virtual void stopAnimation();
106     virtual void resetAnimation();
107     
108     virtual unsigned decodedSize() const { return m_decodedSize; }
109
110 #if PLATFORM(MAC)
111     // Accessors for native image formats.
112     virtual NSImage* getNSImage();
113     virtual CFDataRef getTIFFRepresentation();
114 #endif
115     
116 #if PLATFORM(CG)
117     virtual CGImageRef getCGImageRef();
118 #endif
119
120 #if PLATFORM(QT)
121     virtual QPixmap* getPixmap() const;
122 #endif
123     
124 #if PLATFORM(WIN)
125     virtual bool getHBITMAP(HBITMAP);
126 #endif
127
128     virtual NativeImagePtr nativeImageForCurrentFrame() { return frameAtIndex(currentFrame()); }
129
130 private:
131     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator);
132 #if PLATFORM(QT)
133     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
134                              const FloatPoint& phase, CompositeOperator, const FloatRect& destRect);
135 #endif    
136     size_t currentFrame() const { return m_currentFrame; }
137     size_t frameCount();
138     NativeImagePtr frameAtIndex(size_t);
139     float frameDurationAtIndex(size_t);
140     bool frameHasAlphaAtIndex(size_t); 
141
142     // Decodes and caches a frame. Never accessed except internally.
143     void cacheFrame(size_t index);
144
145     // Called to invalidate all our cached data.  If an image is loading incrementally, we only
146     // invalidate the last cached frame.
147     virtual void destroyDecodedData(bool incremental = false);
148
149     // Whether or not size is available yet.    
150     bool isSizeAvailable();
151
152     // Animation.
153     bool shouldAnimate();
154     virtual void startAnimation();
155     void advanceAnimation(Timer<BitmapImage>*);
156     
157     // Handle platform-specific data
158     void initPlatformData();
159     void invalidatePlatformData();
160     
161     // Checks to see if the image is a 1x1 solid color.  We optimize these images and just do a fill rect instead.
162     void checkForSolidColor();
163     
164     virtual bool mayFillWithSolidColor() const { return m_isSolidColor && m_currentFrame == 0; }
165     virtual Color solidColor() const { return m_solidColor; }
166     
167     ImageSource m_source;
168     mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
169     
170     size_t m_currentFrame; // The index of the current frame of animation.
171     Vector<FrameData> m_frames; // An array of the cached frames of the animation. We have to ref frames to pin them in the cache.
172     
173     Timer<BitmapImage>* m_frameTimer;
174     int m_repetitionCount; // How many total animation loops we should do.
175     int m_repetitionsComplete;  // How many repetitions we've finished.
176
177 #if PLATFORM(MAC)
178     mutable NSImage* m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one.
179     mutable CFDataRef m_tiffRep; // Cached TIFF rep for frame 0.  Only built lazily if someone queries for one.
180 #endif
181
182     Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
183     bool m_isSolidColor;  // Whether or not we are a 1x1 solid image.
184
185     bool m_animatingImageType;  // Whether or not we're an image type that is capable of animating (GIF).
186     bool m_animationFinished;  // Whether or not we've completed the entire animation.
187
188     bool m_allDataReceived;  // Whether or not we've received all our data.
189
190     mutable bool m_haveSize; // Whether or not our |m_size| member variable has the final overall image size yet.
191     bool m_sizeAvailable; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
192     unsigned m_decodedSize; // The current size of all decoded frames.
193
194 #if PLATFORM(QT)
195     QPixmap *m_pixmap;
196 #endif
197
198 };
199
200 }
201
202 #endif