REGRESSION(198782): ImageSource::subsamplingLevelForScale() does not cache the Maximu...
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageSource.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2010, 2012, 2014, 2016 Apple Inc.  All rights reserved.
3  * Copyright (C) 2007-2008 Torch Mobile, Inc.
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 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 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 ImageSource_h
28 #define ImageSource_h
29
30 #include "ImageOrientation.h"
31 #include "IntPoint.h"
32 #include "NativeImagePtr.h"
33 #include "TextStream.h"
34
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/Optional.h>
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42 class ImageOrientation;
43 class IntPoint;
44 class IntSize;
45 class SharedBuffer;
46 class ImageDecoder;
47
48 // Right now GIFs are the only recognized image format that supports animation.
49 // The animation system and the constants below are designed with this in mind.
50 // GIFs have an optional 16-bit unsigned loop count that describes how an
51 // animated GIF should be cycled.  If the loop count is absent, the animation
52 // cycles once; if it is 0, the animation cycles infinitely; otherwise the
53 // animation plays n + 1 cycles (where n is the specified loop count).  If the
54 // GIF decoder defaults to cAnimationLoopOnce in the absence of any loop count
55 // and translates an explicit "0" loop count to cAnimationLoopInfinite, then we
56 // get a couple of nice side effects:
57 //   * By making cAnimationLoopOnce be 0, we allow the animation cycling code in
58 //     BitmapImage.cpp to avoid special-casing it, and simply treat all
59 //     non-negative loop counts identically.
60 //   * By making the other two constants negative, we avoid conflicts with any
61 //     real loop count values.
62 const int cAnimationLoopOnce = 0;
63 const int cAnimationLoopInfinite = -1;
64 const int cAnimationNone = -2;
65
66 // SubsamplingLevel. 0 is no subsampling, 1 is half dimensions on each axis etc.
67 typedef short SubsamplingLevel;
68
69 class ImageSource {
70     WTF_MAKE_NONCOPYABLE(ImageSource);
71     friend class BitmapImage;
72 public:
73     enum AlphaOption {
74         AlphaPremultiplied,
75         AlphaNotPremultiplied
76     };
77
78     enum GammaAndColorProfileOption {
79         GammaAndColorProfileApplied,
80         GammaAndColorProfileIgnored
81     };
82
83     ImageSource(AlphaOption = AlphaPremultiplied, GammaAndColorProfileOption = GammaAndColorProfileApplied);
84     ~ImageSource();
85
86     // Tells the ImageSource that the Image no longer cares about decoded frame
87     // data -- at all (if |destroyAll| is true), or before frame
88     // |clearBeforeFrame| (if |destroyAll| is false).  The ImageSource should
89     // delete cached decoded data for these frames where possible to keep memory
90     // usage low.  When |destroyAll| is true, the ImageSource should also reset
91     // any local state so that decoding can begin again.
92     //
93     // Implementations that delete less than what's specified above waste
94     // memory.  Implementations that delete more may burn CPU re-decoding frames
95     // that could otherwise have been cached, or encounter errors if they're
96     // asked to decode frames they can't decode due to the loss of previous
97     // decoded frames.
98     //
99     // Callers should not call clear(false, n) and subsequently call
100     // createFrameImageAtIndex(m) with m < n, unless they first call clear(true).
101     // This ensures that stateful ImageSources/decoders will work properly.
102     //
103     // The |data| and |allDataReceived| parameters should be supplied by callers
104     // who set |destroyAll| to true if they wish to be able to continue using
105     // the ImageSource.  This way implementations which choose to destroy their
106     // decoders in some cases can reconstruct them correctly.
107     void clear(bool destroyAll, size_t clearBeforeFrame = 0, SharedBuffer* data = nullptr, bool allDataReceived = false);
108
109     bool initialized() const { return m_decoder.get(); }
110
111     void setData(SharedBuffer* data, bool allDataReceived);
112
113     SubsamplingLevel subsamplingLevelForScale(float);
114     void setAllowSubsampling(bool allowSubsampling) { m_allowSubsampling = allowSubsampling; }
115     static size_t bytesDecodedToDetermineProperties();
116     
117     bool isSizeAvailable() const;
118     // Always original size, without subsampling.
119     IntSize size() const;
120     IntSize sizeRespectingOrientation() const;
121
122     size_t frameCount();
123     int repetitionCount();
124     String filenameExtension() const;
125     Optional<IntPoint> hotSpot() const;
126
127     bool frameIsCompleteAtIndex(size_t); // Whether or not the frame is completely decoded.
128     bool frameHasAlphaAtIndex(size_t); // Whether or not the frame actually used any alpha.
129     bool allowSubsamplingOfFrameAtIndex(size_t) const;
130     
131     // Size of optionally subsampled frame.
132     IntSize frameSizeAtIndex(size_t, SubsamplingLevel = 0, RespectImageOrientationEnum = DoNotRespectImageOrientation) const;
133     
134     // Return the number of bytes in the decoded frame. If the frame is not yet
135     // decoded then return 0.
136     unsigned frameBytesAtIndex(size_t, SubsamplingLevel = 0) const;
137     
138     float frameDurationAtIndex(size_t);
139     ImageOrientation orientationAtIndex(size_t) const; // EXIF image orientation
140     
141     // Callers should not call this after calling clear() with a higher index;
142     // see comments on clear() above.
143     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = 0);
144     
145 private:
146     void clearFrameBufferCache(size_t);
147     SubsamplingLevel calculateMaximumSubsamplingLevel() const;
148     void cacheMetadata();
149     void dump(TextStream&) const;
150     
151     std::unique_ptr<ImageDecoder> m_decoder;
152     
153     size_t m_frameCount { 0 };
154     SubsamplingLevel m_maximumSubsamplingLevel { 0 };
155
156     // The default value of m_allowSubsampling should be the same as defaultImageSubsamplingEnabled in Settings.cpp
157 #if PLATFORM(IOS)
158     bool m_allowSubsampling { true };
159 #else
160     bool m_allowSubsampling { false };
161 #endif
162
163     AlphaOption m_alphaOption;
164     GammaAndColorProfileOption m_gammaAndColorProfileOption;
165 };
166
167 }
168
169 #endif