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