32712be62d6be0179139fc0ff1c4b6059bb2f550
[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, 2013 Apple 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 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 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 USE(CG) || USE(APPKIT)
38 #include <wtf/RetainPtr.h>
39 #endif
40
41 #if USE(APPKIT)
42 OBJC_CLASS NSImage;
43 #endif
44
45 #if PLATFORM(WIN)
46 typedef struct HBITMAP__ *HBITMAP;
47 #endif
48
49 namespace WebCore {
50     struct FrameData;
51 }
52
53 namespace WTF {
54     template<> struct VectorTraits<WebCore::FrameData> : public SimpleClassVectorTraits {
55         static const bool canInitializeWithMemset = false; // Not all FrameData members initialize to 0.
56     };
57 }
58
59 namespace WebCore {
60
61 class Timer;
62
63 // ================================================
64 // FrameData Class
65 // ================================================
66
67 struct FrameData {
68     WTF_MAKE_NONCOPYABLE(FrameData);
69 public:
70     FrameData()
71         : m_frame(0)
72         , m_orientation(DefaultImageOrientation)
73         , m_subsamplingLevel(0)
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     NativeImagePtr m_frame;
92     ImageOrientation m_orientation;
93     SubsamplingLevel m_subsamplingLevel;
94     float m_duration;
95     bool m_haveMetadata : 1;
96     bool m_isComplete : 1;
97     bool m_hasAlpha : 1;
98     unsigned m_frameBytes;
99 };
100
101 // =================================================
102 // BitmapImage Class
103 // =================================================
104
105 class BitmapImage final : public Image {
106     friend class GeneratedImage;
107     friend class CrossfadeGeneratedImage;
108     friend class GradientImage;
109     friend class GraphicsContext;
110 public:
111     static PassRefPtr<BitmapImage> create(PassNativeImagePtr nativeImage, ImageObserver* observer = 0)
112     {
113         return adoptRef(new BitmapImage(nativeImage, observer));
114     }
115     static PassRefPtr<BitmapImage> create(ImageObserver* observer = 0)
116     {
117         return adoptRef(new BitmapImage(observer));
118     }
119 #if PLATFORM(WIN)
120     static PassRefPtr<BitmapImage> create(HBITMAP);
121 #endif
122     virtual ~BitmapImage();
123     
124     virtual bool isBitmapImage() const override { return true; }
125
126     virtual bool hasSingleSecurityOrigin() const override;
127
128     // FloatSize due to override.
129     virtual FloatSize size() const override;
130     IntSize sizeRespectingOrientation(ImageOrientationDescription = ImageOrientationDescription()) const;
131
132     virtual bool getHotSpot(IntPoint&) const override;
133
134     unsigned decodedSize() const { return m_decodedSize; }
135
136     virtual bool dataChanged(bool allDataReceived) override;
137     virtual String filenameExtension() const override;
138
139     // It may look unusual that there is no start animation call as public API.  This is because
140     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
141     // automatically pause once all observers no longer want to render the image anywhere.
142     virtual void stopAnimation() override;
143     virtual void resetAnimation() override;
144
145     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
146         const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect, BlendMode = BlendModeNormal) override;
147
148     // Accessors for native image formats.
149
150 #if USE(APPKIT)
151     virtual NSImage* getNSImage() override;
152 #endif
153
154 #if PLATFORM(COCOA)
155     virtual CFDataRef getTIFFRepresentation() override;
156 #endif
157
158 #if USE(CG)
159     WEBCORE_EXPORT virtual CGImageRef getCGImageRef() override;
160     virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&) override;
161     virtual RetainPtr<CFArrayRef> getCGImageArray() override;
162 #endif
163
164 #if PLATFORM(WIN)
165     virtual bool getHBITMAP(HBITMAP) override;
166     virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
167 #endif
168
169 #if PLATFORM(GTK)
170     virtual GdkPixbuf* getGdkPixbuf() override;
171 #endif
172
173 #if PLATFORM(EFL)
174     virtual Evas_Object* getEvasObject(Evas*) override;
175 #endif
176
177     virtual PassNativeImagePtr nativeImageForCurrentFrame() override;
178     virtual ImageOrientation orientationForCurrentFrame() override { return frameOrientationAtIndex(currentFrame()); }
179
180     virtual bool currentFrameKnownToBeOpaque() override;
181     
182     bool canAnimate();
183
184     bool allowSubsampling() const { return m_allowSubsampling; }
185     void setAllowSubsampling(bool allowSubsampling) { m_allowSubsampling = allowSubsampling; }
186     
187 private:
188     void updateSize(ImageOrientationDescription = ImageOrientationDescription()) const;
189     void determineMinimumSubsamplingLevel() const;
190
191 protected:
192     enum RepetitionCountStatus {
193       Unknown,    // We haven't checked the source's repetition count.
194       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).
195       Certain     // The repetition count is known to be correct.
196     };
197
198     WEBCORE_EXPORT BitmapImage(PassNativeImagePtr, ImageObserver* = 0);
199     WEBCORE_EXPORT BitmapImage(ImageObserver* = 0);
200
201 #if PLATFORM(WIN)
202     virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator) override;
203 #endif
204     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator, BlendMode, ImageOrientationDescription) override;
205
206 #if USE(WINGDI)
207     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
208         const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
209 #endif
210
211     size_t currentFrame() const { return m_currentFrame; }
212     size_t frameCount();
213
214     PassNativeImagePtr frameAtIndex(size_t, float presentationScaleHint = 1);
215     PassNativeImagePtr copyUnscaledFrameAtIndex(size_t);
216
217     bool haveFrameAtIndex(size_t);
218
219     bool frameIsCompleteAtIndex(size_t);
220     float frameDurationAtIndex(size_t);
221     bool frameHasAlphaAtIndex(size_t);
222     ImageOrientation frameOrientationAtIndex(size_t);
223
224     // Decodes and caches a frame. Never accessed except internally.
225     enum ImageFrameCaching { CacheMetadataOnly, CacheMetadataAndFrame };
226     void cacheFrame(size_t index, SubsamplingLevel, ImageFrameCaching = CacheMetadataAndFrame);
227
228     // Called before accessing m_frames[index] for info without decoding. Returns false on index out of bounds.
229     bool ensureFrameIsCached(size_t index, ImageFrameCaching = CacheMetadataAndFrame);
230
231     // Called to invalidate cached data.  When |destroyAll| is true, we wipe out
232     // the entire frame buffer cache and tell the image source to destroy
233     // everything; this is used when e.g. we want to free some room in the image
234     // cache.  If |destroyAll| is false, we only delete frames up to the current
235     // one; this is used while animating large images to keep memory footprint
236     // low without redecoding the whole image on every frame.
237     virtual void destroyDecodedData(bool destroyAll = true) override;
238
239     // If the image is large enough, calls destroyDecodedData() and passes
240     // |destroyAll| along.
241     void destroyDecodedDataIfNecessary(bool destroyAll);
242
243     // Generally called by destroyDecodedData(), destroys whole-image metadata
244     // and notifies observers that the memory footprint has (hopefully)
245     // decreased by |frameBytesCleared|.
246     void destroyMetadataAndNotify(unsigned frameBytesCleared);
247
248     // Whether or not size is available yet.
249     bool isSizeAvailable();
250
251     // Called after asking the source for any information that may require
252     // decoding part of the image (e.g., the image size).  We need to report
253     // the partially decoded data to our observer so it has an accurate
254     // account of the BitmapImage's memory usage.
255     void didDecodeProperties() const;
256
257     // Animation.
258     int repetitionCount(bool imageKnownToBeComplete);  // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded.
259     bool shouldAnimate();
260     virtual void startAnimation(CatchUpAnimation = CatchUp) override;
261     void advanceAnimation(Timer&);
262
263     // Function that does the real work of advancing the animation.  When
264     // skippingFrames is true, we're in the middle of a loop trying to skip over
265     // a bunch of animation frames, so we should not do things like decode each
266     // one or notify our observers.
267     // Returns whether the animation was advanced.
268     bool internalAdvanceAnimation(bool skippingFrames);
269
270     // Handle platform-specific data
271     void invalidatePlatformData();
272
273     // Checks to see if the image is a 1x1 solid color.  We optimize these images and just do a fill rect instead.
274     // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have
275     // changed.
276     void checkForSolidColor();
277
278     virtual bool mayFillWithSolidColor() override;
279     virtual Color solidColor() const override;
280
281 #if !ASSERT_DISABLED
282     virtual bool notSolidColor() override;
283 #endif
284
285 private:
286     virtual bool decodedDataIsPurgeable() const override;
287
288     ImageSource m_source;
289     mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
290     mutable IntSize m_sizeRespectingOrientation;
291
292     mutable SubsamplingLevel m_minimumSubsamplingLevel;
293
294     mutable unsigned m_imageOrientation : 4; // ImageOrientationEnum
295     mutable unsigned m_shouldRespectImageOrientation : 1; // RespectImageOrientationEnum
296
297     size_t m_currentFrame; // The index of the current frame of animation.
298     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.
299
300     std::unique_ptr<Timer> m_frameTimer;
301     int m_repetitionCount; // How many total animation loops we should do.  This will be cAnimationNone if this image type is incapable of animation.
302     RepetitionCountStatus m_repetitionCountStatus;
303     int m_repetitionsComplete;  // How many repetitions we've finished.
304     double m_desiredFrameStartTime;  // The system time at which we hope to see the next call to startAnimation().
305
306 #if USE(APPKIT)
307     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one.
308 #endif
309 #if USE(CG)
310     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for frame 0.  Only built lazily if someone queries for one.
311 #endif
312
313     Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
314
315     unsigned m_decodedSize; // The current size of all decoded frames.
316     mutable unsigned m_decodedPropertiesSize; // The size of data decoded by the source to determine image properties (e.g. size, frame count, etc).
317     size_t m_frameCount;
318
319 #if PLATFORM(IOS)
320     // FIXME: We should expose a setting to enable/disable progressive loading remove the PLATFORM(IOS)-guard.
321     double m_progressiveLoadChunkTime;
322     uint16_t m_progressiveLoadChunkCount;
323 #endif
324
325     bool m_allowSubsampling : 1; // Whether we should attempt subsampling if this image is very large.
326     bool m_isSolidColor : 1; // Whether or not we are a 1x1 solid image.
327     bool m_checkedForSolidColor : 1; // Whether we've checked the frame for solid color.
328
329     bool m_animationFinished : 1; // Whether or not we've completed the entire animation.
330
331     bool m_allDataReceived : 1; // Whether or not we've received all our data.
332     mutable bool m_haveSize : 1; // Whether or not our |m_size| member variable has the final overall image size yet.
333     bool m_sizeAvailable : 1; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
334     mutable bool m_hasUniformFrameSize : 1;
335     mutable bool m_haveFrameCount : 1;
336
337     RefPtr<Image> m_cachedImage;
338 };
339
340 } // namespace WebCore
341
342 SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)
343
344 #endif // BitmapImage_h