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