Moved a few non-standard headers into their respective dlls.
[wine] / dlls / ddraw / helper.c
1
2 /*              DirectDraw Base Functions
3  *
4  * Copyright 1997-1999 Marcus Meissner
5  * Copyright 1998 Lionel Ulmer (most of Direct3D stuff)
6  */
7
8 #include "config.h"
9
10 #include <unistd.h>
11 #include <assert.h>
12 #include <fcntl.h>
13 #include <string.h>
14 #include <stdlib.h>
15 #include <stdio.h>
16
17 #include "winerror.h"
18 #include "gdi.h"
19 #include "heap.h"
20 #include "dc.h"
21 #include "win.h"
22 #include "wine/exception.h"
23 #include "ddraw.h"
24 #include "d3d.h"
25 #include "debugtools.h"
26 #include "message.h"
27 #include "options.h"
28
29 DEFAULT_DEBUG_CHANNEL(ddraw);
30
31 /******************************************************************************
32  *              debug output functions
33  */
34 void _dump_DDBLTFX(DWORD flagmask) {
35     int i;
36     const struct {
37         DWORD   mask;
38         char    *name;
39     } flags[] = {
40 #define FE(x) { x, #x},
41         FE(DDBLTFX_ARITHSTRETCHY)
42         FE(DDBLTFX_MIRRORLEFTRIGHT)
43         FE(DDBLTFX_MIRRORUPDOWN)
44         FE(DDBLTFX_NOTEARING)
45         FE(DDBLTFX_ROTATE180)
46         FE(DDBLTFX_ROTATE270)
47         FE(DDBLTFX_ROTATE90)
48         FE(DDBLTFX_ZBUFFERRANGE)
49         FE(DDBLTFX_ZBUFFERBASEDEST)
50 #undef FE
51     };
52     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
53         if (flags[i].mask & flagmask)
54             DPRINTF("%s ",flags[i].name);
55     DPRINTF("\n");
56 }
57
58 void _dump_DDBLTFAST(DWORD flagmask) {
59     int i;
60     const struct {
61         DWORD   mask;
62         char    *name;
63     } flags[] = {
64 #define FE(x) { x, #x},
65         FE(DDBLTFAST_NOCOLORKEY)
66         FE(DDBLTFAST_SRCCOLORKEY)
67         FE(DDBLTFAST_DESTCOLORKEY)
68         FE(DDBLTFAST_WAIT)
69 #undef FE
70     };
71     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
72         if (flags[i].mask & flagmask)
73             DPRINTF("%s ",flags[i].name);
74     DPRINTF("\n");
75 }
76
77 void _dump_DDBLT(DWORD flagmask) {
78     int i;
79     const struct {
80         DWORD   mask;
81         char    *name;
82     } flags[] = {
83 #define FE(x) { x, #x},
84         FE(DDBLT_ALPHADEST)
85         FE(DDBLT_ALPHADESTCONSTOVERRIDE)
86         FE(DDBLT_ALPHADESTNEG)
87         FE(DDBLT_ALPHADESTSURFACEOVERRIDE)
88         FE(DDBLT_ALPHAEDGEBLEND)
89         FE(DDBLT_ALPHASRC)
90         FE(DDBLT_ALPHASRCCONSTOVERRIDE)
91         FE(DDBLT_ALPHASRCNEG)
92         FE(DDBLT_ALPHASRCSURFACEOVERRIDE)
93         FE(DDBLT_ASYNC)
94         FE(DDBLT_COLORFILL)
95         FE(DDBLT_DDFX)
96         FE(DDBLT_DDROPS)
97         FE(DDBLT_KEYDEST)
98         FE(DDBLT_KEYDESTOVERRIDE)
99         FE(DDBLT_KEYSRC)
100         FE(DDBLT_KEYSRCOVERRIDE)
101         FE(DDBLT_ROP)
102         FE(DDBLT_ROTATIONANGLE)
103         FE(DDBLT_ZBUFFER)
104         FE(DDBLT_ZBUFFERDESTCONSTOVERRIDE)
105         FE(DDBLT_ZBUFFERDESTOVERRIDE)
106         FE(DDBLT_ZBUFFERSRCCONSTOVERRIDE)
107         FE(DDBLT_ZBUFFERSRCOVERRIDE)
108         FE(DDBLT_WAIT)
109         FE(DDBLT_DEPTHFILL)
110 #undef FE
111     };
112     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
113         if (flags[i].mask & flagmask)
114             DPRINTF("%s ",flags[i].name);
115     DPRINTF("\n");
116 }
117
118 void _dump_DDSCAPS(void *in) {
119     int i;
120     const struct {
121         DWORD   mask;
122         char    *name;
123     } flags[] = {
124 #define FE(x) { x, #x},
125         FE(DDSCAPS_RESERVED1)
126         FE(DDSCAPS_ALPHA)
127         FE(DDSCAPS_BACKBUFFER)
128         FE(DDSCAPS_COMPLEX)
129         FE(DDSCAPS_FLIP)
130         FE(DDSCAPS_FRONTBUFFER)
131         FE(DDSCAPS_OFFSCREENPLAIN)
132         FE(DDSCAPS_OVERLAY)
133         FE(DDSCAPS_PALETTE)
134         FE(DDSCAPS_PRIMARYSURFACE)
135         FE(DDSCAPS_PRIMARYSURFACELEFT)
136         FE(DDSCAPS_SYSTEMMEMORY)
137         FE(DDSCAPS_TEXTURE)
138         FE(DDSCAPS_3DDEVICE)
139         FE(DDSCAPS_VIDEOMEMORY)
140         FE(DDSCAPS_VISIBLE)
141         FE(DDSCAPS_WRITEONLY)
142         FE(DDSCAPS_ZBUFFER)
143         FE(DDSCAPS_OWNDC)
144         FE(DDSCAPS_LIVEVIDEO)
145         FE(DDSCAPS_HWCODEC)
146         FE(DDSCAPS_MODEX)
147         FE(DDSCAPS_MIPMAP)
148         FE(DDSCAPS_RESERVED2)
149         FE(DDSCAPS_ALLOCONLOAD)
150         FE(DDSCAPS_VIDEOPORT)
151         FE(DDSCAPS_LOCALVIDMEM)
152         FE(DDSCAPS_NONLOCALVIDMEM)
153         FE(DDSCAPS_STANDARDVGAMODE)
154         FE(DDSCAPS_OPTIMIZED)
155 #undef FE
156     };
157     DWORD flagmask = *((DWORD *) in);
158     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
159         if (flags[i].mask & flagmask)
160             DPRINTF("%s ",flags[i].name);
161 }
162
163 void _dump_pixelformat_flag(DWORD flagmask) {
164     int i;
165     const struct {
166         DWORD   mask;
167         char    *name;
168     } flags[] = {
169 #define FE(x) { x, #x},
170         FE(DDPF_ALPHAPIXELS)
171         FE(DDPF_ALPHA)
172         FE(DDPF_FOURCC)
173         FE(DDPF_PALETTEINDEXED4)
174         FE(DDPF_PALETTEINDEXEDTO8)
175         FE(DDPF_PALETTEINDEXED8)
176         FE(DDPF_RGB)
177         FE(DDPF_COMPRESSED)
178         FE(DDPF_RGBTOYUV)
179         FE(DDPF_YUV)
180         FE(DDPF_ZBUFFER)
181         FE(DDPF_PALETTEINDEXED1)
182         FE(DDPF_PALETTEINDEXED2)
183         FE(DDPF_ZPIXELS)
184 #undef FE
185     };
186     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
187         if (flags[i].mask & flagmask)
188             DPRINTF("%s ",flags[i].name);
189 }
190
191 void _dump_paletteformat(DWORD dwFlags) {
192     int i;
193     const struct {
194         DWORD   mask;
195         char    *name;
196     } flags[] = {
197 #define FE(x) { x, #x},
198         FE(DDPCAPS_4BIT)
199         FE(DDPCAPS_8BITENTRIES)
200         FE(DDPCAPS_8BIT)
201         FE(DDPCAPS_INITIALIZE)
202         FE(DDPCAPS_PRIMARYSURFACE)
203         FE(DDPCAPS_PRIMARYSURFACELEFT)
204         FE(DDPCAPS_ALLOW256)
205         FE(DDPCAPS_VSYNC)
206         FE(DDPCAPS_1BIT)
207         FE(DDPCAPS_2BIT)
208         FE(DDPCAPS_ALPHA)
209 #undef FE
210     };
211     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
212         if (flags[i].mask & dwFlags)
213             DPRINTF("%s ",flags[i].name);
214     DPRINTF("\n");
215 }
216
217 void _dump_pixelformat(void *in) {
218     LPDDPIXELFORMAT pf = (LPDDPIXELFORMAT) in;
219
220     DPRINTF("( ");
221     _dump_pixelformat_flag(pf->dwFlags);
222     if (pf->dwFlags & DDPF_FOURCC) {
223         DPRINTF(", dwFourCC : %c%c%c%c",
224                 (unsigned char)((pf->dwFourCC>>24)&0xff),
225                 (unsigned char)((pf->dwFourCC>>16)&0xff),
226                 (unsigned char)((pf->dwFourCC>> 8)&0xff),
227                 (unsigned char)( pf->dwFourCC     &0xff)
228         );
229     }
230     if (pf->dwFlags & DDPF_RGB) {
231         char *cmd;
232         DPRINTF(", RGB bits: %ld, ", pf->u.dwRGBBitCount);
233         switch (pf->u.dwRGBBitCount) {
234         case 4: cmd = "%1lx"; break;
235         case 8: cmd = "%02lx"; break;
236         case 16: cmd = "%04lx"; break;
237         case 24: cmd = "%06lx"; break;
238         case 32: cmd = "%08lx"; break;
239         default: ERR("Unexpected bit depth !\n"); cmd = "%d"; break;
240         }
241         DPRINTF(" R "); DPRINTF(cmd, pf->u1.dwRBitMask);
242         DPRINTF(" G "); DPRINTF(cmd, pf->u2.dwGBitMask);
243         DPRINTF(" B "); DPRINTF(cmd, pf->u3.dwBBitMask);
244         if (pf->dwFlags & DDPF_ALPHAPIXELS) {
245             DPRINTF(" A "); DPRINTF(cmd, pf->u4.dwRGBAlphaBitMask);
246         }
247         if (pf->dwFlags & DDPF_ZPIXELS) {
248             DPRINTF(" Z "); DPRINTF(cmd, pf->u4.dwRGBZBitMask);
249         }
250     }
251     if (pf->dwFlags & DDPF_ZBUFFER) {
252         DPRINTF(", Z bits : %ld", pf->u.dwZBufferBitDepth);
253     }
254     if (pf->dwFlags & DDPF_ALPHA) {
255         DPRINTF(", Alpha bits : %ld", pf->u.dwAlphaBitDepth);
256     }
257     DPRINTF(")");
258 }
259
260 void _dump_colorkeyflag(DWORD ck) {
261     int i;
262     const struct {
263         DWORD   mask;
264         char    *name;
265     } flags[] = {
266 #define FE(x) { x, #x},
267         FE(DDCKEY_COLORSPACE)
268         FE(DDCKEY_DESTBLT)
269         FE(DDCKEY_DESTOVERLAY)
270         FE(DDCKEY_SRCBLT)
271         FE(DDCKEY_SRCOVERLAY)
272 #undef FE
273     };
274     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
275         if (flags[i].mask & ck)
276             DPRINTF("%s ",flags[i].name);
277 }
278
279 static void _dump_DWORD(void *in) {
280     DPRINTF("%ld", *((DWORD *) in));
281 }
282 static void _dump_PTR(void *in) {
283     DPRINTF("%p", *((void **) in));
284 }
285 void _dump_DDCOLORKEY(void *in) {
286     DDCOLORKEY *ddck = (DDCOLORKEY *) in;
287
288     DPRINTF(" Low : %ld  - High : %ld", ddck->dwColorSpaceLowValue, ddck->dwColorSpaceHighValue);
289 }
290
291 void _dump_surface_desc(DDSURFACEDESC *lpddsd) {
292     int i;
293     struct {
294         DWORD   mask;
295         char    *name;
296         void (*func)(void *);
297         void    *elt;
298     } flags[16], *fe = flags;
299 #define FE(x,f,e) do { fe->mask = x;  fe->name = #x; fe->func = f; fe->elt = (void *) &(lpddsd->e); fe++; } while(0)
300         FE(DDSD_CAPS, _dump_DDSCAPS, ddsCaps);
301         FE(DDSD_HEIGHT, _dump_DWORD, dwHeight);
302         FE(DDSD_WIDTH, _dump_DWORD, dwWidth);
303         FE(DDSD_PITCH, _dump_DWORD, lPitch);
304         FE(DDSD_BACKBUFFERCOUNT, _dump_DWORD, dwBackBufferCount);
305         FE(DDSD_ZBUFFERBITDEPTH, _dump_DWORD, u.dwZBufferBitDepth);
306         FE(DDSD_ALPHABITDEPTH, _dump_DWORD, dwAlphaBitDepth);
307         FE(DDSD_PIXELFORMAT, _dump_pixelformat, ddpfPixelFormat);
308         FE(DDSD_CKDESTOVERLAY, _dump_DDCOLORKEY, ddckCKDestOverlay);
309         FE(DDSD_CKDESTBLT, _dump_DDCOLORKEY, ddckCKDestBlt);
310         FE(DDSD_CKSRCOVERLAY, _dump_DDCOLORKEY, ddckCKSrcOverlay);
311         FE(DDSD_CKSRCBLT, _dump_DDCOLORKEY, ddckCKSrcBlt);
312         FE(DDSD_MIPMAPCOUNT, _dump_DWORD, u.dwMipMapCount);
313         FE(DDSD_REFRESHRATE, _dump_DWORD, u.dwRefreshRate);
314         FE(DDSD_LINEARSIZE, _dump_DWORD, u1.dwLinearSize);
315         FE(DDSD_LPSURFACE, _dump_PTR, u1.lpSurface);
316 #undef FE
317
318     for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
319         if (flags[i].mask & lpddsd->dwFlags) {
320             DPRINTF(" - %s : ",flags[i].name);
321             flags[i].func(flags[i].elt);
322             DPRINTF("\n");  
323         }
324 }
325 void _dump_cooperativelevel(DWORD cooplevel) {
326     int i;
327     const struct {
328         int     mask;
329         char    *name;
330     } flags[] = {
331 #define FE(x) { x, #x},
332             FE(DDSCL_FULLSCREEN)
333             FE(DDSCL_ALLOWREBOOT)
334             FE(DDSCL_NOWINDOWCHANGES)
335             FE(DDSCL_NORMAL)
336             FE(DDSCL_ALLOWMODEX)
337             FE(DDSCL_EXCLUSIVE)
338             FE(DDSCL_SETFOCUSWINDOW)
339             FE(DDSCL_SETDEVICEWINDOW)
340             FE(DDSCL_CREATEDEVICEWINDOW)
341 #undef FE
342     };
343
344     if (TRACE_ON(ddraw)) {
345         DPRINTF(" - ");
346         for (i=0;i<sizeof(flags)/sizeof(flags[0]);i++)
347             if (flags[i].mask & cooplevel)
348                 DPRINTF("%s ",flags[i].name);
349         DPRINTF("\n");
350     }
351 }