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