1/*
2 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
3 * Copyright (C) 2004, 2005, 2006 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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 "platform/geometry/IntSize.h"
32#include "platform/graphics/Color.h"
33#include "platform/graphics/FrameData.h"
34#include "platform/graphics/Image.h"
35#include "platform/graphics/ImageOrientation.h"
36#include "platform/graphics/ImageSource.h"
37#include "wtf/Forward.h"
38
39namespace blink {
40
41class NativeImageSkia;
42template <typename T> class Timer;
43
44class PLATFORM_EXPORT BitmapImage : public Image {
45    friend class GeneratedImage;
46    friend class CrossfadeGeneratedImage;
47    friend class GradientGeneratedImage;
48    friend class GraphicsContext;
49public:
50    static PassRefPtr<BitmapImage> create(PassRefPtr<NativeImageSkia>, ImageObserver* = 0);
51
52    static PassRefPtr<BitmapImage> create(ImageObserver* observer = 0)
53    {
54        return adoptRef(new BitmapImage(observer));
55    }
56
57    virtual ~BitmapImage();
58
59    virtual bool isBitmapImage() const OVERRIDE;
60
61    virtual bool currentFrameHasSingleSecurityOrigin() const OVERRIDE;
62
63    virtual IntSize size() const OVERRIDE;
64    IntSize sizeRespectingOrientation() const;
65    virtual bool getHotSpot(IntPoint&) const OVERRIDE;
66    virtual String filenameExtension() const OVERRIDE;
67    virtual bool dataChanged(bool allDataReceived) OVERRIDE;
68
69    bool isAllDataReceived() const { return m_allDataReceived; }
70    bool hasColorProfile() const;
71    void resetDecoder();
72
73    // It may look unusual that there's no start animation call as public API.
74    // This because we start and stop animating lazily. Animation starts when
75    // the image is rendered, and automatically pauses once all observers no
76    // longer want to render the image.
77    virtual void stopAnimation() OVERRIDE;
78    virtual void resetAnimation() OVERRIDE;
79    virtual bool maybeAnimated() OVERRIDE;
80
81    virtual PassRefPtr<NativeImageSkia> nativeImageForCurrentFrame() OVERRIDE;
82    virtual PassRefPtr<Image> imageForDefaultFrame() OVERRIDE;
83    virtual bool currentFrameKnownToBeOpaque() OVERRIDE;
84    ImageOrientation currentFrameOrientation();
85
86#if ENABLE(ASSERT)
87    virtual bool notSolidColor() OVERRIDE;
88#endif
89
90private:
91    friend class BitmapImageTest;
92
93    void updateSize() const;
94
95protected:
96    enum RepetitionCountStatus {
97      Unknown,    // We haven't checked the source's repetition count.
98      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).
99      Certain     // The repetition count is known to be correct.
100    };
101
102    BitmapImage(PassRefPtr<NativeImageSkia>, ImageObserver* = 0);
103    BitmapImage(ImageObserver* = 0);
104
105    virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, WebBlendMode) OVERRIDE;
106    virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, WebBlendMode, RespectImageOrientationEnum) OVERRIDE;
107
108    size_t currentFrame() const { return m_currentFrame; }
109    size_t frameCount();
110
111    PassRefPtr<NativeImageSkia> frameAtIndex(size_t);
112
113    bool frameIsCompleteAtIndex(size_t);
114    float frameDurationAtIndex(size_t);
115    bool frameHasAlphaAtIndex(size_t);
116    ImageOrientation frameOrientationAtIndex(size_t);
117
118    // Decodes and caches a frame. Never accessed except internally.
119    void cacheFrame(size_t index);
120
121    // Called before accessing m_frames[index]. Returns false on index out of bounds.
122    bool ensureFrameIsCached(size_t index);
123
124    // Called to invalidate cached data. When |destroyAll| is true, we wipe out
125    // the entire frame buffer cache and tell the image source to destroy
126    // everything; this is used when e.g. we want to free some room in the image
127    // cache. If |destroyAll| is false, we delete frames except the current
128    // frame; this is used while animating large images to keep memory footprint
129    // low; the decoder should preserve the current frame and may preserve some
130    // other frames to avoid redecoding the whole image on every frame.
131    virtual void destroyDecodedData(bool destroyAll) OVERRIDE;
132
133    // If the image is large enough, calls destroyDecodedData().
134    void destroyDecodedDataIfNecessary();
135
136    // Generally called by destroyDecodedData(), destroys whole-image metadata
137    // and notifies observers that the memory footprint has (hopefully)
138    // decreased by |frameBytesCleared|.
139    void destroyMetadataAndNotify(size_t frameBytesCleared);
140
141    // Whether or not size is available yet.
142    bool isSizeAvailable();
143
144    // Animation.
145    int repetitionCount(bool imageKnownToBeComplete);  // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded.
146    bool shouldAnimate();
147    virtual void startAnimation(CatchUpAnimation = CatchUp) OVERRIDE;
148    void advanceAnimation(Timer<BitmapImage>*);
149
150    // Function that does the real work of advancing the animation.  When
151    // skippingFrames is true, we're in the middle of a loop trying to skip over
152    // a bunch of animation frames, so we should not do things like decode each
153    // one or notify our observers.
154    // Returns whether the animation was advanced.
155    bool internalAdvanceAnimation(bool skippingFrames);
156
157    // Checks to see if the image is a 1x1 solid color.  We optimize these images and just do a fill rect instead.
158    // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have
159    // changed.
160    void checkForSolidColor();
161
162    virtual bool mayFillWithSolidColor() OVERRIDE;
163    virtual Color solidColor() const OVERRIDE;
164
165private:
166    ImageSource m_source;
167    mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image).
168    mutable IntSize m_sizeRespectingOrientation;
169
170    size_t m_currentFrame; // The index of the current frame of animation.
171    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.
172
173    Timer<BitmapImage>* m_frameTimer;
174    int m_repetitionCount; // How many total animation loops we should do.  This will be cAnimationNone if this image type is incapable of animation.
175    RepetitionCountStatus m_repetitionCountStatus;
176    int m_repetitionsComplete;  // How many repetitions we've finished.
177    double m_desiredFrameStartTime;  // The system time at which we hope to see the next call to startAnimation().
178
179    Color m_solidColor;  // If we're a 1x1 solid color, this is the color to use to fill.
180
181    size_t m_frameCount;
182
183    bool m_isSolidColor : 1; // Whether or not we are a 1x1 solid image.
184    bool m_checkedForSolidColor : 1; // Whether we've checked the frame for solid color.
185
186    bool m_animationFinished : 1; // Whether or not we've completed the entire animation.
187
188    bool m_allDataReceived : 1; // Whether or not we've received all our data.
189    mutable bool m_haveSize : 1; // Whether or not our |m_size| member variable has the final overall image size yet.
190    bool m_sizeAvailable : 1; // Whether or not we can obtain the size of the first image frame yet from ImageIO.
191    mutable bool m_hasUniformFrameSize : 1;
192    mutable bool m_haveFrameCount : 1;
193};
194
195DEFINE_IMAGE_TYPE_CASTS(BitmapImage);
196
197} // namespace blink
198
199#endif
200