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