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