Move locale information into FontDescription
[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 Ref<BitmapImage> create(PassNativeImagePtr nativeImage, ImageObserver* observer = 0)
112     {
113         return adoptRef(*new BitmapImage(nativeImage, observer));
114     }
115     static Ref<BitmapImage> create(ImageObserver* observer = 0)
116     {
117         return adoptRef(*new BitmapImage(observer));
118     }
119 #if PLATFORM(WIN)
120     WEBCORE_EXPORT static PassRefPtr<BitmapImage> create(HBITMAP);
121 #endif
122     virtual ~BitmapImage();
123     
124     virtual bool hasSingleSecurityOrigin() const override;
125
126     // FloatSize due to override.
127     virtual FloatSize size() const override;
128     IntSize sizeRespectingOrientation(ImageOrientationDescription = ImageOrientationDescription()) const;
129
130     virtual bool getHotSpot(IntPoint&) const override;
131
132     unsigned decodedSize() const { return m_decodedSize; }
133
134     virtual bool dataChanged(bool allDataReceived) override;
135     virtual String filenameExtension() const override;
136
137     // It may look unusual that there is no start animation call as public API. This is because
138     // we start and stop animating lazily. Animation begins whenever someone draws the image. It will
139     // automatically pause once all observers no longer want to render the image anywhere.
140     virtual void stopAnimation() override;
141     virtual void resetAnimation() override;
142
143     virtual void drawPattern(GraphicsContext&, const FloatRect& srcRect, const AffineTransform& patternTransform,
144         const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, const FloatRect& destRect, BlendMode = BlendModeNormal) override;
145
146     // Accessors for native image formats.
147
148 #if USE(APPKIT)
149     virtual NSImage* getNSImage() override;
150 #endif
151
152 #if PLATFORM(COCOA)
153     virtual CFDataRef getTIFFRepresentation() override;
154 #endif
155
156 #if USE(CG)
157     WEBCORE_EXPORT virtual CGImageRef getCGImageRef() override;
158     virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&) override;
159     virtual RetainPtr<CFArrayRef> getCGImageArray() override;
160 #endif
161
162 #if PLATFORM(WIN)
163     virtual bool getHBITMAP(HBITMAP) override;
164     virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
165 #endif
166
167 #if PLATFORM(GTK)
168     virtual GdkPixbuf* getGdkPixbuf() override;
169 #endif
170
171 #if PLATFORM(EFL)
172     virtual Evas_Object* getEvasObject(Evas*) override;
173 #endif
174
175     virtual PassNativeImagePtr nativeImageForCurrentFrame() override;
176     virtual ImageOrientation orientationForCurrentFrame() override { return frameOrientationAtIndex(currentFrame()); }
177
178     virtual bool currentFrameKnownToBeOpaque() override;
179
180     virtual bool isAnimated() const override { return m_frameCount > 1; }
181     
182     bool canAnimate();
183
184     bool allowSubsampling() const { return m_allowSubsampling; }
185     void setAllowSubsampling(bool allowSubsampling) { m_allowSubsampling = allowSubsampling; }
186     
187 private:
188     virtual bool isBitmapImage() const override { return true; }
189
190     void updateSize(ImageOrientationDescription = ImageOrientationDescription()) const;
191     void determineMinimumSubsamplingLevel() const;
192
193 protected:
194     enum RepetitionCountStatus {
195       Unknown,    // We haven't checked the source's repetition count.
196       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).
197       Certain     // The repetition count is known to be correct.
198     };
199
200     WEBCORE_EXPORT BitmapImage(PassNativeImagePtr, ImageObserver* = 0);
201     WEBCORE_EXPORT BitmapImage(ImageObserver* = 0);
202
203 #if PLATFORM(WIN)
204     virtual void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) override;
205 #endif
206     virtual void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, ImageOrientationDescription) override;
207
208 #if USE(WINGDI)
209     virtual void drawPattern(GraphicsContext&, const FloatRect& srcRect, const AffineTransform& patternTransform,
210         const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, const FloatRect& destRect);
211 #endif
212
213     size_t currentFrame() const { return m_currentFrame; }
214     size_t frameCount();
215
216     PassNativeImagePtr frameAtIndex(size_t, float presentationScaleHint = 1);
217     PassNativeImagePtr copyUnscaledFrameAtIndex(size_t);
218
219     bool haveFrameAtIndex(size_t);
220
221     bool frameIsCompleteAtIndex(size_t);
222     float frameDurationAtIndex(size_t);
223     bool frameHasAlphaAtIndex(size_t);
224     ImageOrientation frameOrientationAtIndex(size_t);
225
226     // Decodes and caches a frame. Never accessed except internally.
227     enum ImageFrameCaching { CacheMetadataOnly, CacheMetadataAndFrame };
228     void cacheFrame(size_t index, SubsamplingLevel, ImageFrameCaching = CacheMetadataAndFrame);
229
230     // Called before accessing m_frames[index] for info without decoding. Returns false on index out of bounds.
231     bool ensureFrameIsCached(size_t index, ImageFrameCaching = CacheMetadataAndFrame);
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) override;
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     enum class ClearedSource { No, Yes };
249     void destroyMetadataAndNotify(unsigned frameBytesCleared, ClearedSource);
250
251     // Whether or not size is available yet.
252     bool isSizeAvailable();
253
254     // Called after asking the source for any information that may require
255     // decoding part of the image (e.g., the image size). We need to report
256     // the partially decoded data to our observer so it has an accurate
257     // account of the BitmapImage's memory usage.
258     void didDecodeProperties() const;
259
260     // Animation.
261     int repetitionCount(bool imageKnownToBeComplete);  // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded.
262     bool shouldAnimate();
263     virtual void startAnimation(CatchUpAnimation = CatchUp) override;
264     void advanceAnimation();
265
266     // Function that does the real work of advancing the animation. When
267     // skippingFrames is true, we're in the middle of a loop trying to skip over
268     // a bunch of animation frames, so we should not do things like decode each
269     // one or notify our observers.
270     // Returns whether the animation was advanced.
271     enum AnimationAdvancement { Normal, SkippingFramesToCatchUp };
272     bool internalAdvanceAnimation(AnimationAdvancement = Normal);
273
274     // Handle platform-specific data
275     void invalidatePlatformData();
276
277     // Checks to see if the image is a 1x1 solid color. We optimize these images and just do a fill rect instead.
278     // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have
279     // changed.
280     void checkForSolidColor();
281
282     virtual bool mayFillWithSolidColor() override;
283     virtual Color solidColor() const override;
284
285 #if !ASSERT_DISABLED
286     virtual bool notSolidColor() override;
287 #endif
288
289 private:
290     virtual bool decodedDataIsPurgeable() const override;
291     void clearTimer();
292     void startTimer(double delay);
293
294     virtual void dump(TextStream&) const override;
295
296     ImageSource m_source;
297     mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
298     mutable IntSize m_sizeRespectingOrientation;
299
300     mutable SubsamplingLevel m_minimumSubsamplingLevel;
301
302     mutable unsigned m_imageOrientation : 4; // ImageOrientationEnum
303     mutable unsigned m_shouldRespectImageOrientation : 1; // RespectImageOrientationEnum
304
305     size_t m_currentFrame; // The index of the current frame of animation.
306     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.
307
308     std::unique_ptr<Timer> m_frameTimer;
309     int m_repetitionCount; // How many total animation loops we should do. This will be cAnimationNone if this image type is incapable of animation.
310     RepetitionCountStatus m_repetitionCountStatus;
311     int m_repetitionsComplete;  // How many repetitions we've finished.
312     double m_desiredFrameStartTime;  // The system time at which we hope to see the next call to startAnimation().
313
314 #if USE(APPKIT)
315     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one.
316 #endif
317 #if USE(CG)
318     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for frame 0. Only built lazily if someone queries for one.
319 #endif
320
321     Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
322
323     unsigned m_decodedSize; // The current size of all decoded frames.
324     mutable unsigned m_decodedPropertiesSize; // The size of data decoded by the source to determine image properties (e.g. size, frame count, etc).
325     size_t m_frameCount;
326
327 #if PLATFORM(IOS)
328     // FIXME: We should expose a setting to enable/disable progressive loading remove the PLATFORM(IOS)-guard.
329     double m_progressiveLoadChunkTime;
330     uint16_t m_progressiveLoadChunkCount;
331 #endif
332
333     bool m_allowSubsampling : 1; // Whether we should attempt subsampling if this image is very large.
334     bool m_isSolidColor : 1; // Whether or not we are a 1x1 solid image.
335     bool m_checkedForSolidColor : 1; // Whether we've checked the frame for solid color.
336
337     bool m_animationFinished : 1; // Whether or not we've completed the entire animation.
338
339     bool m_allDataReceived : 1; // Whether or not we've received all our data.
340     mutable bool m_haveSize : 1; // Whether or not our |m_size| member variable has the final overall image size yet.
341     bool m_sizeAvailable : 1; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
342     mutable bool m_hasUniformFrameSize : 1;
343     mutable bool m_haveFrameCount : 1;
344     bool m_animationFinishedWhenCatchingUp : 1;
345
346     RefPtr<Image> m_cachedImage;
347 };
348
349 } // namespace WebCore
350
351 SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)
352
353 #endif // BitmapImage_h