version: Constify some variables.
[wine] / dlls / winex11.drv / settings.c
1 /*
2  * Wine X11drv display settings functions
3  *
4  * Copyright 2003 Alexander James Pasadyn
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22 #include <string.h>
23 #include <stdio.h>
24 #include "x11drv.h"
25
26 #include "windef.h"
27 #include "wingdi.h"
28 #include "ddrawi.h"
29 #include "wine/debug.h"
30
31 WINE_DEFAULT_DEBUG_CHANNEL(x11settings);
32
33 /*
34  * The DDHALMODEINFO type is used to hold all the mode information.  
35  * This is done because the array of DDHALMODEINFO structures must be 
36  * created for use by DirectDraw anyway.
37  */
38 static LPDDHALMODEINFO dd_modes = NULL;
39 static unsigned int dd_mode_count = 0;
40 static unsigned int dd_max_modes = 0;
41 static int dd_mode_default = 0;
42 static const unsigned int depths[]  = {8, 16, 32};
43
44 /* pointers to functions that actually do the hard stuff */
45 static int (*pGetCurrentMode)(void);
46 static LONG (*pSetCurrentMode)(int mode);
47 static const char *handler_name;
48
49 /*
50  * Set the handlers for resolution changing functions
51  * and initialize the master list of modes
52  */
53 LPDDHALMODEINFO X11DRV_Settings_SetHandlers(const char *name,
54                                  int (*pNewGCM)(void),
55                                  LONG (*pNewSCM)(int),
56                                  unsigned int nmodes,
57                                  int reserve_depths)
58 {
59     handler_name = name;
60     pGetCurrentMode = pNewGCM;
61     pSetCurrentMode = pNewSCM;
62     TRACE("Resolution settings now handled by: %s\n", name);
63     if (reserve_depths)
64         /* leave room for other depths */
65         dd_max_modes = (3+1)*(nmodes);
66     else 
67         dd_max_modes = nmodes;
68
69     if (dd_modes) 
70     {
71         TRACE("Destroying old display modes array\n");
72         HeapFree(GetProcessHeap(), 0, dd_modes);
73     }
74     dd_modes = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(DDHALMODEINFO) * dd_max_modes);
75     dd_mode_count = 0;
76     TRACE("Initialized new display modes array\n");
77     return dd_modes;
78 }
79
80 /* Add one mode to the master list */
81 void X11DRV_Settings_AddOneMode(unsigned int width, unsigned int height, unsigned int bpp, unsigned int freq)
82 {
83     LPDDHALMODEINFO info = &(dd_modes[dd_mode_count]);
84     DWORD dwBpp = screen_depth;
85     if (dd_mode_count >= dd_max_modes)
86     {
87         ERR("Maximum modes (%d) exceeded\n", dd_max_modes);
88         return;
89     }
90     if (dwBpp == 24) dwBpp = 32;
91     if (bpp == 0) bpp = dwBpp;
92     info->dwWidth        = width;
93     info->dwHeight       = height;
94     info->wRefreshRate   = freq;
95     info->lPitch         = 0;
96     info->dwBPP          = bpp;
97     info->wFlags         = 0;
98     info->dwRBitMask     = 0;
99     info->dwGBitMask     = 0;
100     info->dwBBitMask     = 0;
101     info->dwAlphaBitMask = 0;
102     TRACE("initialized mode %d: %dx%dx%d @%d Hz (%s)\n", 
103           dd_mode_count, width, height, bpp, freq, handler_name);
104     dd_mode_count++;
105 }
106
107 /* copy all the current modes using the other color depths */
108 void X11DRV_Settings_AddDepthModes(void)
109 {
110     int i, j;
111     int existing_modes = dd_mode_count;
112     DWORD dwBpp = screen_depth;
113     if (dwBpp == 24) dwBpp = 32;
114     for (j=0; j<3; j++)
115     {
116         if (depths[j] != dwBpp)
117         {
118             for (i=0; i < existing_modes; i++)
119             {
120                 X11DRV_Settings_AddOneMode(dd_modes[i].dwWidth, dd_modes[i].dwHeight, 
121                                            depths[j], dd_modes[i].wRefreshRate);
122             }
123         }
124     }
125 }
126
127 /* set the default mode */
128 void X11DRV_Settings_SetDefaultMode(int mode)
129 {
130     dd_mode_default = mode;
131 }
132
133 /* return the number of modes that are initialized */
134 unsigned int X11DRV_Settings_GetModeCount(void)
135 {
136     return dd_mode_count;
137 }
138
139 /***********************************************************************
140  * Default handlers if resolution switching is not enabled
141  *
142  */
143 static int X11DRV_nores_GetCurrentMode(void)
144 {
145     return 0;
146 }
147 static LONG X11DRV_nores_SetCurrentMode(int mode)
148 {
149     TRACE("Ignoring mode change request\n");
150     return DISP_CHANGE_FAILED;
151 }
152 /* default handler only gets the current X desktop resolution */
153 void X11DRV_Settings_Init(void)
154 {
155     X11DRV_Settings_SetHandlers("NoRes", 
156                                 X11DRV_nores_GetCurrentMode, 
157                                 X11DRV_nores_SetCurrentMode, 
158                                 1, 0);
159     X11DRV_Settings_AddOneMode(screen_width, screen_height, 0, 60);
160 }
161
162 /***********************************************************************
163  *              EnumDisplaySettingsEx  (X11DRV.@)
164  *
165  */
166 BOOL X11DRV_EnumDisplaySettingsEx( LPCWSTR name, DWORD n, LPDEVMODEW devmode, DWORD flags)
167 {
168     DWORD dwBpp = screen_depth;
169     if (dwBpp == 24) dwBpp = 32;
170     devmode->dmDisplayFlags = 0;
171     devmode->dmDisplayFrequency = 0;
172     devmode->dmSize = sizeof(DEVMODEW);
173     if (n == ENUM_CURRENT_SETTINGS)
174     {
175         TRACE("mode %d (current) -- getting current mode (%s)\n", n, handler_name);
176         n = pGetCurrentMode();
177     }
178     if (n == ENUM_REGISTRY_SETTINGS)
179     {
180         TRACE("mode %d (registry) -- getting default mode (%s)\n", n, handler_name);
181         n = dd_mode_default;
182     }
183     if (n < dd_mode_count)
184     {
185         devmode->dmPelsWidth = dd_modes[n].dwWidth;
186         devmode->dmPelsHeight = dd_modes[n].dwHeight;
187         devmode->dmBitsPerPel = dd_modes[n].dwBPP;
188         devmode->dmDisplayFrequency = dd_modes[n].wRefreshRate;
189         devmode->dmFields = (DM_PELSWIDTH|DM_PELSHEIGHT|DM_BITSPERPEL);
190         if (devmode->dmDisplayFrequency)
191         {
192             devmode->dmFields |= DM_DISPLAYFREQUENCY;
193             TRACE("mode %d -- %dx%dx%dbpp @%d Hz (%s)\n", n,
194                   devmode->dmPelsWidth, devmode->dmPelsHeight, devmode->dmBitsPerPel,
195                   devmode->dmDisplayFrequency, handler_name);
196         }
197         else
198         {
199             TRACE("mode %d -- %dx%dx%dbpp (%s)\n", n,
200                   devmode->dmPelsWidth, devmode->dmPelsHeight, devmode->dmBitsPerPel, 
201                   handler_name);
202         }
203         return TRUE;
204     }
205     TRACE("mode %d -- not present (%s)\n", n, handler_name);
206     return FALSE;
207 }
208
209 #define _X_FIELD(prefix, bits) if ((fields) & prefix##_##bits) {p+=sprintf(p, "%s%s", first ? "" : ",", #bits); first=FALSE;}
210 static const char * _CDS_flags(DWORD fields)
211 {
212     BOOL first = TRUE;
213     char buf[128];
214     char *p = buf;
215     _X_FIELD(CDS,UPDATEREGISTRY);_X_FIELD(CDS,TEST);_X_FIELD(CDS,FULLSCREEN);
216     _X_FIELD(CDS,GLOBAL);_X_FIELD(CDS,SET_PRIMARY);_X_FIELD(CDS,RESET);
217     _X_FIELD(CDS,SETRECT);_X_FIELD(CDS,NORESET);
218     *p = 0;
219     return wine_dbg_sprintf("%s", buf);
220 }
221 static const char * _DM_fields(DWORD fields)
222 {
223     BOOL first = TRUE;
224     char buf[128];
225     char *p = buf;
226     _X_FIELD(DM,BITSPERPEL);_X_FIELD(DM,PELSWIDTH);_X_FIELD(DM,PELSHEIGHT);
227     _X_FIELD(DM,DISPLAYFLAGS);_X_FIELD(DM,DISPLAYFREQUENCY);_X_FIELD(DM,POSITION);
228     *p = 0;
229     return wine_dbg_sprintf("%s", buf);
230 }
231 #undef _X_FIELD
232
233 /***********************************************************************
234  *              ChangeDisplaySettingsEx  (X11DRV.@)
235  *
236  */
237 LONG X11DRV_ChangeDisplaySettingsEx( LPCWSTR devname, LPDEVMODEW devmode,
238                                      HWND hwnd, DWORD flags, LPVOID lpvoid )
239 {
240     DWORD i, dwBpp = 0;
241     DEVMODEW dm;
242     BOOL def_mode = TRUE;
243
244     TRACE("(%s,%p,%p,0x%08x,%p)\n",debugstr_w(devname),devmode,hwnd,flags,lpvoid);
245     TRACE("flags=%s\n",_CDS_flags(flags));
246     if (devmode)
247     {
248         TRACE("DM_fields=%s\n",_DM_fields(devmode->dmFields));
249         TRACE("width=%d height=%d bpp=%d freq=%d (%s)\n",
250               devmode->dmPelsWidth,devmode->dmPelsHeight,
251               devmode->dmBitsPerPel,devmode->dmDisplayFrequency, handler_name);
252
253         dwBpp = (devmode->dmBitsPerPel == 24) ? 32 : devmode->dmBitsPerPel;
254         if (devmode->dmFields & DM_BITSPERPEL) def_mode &= !dwBpp;
255         if (devmode->dmFields & DM_PELSWIDTH)  def_mode &= !devmode->dmPelsWidth;
256         if (devmode->dmFields & DM_PELSHEIGHT) def_mode &= !devmode->dmPelsHeight;
257         if (devmode->dmFields & DM_DISPLAYFREQUENCY) def_mode &= !devmode->dmDisplayFrequency;
258     }
259
260     if (def_mode)
261     {
262         TRACE("Return to original display mode (%s)\n", handler_name);
263         if (!X11DRV_EnumDisplaySettingsEx(devname, dd_mode_default, &dm, 0))
264         {
265             ERR("Default mode not found!\n");
266             return DISP_CHANGE_BADMODE;
267         }
268         devmode = &dm;
269     }
270     dwBpp = !dwBpp ? dd_modes[dd_mode_default].dwBPP : dwBpp;
271
272     if ((devmode->dmFields & (DM_PELSWIDTH | DM_PELSHEIGHT)) != (DM_PELSWIDTH | DM_PELSHEIGHT))
273         return DISP_CHANGE_BADMODE;
274
275     for (i = 0; i < dd_mode_count; i++)
276     {
277         if (devmode->dmFields & DM_BITSPERPEL)
278         {
279             if (dwBpp != dd_modes[i].dwBPP)
280                 continue;
281         }
282         if (devmode->dmFields & DM_PELSWIDTH)
283         {
284             if (devmode->dmPelsWidth != dd_modes[i].dwWidth)
285                 continue;
286         }
287         if (devmode->dmFields & DM_PELSHEIGHT)
288         {
289             if (devmode->dmPelsHeight != dd_modes[i].dwHeight)
290                 continue;
291         }
292         if ((devmode->dmFields & DM_DISPLAYFREQUENCY) && (dd_modes[i].wRefreshRate != 0) &&
293             devmode->dmDisplayFrequency != 0)
294         {
295             if (devmode->dmDisplayFrequency != dd_modes[i].wRefreshRate)
296                 continue;
297         }
298         /* we have a valid mode */
299         TRACE("Requested display settings match mode %d (%s)\n", i, handler_name);
300         if (!(flags & CDS_TEST))
301             return pSetCurrentMode(i);
302         return DISP_CHANGE_SUCCESSFUL;
303     }
304
305     /* no valid modes found */
306     ERR("No matching mode found! (%s)\n", handler_name);
307     return DISP_CHANGE_BADMODE;
308 }
309
310
311
312
313 /***********************************************************************
314  * DirectDraw HAL interface
315  *
316  */
317 static DWORD PASCAL X11DRV_Settings_SetMode(LPDDHAL_SETMODEDATA data)
318 {
319     TRACE("Mode %d requested by DDHAL (%s)\n", data->dwModeIndex, handler_name);
320     switch (pSetCurrentMode(data->dwModeIndex))
321     {
322     case DISP_CHANGE_SUCCESSFUL:
323         X11DRV_DDHAL_SwitchMode(data->dwModeIndex, NULL, NULL);
324         data->ddRVal = DD_OK;
325         break;
326     case DISP_CHANGE_BADMODE:
327         data->ddRVal = DDERR_WRONGMODE;
328         break;
329     default:
330         data->ddRVal = DDERR_UNSUPPORTEDMODE;
331     }
332     return DDHAL_DRIVER_HANDLED;
333 }
334 int X11DRV_Settings_CreateDriver(LPDDHALINFO info)
335 {
336     if (!dd_mode_count) return 0; /* no settings defined */
337
338     TRACE("Setting up display settings for DDRAW (%s)\n", handler_name);
339     info->dwNumModes = dd_mode_count;
340     info->lpModeInfo = dd_modes;
341     X11DRV_DDHAL_SwitchMode(pGetCurrentMode(), NULL, NULL);
342     info->lpDDCallbacks->SetMode = X11DRV_Settings_SetMode;
343     return TRUE;
344 }