Don't leak a list of visuals (with advice of Jacek Caban).
[wine] / dlls / x11drv / xvidmode.c
1 /*
2  * DirectDraw XVidMode interface
3  *
4  * Copyright 2001 TransGaming Technologies, Inc.
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22 #include <string.h>
23 #include <stdio.h>
24 #include <math.h>
25
26 #include "x11drv.h"
27
28 #ifdef HAVE_LIBXXF86VM
29 #include <X11/extensions/xf86vmode.h>
30 #endif /* HAVE_LIBXXF86VM */
31
32 #include "x11ddraw.h"
33 #include "xvidmode.h"
34
35 #include "windef.h"
36 #include "wingdi.h"
37 #include "ddrawi.h"
38 #include "wine/debug.h"
39
40 WINE_DEFAULT_DEBUG_CHANNEL(xvidmode);
41
42 #ifdef HAVE_LIBXXF86VM
43
44 extern int usexvidmode;
45
46 static int xf86vm_event, xf86vm_error, xf86vm_major, xf86vm_minor;
47
48 #ifdef X_XF86VidModeSetGammaRamp
49 static int xf86vm_gammaramp_size;
50 static BOOL xf86vm_use_gammaramp;
51 #endif /* X_XF86VidModeSetGammaRamp */
52
53 static LPDDHALMODEINFO dd_modes;
54 static unsigned int dd_mode_count;
55 static XF86VidModeModeInfo** real_xf86vm_modes;
56 static unsigned int real_xf86vm_mode_count;
57
58 static void convert_modeinfo( const XF86VidModeModeInfo *mode)
59 {
60   int rate;
61   if (mode->htotal!=0 && mode->vtotal!=0)
62       rate = mode->dotclock * 1000 / (mode->htotal * mode->vtotal);
63   else
64       rate = 0;
65   X11DRV_Settings_AddOneMode(mode->hdisplay, mode->vdisplay, 0, rate);
66 }
67
68 static void convert_modeline(int dotclock, const XF86VidModeModeLine *mode, LPDDHALMODEINFO info, unsigned int bpp)
69 {
70   info->dwWidth      = mode->hdisplay;
71   info->dwHeight     = mode->vdisplay;
72   if (mode->htotal!=0 && mode->vtotal!=0)
73       info->wRefreshRate = dotclock * 1000 / (mode->htotal * mode->vtotal);
74   else
75       info->wRefreshRate = 0;
76   TRACE(" width=%ld, height=%ld, refresh=%d\n",
77         info->dwWidth, info->dwHeight, info->wRefreshRate);
78   info->lPitch         = 0;
79   info->dwBPP          = bpp;
80   info->wFlags         = 0;
81   info->dwRBitMask     = 0;
82   info->dwGBitMask     = 0;
83   info->dwBBitMask     = 0;
84   info->dwAlphaBitMask = 0;
85 }
86
87 static int XVidModeErrorHandler(Display *dpy, XErrorEvent *event, void *arg)
88 {
89     return 1;
90 }
91
92 int X11DRV_XF86VM_GetCurrentMode(void)
93 {
94   XF86VidModeModeLine line;
95   int dotclock;
96   unsigned int i;
97   DDHALMODEINFO cmode;
98   DWORD dwBpp = screen_depth;
99   if (dwBpp == 24) dwBpp = 32;
100
101   TRACE("Querying XVidMode current mode\n");
102   wine_tsx11_lock();
103   XF86VidModeGetModeLine(gdi_display, DefaultScreen(gdi_display), &dotclock, &line);
104   wine_tsx11_unlock();
105   convert_modeline(dotclock, &line, &cmode, dwBpp);
106   for (i=0; i<dd_mode_count; i++)
107     if (memcmp(&dd_modes[i], &cmode, sizeof(cmode)) == 0) {
108       TRACE("mode=%d\n", i);
109       return i;
110     }
111   ERR("In unknown mode, returning default\n");
112   return 0;
113 }
114
115 void X11DRV_XF86VM_SetCurrentMode(int mode)
116 {
117   DWORD dwBpp = screen_depth;
118   if (dwBpp == 24) dwBpp = 32;
119   /* only set modes from the original color depth */
120   if (dwBpp != dd_modes[mode].dwBPP)
121   {
122       FIXME("Cannot change screen BPP from %ld to %ld\n", dwBpp, dd_modes[mode].dwBPP);
123   }
124   mode = mode % real_xf86vm_mode_count;
125
126   wine_tsx11_lock();
127   TRACE("Resizing X display to %dx%d\n", 
128         real_xf86vm_modes[mode]->hdisplay, real_xf86vm_modes[mode]->vdisplay);
129   XF86VidModeSwitchToMode(gdi_display, DefaultScreen(gdi_display), real_xf86vm_modes[mode]);
130 #if 0 /* it is said that SetViewPort causes problems with some X servers */
131   XF86VidModeSetViewPort(gdi_display, DefaultScreen(gdi_display), 0, 0);
132 #else
133   XWarpPointer(gdi_display, None, DefaultRootWindow(gdi_display), 0, 0, 0, 0, 0, 0);
134 #endif
135   XSync(gdi_display, False);
136   wine_tsx11_unlock();
137   X11DRV_handle_desktop_resize( real_xf86vm_modes[mode]->hdisplay,
138                                 real_xf86vm_modes[mode]->vdisplay );
139 }
140
141 void X11DRV_XF86VM_Init(void)
142 {
143   Bool ok;
144   int nmodes;
145   unsigned int i;
146   DWORD dwBpp = screen_depth;
147   if (dwBpp == 24) dwBpp = 32;
148
149   if (xf86vm_major) return; /* already initialized? */
150
151   if (!usexvidmode) return;
152
153   /* see if XVidMode is available */
154   wine_tsx11_lock();
155   ok = XF86VidModeQueryExtension(gdi_display, &xf86vm_event, &xf86vm_error);
156   if (ok)
157   {
158       X11DRV_expect_error(gdi_display, XVidModeErrorHandler, NULL);
159       ok = XF86VidModeQueryVersion(gdi_display, &xf86vm_major, &xf86vm_minor);
160       if (X11DRV_check_error()) ok = FALSE;
161   }
162   if (ok)
163   {
164 #ifdef X_XF86VidModeSetGammaRamp
165       if (xf86vm_major > 2 || (xf86vm_major == 2 && xf86vm_minor >= 1))
166       {
167           XF86VidModeGetGammaRampSize(gdi_display, DefaultScreen(gdi_display),
168                                       &xf86vm_gammaramp_size);
169           if (xf86vm_gammaramp_size == 256)
170               xf86vm_use_gammaramp = TRUE;
171       }
172 #endif /* X_XF86VidModeSetGammaRamp */
173
174       /* retrieve modes */
175       if (!using_wine_desktop) ok = XF86VidModeGetAllModeLines(gdi_display, DefaultScreen(gdi_display), &nmodes, &real_xf86vm_modes);
176   }
177   wine_tsx11_unlock();
178   if (!ok) return;
179
180   /* In desktop mode, do not switch resolution... But still use the Gamma ramp stuff */
181   if (using_wine_desktop) return;
182   
183   TRACE("XVidMode modes: count=%d\n", nmodes);
184
185   real_xf86vm_mode_count = nmodes;
186
187   dd_modes = X11DRV_Settings_SetHandlers("XF86VidMode", 
188                                          X11DRV_XF86VM_GetCurrentMode, 
189                                          X11DRV_XF86VM_SetCurrentMode, 
190                                          nmodes, 1);
191
192   /* convert modes to DDHALMODEINFO format */
193   for (i=0; i<real_xf86vm_mode_count; i++)
194   {
195       convert_modeinfo(real_xf86vm_modes[i]);
196   }
197   /* add modes for different color depths */
198   X11DRV_Settings_AddDepthModes();
199   dd_mode_count = X11DRV_Settings_GetModeCount();
200
201   TRACE("Available DD modes: count=%d\n", dd_mode_count);
202
203   /* the first mode in the list seems to be the default */
204   X11DRV_Settings_SetDefaultMode(0);
205   
206   TRACE("Enabling XVidMode\n");
207 }
208
209 void X11DRV_XF86VM_Cleanup(void)
210 {
211   wine_tsx11_lock();
212   if (real_xf86vm_modes) XFree(real_xf86vm_modes);
213   wine_tsx11_unlock();
214 }
215
216 void X11DRV_XF86VM_SetExclusiveMode(int lock)
217 {
218   if (!dd_modes) return; /* no XVidMode */
219
220   wine_tsx11_lock();
221   XF86VidModeLockModeSwitch(gdi_display, DefaultScreen(gdi_display), lock);
222   wine_tsx11_unlock();
223 }
224
225 /***** GAMMA CONTROL *****/
226 /* (only available in XF86VidMode 2.x) */
227
228 #ifdef X_XF86VidModeSetGamma
229
230 static void GenerateRampFromGamma(WORD ramp[256], float gamma)
231 {
232   float r_gamma = 1/gamma;
233   unsigned i;
234   TRACE("gamma is %f\n", r_gamma);
235   for (i=0; i<256; i++)
236     ramp[i] = pow(i/255.0, r_gamma) * 65535.0;
237 }
238
239 static BOOL ComputeGammaFromRamp(WORD ramp[256], float *gamma)
240 {
241   float r_x, r_y, r_lx, r_ly, r_d, r_v, r_e, g_avg, g_min, g_max;
242   unsigned i, f, l, g_n, c;
243   f = ramp[0];
244   l = ramp[255];
245   if (f >= l) {
246     ERR("inverted or flat gamma ramp (%d->%d), rejected\n", f, l);
247     return FALSE;
248   }
249   r_d = l - f;
250   g_min = g_max = g_avg = 0.0;
251   /* check gamma ramp entries to estimate the gamma */
252   TRACE("analyzing gamma ramp (%d->%d)\n", f, l);
253   for (i=1, g_n=0; i<255; i++) {
254     if (ramp[i] < f || ramp[i] > l) {
255       ERR("strange gamma ramp ([%d]=%d for %d->%d), rejected\n", i, ramp[i], f, l);
256       return FALSE;
257     }
258     c = ramp[i] - f;
259     if (!c) continue; /* avoid log(0) */
260
261     /* normalize entry values into 0..1 range */
262     r_x = i/255.0; r_y = c / r_d;
263     /* compute logarithms of values */
264     r_lx = log(r_x); r_ly = log(r_y);
265     /* compute gamma for this entry */
266     r_v = r_ly / r_lx;
267     /* compute differential (error estimate) for this entry */
268     /* some games use table-based logarithms that magnifies the error by 128 */
269     r_e = -r_lx * 128 / (c * r_lx * r_lx);
270
271     /* compute min & max while compensating for estimated error */
272     if (!g_n || g_min > (r_v + r_e)) g_min = r_v + r_e;
273     if (!g_n || g_max < (r_v - r_e)) g_max = r_v - r_e;
274
275     /* add to average */
276     g_avg += r_v;
277     g_n++;
278     /* TRACE("[%d]=%d, gamma=%f, error=%f\n", i, ramp[i], r_v, r_e); */
279   }
280   if (!g_n) {
281     ERR("no gamma data, shouldn't happen\n");
282     return FALSE;
283   }
284   g_avg /= g_n;
285   TRACE("low bias is %d, high is %d, gamma is %5.3f\n", f, 65535-l, g_avg);
286   /* the bias could be because the app wanted something like a "red shift"
287    * like when you're hit in Quake, but XVidMode doesn't support it,
288    * so we have to reject a significant bias */
289   if (f && f > (pow(1/255.0, g_avg) * 65536.0)) {
290     ERR("low-biased gamma ramp (%d), rejected\n", f);
291     return FALSE;
292   }
293   /* check that the gamma is reasonably uniform across the ramp */
294   if (g_max - g_min > 0.1) {
295     ERR("ramp not uniform (max=%f, min=%f, avg=%f), rejected\n", g_max, g_min, g_avg);
296     return FALSE;
297   }
298   /* ok, now we're pretty sure we can set the desired gamma ramp,
299    * so go for it */
300   *gamma = 1/g_avg;
301   return TRUE;
302 }
303
304 #endif /* X_XF86VidModeSetGamma */
305
306 /* Hmm... should gamma control be available in desktop mode or not?
307  * I'll assume that it should */
308
309 BOOL X11DRV_XF86VM_GetGammaRamp(LPDDGAMMARAMP ramp)
310 {
311 #ifdef X_XF86VidModeSetGamma
312   XF86VidModeGamma gamma;
313   Bool ret;
314
315   if (xf86vm_major < 2) return FALSE; /* no gamma control */
316 #ifdef X_XF86VidModeSetGammaRamp
317   else if (xf86vm_use_gammaramp)
318   {
319       Bool ret;
320       wine_tsx11_lock();
321       ret = XF86VidModeGetGammaRamp(gdi_display, DefaultScreen(gdi_display), 256,
322                                     ramp->red, ramp->green, ramp->blue);
323       wine_tsx11_unlock();
324       return ret;
325   }
326 #endif
327   else
328   {
329       wine_tsx11_lock();
330       ret = XF86VidModeGetGamma(gdi_display, DefaultScreen(gdi_display), &gamma);
331       wine_tsx11_unlock();
332       if (ret) {
333           GenerateRampFromGamma(ramp->red,   gamma.red);
334           GenerateRampFromGamma(ramp->green, gamma.green);
335           GenerateRampFromGamma(ramp->blue,  gamma.blue);
336           return TRUE;
337       }
338   }
339 #endif /* X_XF86VidModeSetGamma */
340   return FALSE;
341 }
342
343 BOOL X11DRV_XF86VM_SetGammaRamp(LPDDGAMMARAMP ramp)
344 {
345 #ifdef X_XF86VidModeSetGamma
346   XF86VidModeGamma gamma;
347
348   if (xf86vm_major < 2) return FALSE; /* no gamma control */
349 #ifdef X_XF86VidModeSetGammaRamp
350   else if (xf86vm_use_gammaramp)
351   {
352       Bool ret;
353       wine_tsx11_lock();
354       ret = XF86VidModeSetGammaRamp(gdi_display, DefaultScreen(gdi_display), 256,
355                                     ramp->red, ramp->green, ramp->blue);
356       wine_tsx11_unlock();
357       return ret;
358   }
359 #endif
360   else
361   {
362       if (ComputeGammaFromRamp(ramp->red,   &gamma.red) &&
363           ComputeGammaFromRamp(ramp->green, &gamma.green) &&
364           ComputeGammaFromRamp(ramp->blue,  &gamma.blue)) {
365           Bool ret;
366           wine_tsx11_lock();
367           ret = XF86VidModeSetGamma(gdi_display, DefaultScreen(gdi_display), &gamma);
368           wine_tsx11_unlock();
369           return ret;
370       }
371   }
372 #endif /* X_XF86VidModeSetGamma */
373   return FALSE;
374 }
375
376 #endif /* HAVE_LIBXXF86VM */
377
378 /***********************************************************************
379  *              GetDeviceGammaRamp (X11DRV.@)
380  *
381  * FIXME: should move to somewhere appropriate, but probably not before
382  * the stuff in graphics/x11drv/ has been moved to dlls/x11drv, so that
383  * they can include xvidmode.h directly
384  */
385 BOOL X11DRV_GetDeviceGammaRamp(X11DRV_PDEVICE *physDev, LPVOID ramp)
386 {
387 #ifdef HAVE_LIBXXF86VM
388   return X11DRV_XF86VM_GetGammaRamp(ramp);
389 #else
390   return FALSE;
391 #endif
392 }
393
394 /***********************************************************************
395  *              SetDeviceGammaRamp (X11DRV.@)
396  *
397  * FIXME: should move to somewhere appropriate, but probably not before
398  * the stuff in graphics/x11drv/ has been moved to dlls/x11drv, so that
399  * they can include xvidmode.h directly
400  */
401 BOOL X11DRV_SetDeviceGammaRamp(X11DRV_PDEVICE *physDev, LPVOID ramp)
402 {
403 #ifdef HAVE_LIBXXF86VM
404   return X11DRV_XF86VM_SetGammaRamp(ramp);
405 #else
406   return FALSE;
407 #endif
408 }