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