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