Commit | Line | Data |
---|---|---|
661dc384 JS |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: gifdecod.h | |
3 | // Purpose: wxGIFDecoder, GIF reader for wxImage and wxAnimation | |
4 | // Author: Guillermo Rodriguez Garcia <guille@iies.es> | |
3c87527e | 5 | // Version: 3.02 |
83413d6d GRG |
6 | // CVS-ID: $Id$ |
7 | // Copyright: (c) 1999 Guillermo Rodriguez Garcia | |
661dc384 JS |
8 | // Licence: wxWindows licence |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
11 | #ifndef _WX_GIFDECOD_H | |
12 | #define _WX_GIFDECOD_H | |
13 | ||
12028905 | 14 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
661dc384 JS |
15 | #pragma interface "gifdecod.h" |
16 | #endif | |
17 | ||
18 | #include "wx/setup.h" | |
19 | ||
83413d6d GRG |
20 | #if wxUSE_STREAMS && wxUSE_GIF |
21 | ||
661dc384 JS |
22 | #include "wx/stream.h" |
23 | #include "wx/image.h" | |
24 | ||
25 | ||
e4b8154a | 26 | // -------------------------------------------------------------------------- |
8141573c | 27 | // Constants |
e4b8154a GRG |
28 | // -------------------------------------------------------------------------- |
29 | ||
8141573c GRG |
30 | // Error codes: |
31 | // Note that the error code wxGIF_TRUNCATED means that the image itself | |
32 | // is most probably OK, but the decoder didn't reach the end of the data | |
33 | // stream; this means that if it was not reading directly from file, | |
34 | // the stream will not be correctly positioned. the | |
35 | // | |
36 | enum | |
37 | { | |
38 | wxGIF_OK = 0, /* everything was OK */ | |
39 | wxGIF_INVFORMAT, /* error in gif header */ | |
40 | wxGIF_MEMERR, /* error allocating memory */ | |
41 | wxGIF_TRUNCATED /* file appears to be truncated */ | |
42 | }; | |
43 | ||
44 | // Disposal method | |
45 | // Experimental; subject to change. | |
46 | // | |
e4b8154a GRG |
47 | enum |
48 | { | |
49 | wxGIF_D_UNSPECIFIED = -1, /* not specified */ | |
50 | wxGIF_D_DONOTDISPOSE = 0, /* do not dispose */ | |
51 | wxGIF_D_TOBACKGROUND = 1, /* restore to background colour */ | |
52 | wxGIF_D_TOPREVIOUS = 2 /* restore to previous image */ | |
53 | }; | |
54 | ||
e4b8154a GRG |
55 | |
56 | #define MAX_BLOCK_SIZE 256 /* max. block size */ | |
57 | ||
58 | ||
59 | // -------------------------------------------------------------------------- | |
60 | // wxGIFDecoder class | |
61 | // -------------------------------------------------------------------------- | |
62 | ||
63 | // internal class for storing GIF image data | |
64 | class GIFImage | |
661dc384 | 65 | { |
e4b8154a | 66 | public: |
65c36a73 VZ |
67 | // def ctor |
68 | GIFImage(); | |
69 | ||
661dc384 JS |
70 | unsigned int w; /* width */ |
71 | unsigned int h; /* height */ | |
72 | unsigned int left; /* x coord (in logical screen) */ | |
73 | unsigned int top; /* y coord (in logical screen) */ | |
74 | int transparent; /* transparent color (-1 = none) */ | |
3c87527e | 75 | int disposal; /* disposal method (-1 = unspecified) */ |
661dc384 JS |
76 | long delay; /* delay in ms (-1 = unused) */ |
77 | unsigned char *p; /* bitmap */ | |
78 | unsigned char *pal; /* palette */ | |
e4b8154a GRG |
79 | GIFImage *next; /* next image */ |
80 | GIFImage *prev; /* prev image */ | |
22f3361e VZ |
81 | |
82 | DECLARE_NO_COPY_CLASS(GIFImage) | |
e4b8154a | 83 | }; |
661dc384 | 84 | |
76443e70 | 85 | |
b31ba288 | 86 | class WXDLLEXPORT wxGIFDecoder |
661dc384 JS |
87 | { |
88 | private: | |
e4b8154a | 89 | // logical screen |
661dc384 JS |
90 | unsigned int m_screenw; /* logical screen width */ |
91 | unsigned int m_screenh; /* logical screen height */ | |
92 | int m_background; /* background color (-1 = none) */ | |
93 | ||
e4b8154a | 94 | // image data |
661dc384 JS |
95 | bool m_anim; /* animated GIF */ |
96 | int m_nimages; /* number of images */ | |
97 | int m_image; /* current image */ | |
e4b8154a GRG |
98 | GIFImage *m_pimage; /* pointer to current image */ |
99 | GIFImage *m_pfirst; /* pointer to first image */ | |
100 | GIFImage *m_plast; /* pointer to last image */ | |
661dc384 | 101 | |
e4b8154a | 102 | // decoder state vars |
661dc384 JS |
103 | int m_restbits; /* remaining valid bits */ |
104 | unsigned int m_restbyte; /* remaining bytes in this block */ | |
105 | unsigned int m_lastbyte; /* last byte read */ | |
76443e70 GRG |
106 | unsigned char m_buffer[MAX_BLOCK_SIZE]; /* buffer for reading */ |
107 | unsigned char *m_bufp; /* pointer to next byte in buffer */ | |
661dc384 | 108 | |
e4b8154a GRG |
109 | // input stream |
110 | wxInputStream *m_f; /* input stream */ | |
661dc384 JS |
111 | |
112 | private: | |
113 | int getcode(int bits, int abfin); | |
e4b8154a | 114 | int dgif(GIFImage *img, int interl, int bits); |
661dc384 | 115 | |
809e8e44 | 116 | public: |
661dc384 JS |
117 | // get data of current frame |
118 | int GetFrameIndex() const; | |
119 | unsigned char* GetData() const; | |
120 | unsigned char* GetPalette() const; | |
121 | unsigned int GetWidth() const; | |
122 | unsigned int GetHeight() const; | |
123 | unsigned int GetLeft() const; | |
124 | unsigned int GetTop() const; | |
125 | int GetDisposalMethod() const; | |
126 | int GetTransparentColour() const; | |
127 | long GetDelay() const; | |
128 | ||
129 | // get global data | |
130 | unsigned int GetLogicalScreenWidth() const; | |
131 | unsigned int GetLogicalScreenHeight() const; | |
132 | int GetBackgroundColour() const; | |
133 | int GetNumberOfFrames() const; | |
134 | bool IsAnimation() const; | |
135 | ||
136 | // move through the animation | |
137 | bool GoFirstFrame(); | |
138 | bool GoLastFrame(); | |
139 | bool GoNextFrame(bool cyclic = FALSE); | |
140 | bool GoPrevFrame(bool cyclic = FALSE); | |
141 | bool GoFrame(int which); | |
e4b8154a GRG |
142 | |
143 | public: | |
144 | // constructor, destructor, etc. | |
145 | wxGIFDecoder(wxInputStream *s, bool anim = FALSE); | |
146 | ~wxGIFDecoder(); | |
147 | bool CanRead(); | |
148 | int ReadGIF(); | |
149 | void Destroy(); | |
150 | ||
151 | // convert current frame to wxImage | |
152 | bool ConvertToImage(wxImage *image) const; | |
22f3361e VZ |
153 | |
154 | DECLARE_NO_COPY_CLASS(wxGIFDecoder) | |
661dc384 JS |
155 | }; |
156 | ||
157 | ||
83413d6d | 158 | #endif // wxUSE_STREAM && wxUSE_GIF |
661dc384 JS |
159 | #endif // _WX_GIFDECOD_H |
160 |