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