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