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