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