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