This patch dramatically reduces the memory consumed by animated images. ...
[WebKit-https.git] / WebCore / platform / graphics / ImageSource.h
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ImageSource_h
27 #define ImageSource_h
28
29 #include <wtf/Noncopyable.h>
30 #include <wtf/Vector.h>
31
32 #if PLATFORM(CG)
33 typedef struct CGImageSource* CGImageSourceRef;
34 typedef struct CGImage* CGImageRef;
35 typedef const struct __CFData* CFDataRef;
36 #elif PLATFORM(QT)
37 class QPixmap;
38 #elif PLATFORM(CAIRO)
39 struct _cairo_surface;
40 typedef struct _cairo_surface cairo_surface_t;
41 #endif
42
43 namespace WebCore {
44
45 class IntSize;
46
47 #if PLATFORM(CG)
48 typedef CGImageSourceRef NativeImageSourcePtr;
49 typedef CGImageRef NativeImagePtr;
50 typedef CFDataRef NativeBytePtr;
51 #elif PLATFORM(QT)
52 class ImageDecoderQt;
53 typedef ImageDecoderQt* NativeImageSourcePtr;
54 typedef const Vector<char>* NativeBytePtr;
55 typedef QPixmap* NativeImagePtr;
56 #else
57 class ImageDecoder;
58 typedef ImageDecoder* NativeImageSourcePtr;
59 typedef const Vector<char>* NativeBytePtr;
60 typedef cairo_surface_t* NativeImagePtr;
61 #endif
62
63 const int cAnimationLoopOnce = -1;
64 const int cAnimationNone = -2;
65
66 class ImageSource : Noncopyable {
67 public:
68     ImageSource();
69     ~ImageSource();
70
71     void clear();
72
73     bool initialized() const;
74     
75     void setData(NativeBytePtr, bool allDataReceived);
76
77     bool isSizeAvailable();
78     IntSize size() const;
79     
80     int repetitionCount();
81     
82     size_t frameCount() const;
83     
84     NativeImagePtr createFrameAtIndex(size_t);
85     void destroyFrameAtIndex(size_t);
86     
87     float frameDurationAtIndex(size_t);
88     bool frameHasAlphaAtIndex(size_t); // Whether or not the frame actually used any alpha.
89
90 private:
91     NativeImageSourcePtr m_decoder;
92 };
93
94 }
95
96 #endif