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