code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / blender / imbuf / intern / dds / DirectDrawSurface.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributors: Amorilia (amorilia@users.sourceforge.net)
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/imbuf/intern/dds/DirectDrawSurface.h
24  *  \ingroup imbdds
25  */
26
27
28 /*
29  * This file is based on a similar file from the NVIDIA texture tools
30  * (http://nvidia-texture-tools.googlecode.com/)
31  *
32  * Original license from NVIDIA follows.
33  */
34
35 // Copyright NVIDIA Corporation 2007 -- Ignacio Castano <icastano@nvidia.com>
36 // 
37 // Permission is hereby granted, free of charge, to any person
38 // obtaining a copy of this software and associated documentation
39 // files (the "Software"), to deal in the Software without
40 // restriction, including without limitation the rights to use,
41 // copy, modify, merge, publish, distribute, sublicense, and/or sell
42 // copies of the Software, and to permit persons to whom the
43 // Software is furnished to do so, subject to the following
44 // conditions:
45 // 
46 // The above copyright notice and this permission notice shall be
47 // included in all copies or substantial portions of the Software.
48 // 
49 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
50 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
51 // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
52 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
53 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
54 // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
55 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
56 // OTHER DEALINGS IN THE SOFTWARE.
57
58 #ifndef __DIRECTDRAWSURFACE_H__
59 #define __DIRECTDRAWSURFACE_H__
60
61 #include <Common.h>
62 #include <Stream.h>
63 #include <ColorBlock.h>
64 #include <Image.h>
65
66 struct DDSPixelFormat
67 {
68         uint size;
69         uint flags;
70         uint fourcc;
71         uint bitcount;
72         uint rmask;
73         uint gmask;
74         uint bmask;
75         uint amask;
76 };
77
78 struct DDSCaps
79 {
80         uint caps1;
81         uint caps2;
82         uint caps3;
83         uint caps4;
84 };
85
86 /// DDS file header for DX10.
87 struct DDSHeader10
88 {
89         uint dxgiFormat;
90         uint resourceDimension;
91         uint miscFlag;
92         uint arraySize;
93         uint reserved;
94 };
95
96 /// DDS file header.
97 struct DDSHeader
98 {
99         uint fourcc;
100         uint size;
101         uint flags;
102         uint height;
103         uint width;
104         uint pitch;
105         uint depth;
106         uint mipmapcount;
107         uint reserved[11];
108         DDSPixelFormat pf;
109         DDSCaps caps;
110         uint notused;
111         DDSHeader10 header10;
112
113
114         // Helper methods.
115         DDSHeader();
116         
117         void setWidth(uint w);
118         void setHeight(uint h);
119         void setDepth(uint d);
120         void setMipmapCount(uint count);
121         void setTexture2D();
122         void setTexture3D();
123         void setTextureCube();
124         void setLinearSize(uint size);
125         void setPitch(uint pitch);
126         void setFourCC(uint8 c0, uint8 c1, uint8 c2, uint8 c3);
127         void setFormatCode(uint code);
128         void setSwizzleCode(uint8 c0, uint8 c1, uint8 c2, uint8 c3);
129         void setPixelFormat(uint bitcount, uint rmask, uint gmask, uint bmask, uint amask);
130         void setDX10Format(uint format);
131         void setNormalFlag(bool b);
132         void setSrgbFlag(bool b);
133         void setHasAlphaFlag(bool b);
134         void setUserVersion(int version);
135         
136         /*void swapBytes();*/
137         
138         bool hasDX10Header() const;
139         uint signature() const;
140         uint toolVersion() const;
141         uint userVersion() const;
142         bool isNormalMap() const;
143         bool isSrgb() const;
144         bool hasAlpha() const;
145         uint d3d9Format() const;
146 };
147
148 /// DirectDraw Surface. (DDS)
149 class DirectDrawSurface
150 {
151 public:
152         DirectDrawSurface(unsigned char *mem, uint size);
153         ~DirectDrawSurface();
154         
155         bool isValid() const;
156         bool isSupported() const;
157
158         bool hasAlpha() const;
159         
160         uint mipmapCount() const;
161         uint fourCC() const;
162         uint width() const;
163         uint height() const;
164         uint depth() const;
165         bool isTexture1D() const;
166         bool isTexture2D() const;
167         bool isTexture3D() const;
168         bool isTextureCube() const;
169
170         void setNormalFlag(bool b);
171         void setHasAlphaFlag(bool b);
172         void setUserVersion(int version);
173         
174         void mipmap(Image * img, uint f, uint m);
175         void* readData(uint &size);
176         //      void mipmap(FloatImage * img, uint f, uint m);
177         
178         void printInfo() const;
179
180 private:
181         
182         uint blockSize() const;
183         uint faceSize() const;
184         uint mipmapSize(uint m) const;
185         
186         uint offset(uint f, uint m);
187         
188         void readLinearImage(Image * img);
189         void readBlockImage(Image * img);
190         void readBlock(ColorBlock * rgba);
191         
192         
193 private:
194         Stream stream; // memory where DDS file resides
195         DDSHeader header;
196 };
197
198 void mem_read(Stream & mem, DDSPixelFormat & pf);
199 void mem_read(Stream & mem, DDSCaps & caps);
200 void mem_read(Stream & mem, DDSHeader & header);
201 void mem_read(Stream & mem, DDSHeader10 & header);
202
203 #endif  /* __DIRECTDRAWSURFACE_H__ */